Class OutlineIter

GXPSOutlineIter represents an iterator that can be used to iterate over the items of an outline contained in a #GXPSDocumentStructure

record

Hierarchy

OutlineIter

Index

Constructors

constructor

Properties

name

Methods

Constructors

constructor

new OutlineIter(): GXPS.OutlineIter

Returns GXPS.OutlineIter

Properties

Static name

name: string

Methods

children

children(parent: GXPS.OutlineIter): boolean

- Defined in GXPS-0.1.d.ts:722
Initializes iter to the first child item of parent. See gxps_document_structure_outline_iter_init() for more details.

Parameters
- parent: GXPS.OutlineIter
  
  an initialized #GXPSOutlineIter
Returns boolean

getDescription

getDescription(): string

- Defined in GXPS-0.1.d.ts:728
Gets the description of the outline item associated with iter. See gxps_document_structure_outline_iter_init() for more details.

Returns string

getTarget

getTarget(): GXPS.LinkTarget

- Defined in GXPS-0.1.d.ts:734
Gets the #GXPSLinkTarget of the outline item associated with iter. See gxps_document_structure_outline_iter_init() for more details.

Returns GXPS.LinkTarget

next

next(): boolean

- Defined in GXPS-0.1.d.ts:740
Advances iter to the next item at the current level. See gxps_document_structure_outline_iter_init() for more details.

Returns boolean