PageLabel Class

class PageLabel : SystemIDisposable

Namespace:Datalogics::PDFL

Inherits from:: SystemIDisposable

Detailed Description

Describes numbering labels for a range of pages.

PageLabel describes how to construct a label string for a range of pages. It contains information on number style, any prefixes, and a starting position within the document.

Note that a single PageLabel describes the label string for several pages all pages up until the first page covered by the next PageLabel, or the end of the document.

Also note that if a Document has any PageLabels, there must be one that starts at page index 0. This will be automatically created if the user does not supply one.

Referenced by

Document PageLabel

Uses types

NumberStyle PageLabel

Constructor & Destructor Documentation

PageLabel(int start, NumberStyle ns)

Parameters

start: int: Starting page index in the Document for this range
ns: NumberStyle: Numbering style for this range

Convenience constructor creates a range with no prefix starting with number 1.

PageLabel(int start, NumberStyle ns, string p, int first)

Parameters

start: int: Starting page index in the Document for this range
ns: NumberStyle: Numbering style for this range
p: string: Prefix string for this range
first: int: First number appearing on a page in this range

Public constructor

Property Documentation

int EndPageIndex[get]

int FirstNumberInRange[get, set]

NumberStyle NumberStyle[get, set]

string Prefix[get, set]

int StartPageIndex[get, set]

Member Function Documentation

void Dispose()

Returns:

void

override string ToString()

Returns:

override string

A string describing this PageLabel.

Returns a string representation of this PageLabel.

The string includes the start page, end page, number style, prefix, and first page number of this label range.