1. Home
  2. API
  3. Broadside
  4. PdfPageLabels
  5. Methods
  6. SetRange(Int32, PdfPageLabelStyle, String?, Int32)

SetRange(Int32, PdfPageLabelStyle, String?, Int32) Method

Definition

Namespace Broadside
Assembly Broadside.dll
View source

Labels the pages from startPageIndex to the next range: sets or replaces the range starting there.

public PdfPageLabelRange SetRange(int startPageIndex, PdfPageLabelStyle style, string? prefix = null, int firstNumber = 1)

Parameters

startPageIndex
Int32

The index of the range's first page, from 0. It need not be a page of the document yet.

style
PdfPageLabelStyle

How the numeric portion is written; None for the prefix alone.

prefix
String

The text before the numeric portion, or null for none.

firstNumber
Int32

The number of the range's first page, 1 or more.

Returns

PdfPageLabelRange
The range as written.

Remarks

ISO 32000-2 §12.4.2, Table 161 (PDF 1.3), and §7.9.7: a page label dictionary holding only S, P and St where they differ from the defaults, stored in the number tree under startPageIndex with the tree's Limits kept correct. A mutation: no read may run concurrently with it.