Skip to content

# PDFPageLabelingRange

Namespace: O2S.Components.PDF4NET

Defines a labeling range for PDF pages.

    public class PDFPageLabelingRange

Inheritance Object → PDFPageLabelingRange

Remarks

a document can be divided into labeling ranges, each of which is a series of consecutive pages using the same numbering system. Pages within a range are numbered sequentially in ascending order. A page's label consists of a numeric portion based on its position within its labeling range, optionally preceded by a label prefix denoting the range itself.

## Constructors

### PDFPageLabelingRange()

Initializes a new PDFPageLabelingRange object.

    public PDFPageLabelingRange()

## Properties

### DocumentPageNumber

Gets or sets the page number in the document where the labeling range starts.

    public int DocumentPageNumber { get; set; }

Property Value

Int32
An index in the document's PDFFixedDocument.Pages collection.

### LabelPageNumber

Gets or sets the label page number.

    public int LabelPageNumber { get; set; }

Property Value

Int32
The value of the numeric portion for the first page label in the range.

Remarks

Subsequent pages are numbered sequentially from this value, which must be greater than or equal to 1.

### PageLabelNumberStyle

Gets or sets the numbering style.

    public PDFPageLabelNumberStyle PageLabelNumberStyle { get; set; }

Property Value

PDFPageLabelNumberStyle
A PDFPageLabelNumberStyle that represents the numbering style to be used for the numeric portion of each page label.

### Prefix

Gets or sets the prefix.

    public string Prefix { get; set; }

Property Value

String
The label prefix for page labels in this range.