[]
        
(Showing Draft Content)

GrapeCity.Documents.Pdf.PageLabelingRange

PageLabelingRange Class

Represents a page labeling range.

A document is divided into labeling ranges, each of which is a series of consecutive pages using the same numbering system. Labeling ranges shall not overlap, so that each page shall have only one label. Pages within a range shall be 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.

Inheritance
PageLabelingRange
Implements
Namespace: GrapeCity.Documents.Pdf
Assembly: DS.Documents.Pdf.dll
Syntax
public class PageLabelingRange : PdfDictWrapper, IPdfDict
Public Class PageLabelingRange
    Inherits PdfDictWrapper
    Implements IPdfDict

Constructors

Name Description
PageLabelingRange()

Initializes a new instance of the PageLabelingRange class.

PageLabelingRange(string, NumberingStyle, int)

Initializes a new instance of the PageLabelingRange class.

Properties

Name Description
FirstPageIndexInDocument

Gets the index of the page from which this PageLabelingRange starts.

NumberingStyle

Gets or sets the numbering style that shall be used for the numeric portion of each page label. There is no default numbering style; if NumberingStyle is Unset, page labels shall consist solely of a label prefix with no numeric portion.

Prefix

Gets or sets the label prefix for page labels in this range.

StartPageNumber

Gets or sets the value of the numeric portion for the first page label in the range. Subsequent pages shall be numbered sequentially from this value, which shall be greater than or equal to 1. Default value: 1.

Methods

Name Description
GetPageLabel(int)

Returns the label for a page with a specified index.

Extension Methods