[]
产品首页 在线Demo 产品文档 API 参考 技术社区
立即试用
(Showing Draft Content)

GrapeCity.Documents.Pdf.PageLabelingRange

Class PageLabelingRange

Namespace
GrapeCity.Documents.Pdf
Assembly
GcDocs.Pdf.dll

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. 

public class PageLabelingRange : PdfDictWrapper, IPdfDict
Inheritance
object
PageLabelingRange
Implements
Inherited Members
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
Extension Methods

Constructors

PageLabelingRange()

Initializes a new instance of the PageLabelingRange class.

public PageLabelingRange()

PageLabelingRange(string, NumberingStyle, int)

Initializes a new instance of the PageLabelingRange class.

public PageLabelingRange(string prefix, NumberingStyle numberingStyle, int startPageNumber)

Parameters

prefix string
numberingStyle NumberingStyle
startPageNumber int

Properties

FirstPageIndexInDocument

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

public int FirstPageIndexInDocument { get; }

Property Value

int

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.

public NumberingStyle NumberingStyle { get; set; }

Property Value

NumberingStyle

Prefix

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

public string Prefix { get; set; }

Property Value

string

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.

public int StartPageNumber { get; set; }

Property Value

int

Methods

GetPageLabel(int)

Returns the label for a page with a specified index.

public string GetPageLabel(int pageDocumentIndex)

Parameters

pageDocumentIndex int

The page index in a document.

Returns

string

The page label.