Class: PageLabelingRange

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, and 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.

Extends

• ObjectBase

Constructors

Constructor

new PageLabelingRange(om): PageLabelingRange;

Creates a new PageLabelingRange object.

Parameters

om

ObjectManager

An object manager that controls the lifetime of this object.

Returns

PageLabelingRange

Overrides

ObjectBase.constructor

Constructor

new PageLabelingRange(): PageLabelingRange;

Creates a new PageLabelingRange object.

Returns

PageLabelingRange

Overrides

ObjectBase.constructor

Accessors

firstPageIndexInDocument

Get Signature

get firstPageIndexInDocument(): number;

Gets the index of the page (in the document) from which this range starts.

Returns

number

---

id

Get Signature

get id(): number;

Gets the reference to the object.

Returns

number

Inherited from

ObjectBase.id

---

numberingStyle

Get Signature

get numberingStyle(): NumberingStyle;

Gets the numbering style used for the numeric portion of each page label. If set to NumberingStyle.Unset, page labels consist solely of a label prefix with no numeric portion.

Returns

NumberingStyle

Set Signature

set numberingStyle(value): void;

Sets the numbering style used for the numeric portion of each page label.

Parameters

value

NumberingStyle

Returns

void

---

om

Get Signature

get om(): ObjectManager;

Gets the owner ObjectManager instance.

Returns

ObjectManager

Inherited from

ObjectBase.om

---

prefix

Get Signature

get prefix(): string;

Gets the label prefix for page labels in this range.

Returns

string

Set Signature

set prefix(value): void;

Sets the label prefix for page labels in this range.

Parameters

value

string

Returns

void

---

startPageNumber

Get Signature

get startPageNumber(): number;

Gets 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.

Returns

number

Set Signature

set startPageNumber(value): void;

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.

Parameters

value

number

Returns

void

Methods

free()

free(): void;

Detaches the object from the ObjectManager and deallocates its memory, if possible.

Returns

void

Inherited from

ObjectBase.free

---

getPageLabel()

getPageLabel(pageDocumentIndex): string;

Returns the label for a page at the specified document page index.

Parameters

pageDocumentIndex

number

The zero-based page index in the document.

Returns

string

The page label string.

---

rebind()

rebind(omTo): void;

Rebinds the object from the current ObjectManager to the specified one.

Parameters

omTo

ObjectManager

The new ObjectManager for the object.

Returns

void

Inherited from

ObjectBase.rebind