Class OutlineNode

Defines the outline node within PDF document.

Hierarchy (View Summary)

ObjectBase
- OutlineNode

Index

Constructors

constructor

new OutlineNode(
    om: ObjectManager,
    title?: string,
    action?:
        | DestinationProperties
        | ActionProperties
        | ActionBase
        | DestinationBase,
    expanded?: boolean,
): OutlineNode
Initialize a new instance of the OutlineNode class.
Parameters
- om: ObjectManager
  ObjectManager that controls the lifetime of the OutlineNode.
- Optionaltitle: string
  The title of OutlineNode.
- Optionalaction: DestinationProperties | ActionProperties | ActionBase | DestinationBase
  The action which should be performed or destination defining the new document view.
- Optionalexpanded: boolean
  Indicates whether the node should be expanded.
Returns OutlineNode
Overrides ObjectBase.constructor
new OutlineNode(
    title?: string,
    action?:
        | DestinationProperties
        | ActionProperties
        | ActionBase
        | DestinationBase,
    expanded?: boolean,
): OutlineNode
Initialize a new instance of the OutlineNode class.
Parameters
- Optionaltitle: string
  The title of OutlineNode.
- Optionalaction: DestinationProperties | ActionProperties | ActionBase | DestinationBase
  The action which should be performed or destination defining the new document view.
- Optionalexpanded: boolean
  Indicates whether the node should be expanded.
Returns OutlineNode
Overrides ObjectBase.constructor

Accessors

action

get action(): ActionBase | null
Gets or sets the ActionBase to be performed when this OutlineNode is activated. If both 'dest' and 'action' are specified, the viewer application will determine the behavior, which may be unpredictable. For consistent results, specify only one.

Returns ActionBase | null
set action(value: ActionProperties | ActionBase | null): void
Gets or sets the ActionBase to be performed when this OutlineNode is activated. If both 'dest' and 'action' are specified, the viewer application will determine the behavior, which may be unpredictable. For consistent results, specify only one.
Parameters
- value: ActionProperties | ActionBase | null
Returns void

children

get children(): OutlineNodeCollection
Gets the OutlineNodeCollection collection containing child nodes.

Returns OutlineNodeCollection

dest

get dest(): DestinationBase | null
Gets or sets the DestinationBase to be displayed when this OutlineNode is activated. If both 'dest' and 'action' are specified, the viewer application will determine the behavior, which may be unpredictable. For consistent results, specify only one.

Returns DestinationBase | null
set dest(value: DestinationProperties | DestinationBase | null): void
Gets or sets the DestinationBase to be displayed when this OutlineNode is activated. If both 'dest' and 'action' are specified, the viewer application will determine the behavior, which may be unpredictable. For consistent results, specify only one.
Parameters
- value: DestinationProperties | DestinationBase | null
Returns void

doc

get doc(): PdfDocument | null
Gets the PdfDocument owning this object.

Returns PdfDocument | null

expanded

get expanded(): boolean
Gets or sets a value indicating whether this OutlineNode expanded and its child nodes are visible.

Returns boolean
set expanded(value: boolean): void
Gets or sets a value indicating whether this OutlineNode expanded and its child nodes are visible.
Parameters
- value: boolean
Returns void

hasChildren

get hasChildren(): boolean
Gets a value indicating whether children collection is not empty.

Returns boolean

id

get id(): number
Gets the reference to the object.

Returns number
Inherited from ObjectBase.id

om

get om(): ObjectManager
Gets the owner ObjectManager instance.

Returns ObjectManager
Inherited from ObjectBase.om

owner

get owner(): OutlineNodeCollection | null
Gets the OutlineNodeCollection collection containing this object.

Returns OutlineNodeCollection | null

parent

get parent(): OutlineNode | null
Gets the parent OutlineNode.

Returns OutlineNode | null

textColor

get textColor(): Color
Gets or sets the text color of the outline node.

Returns Color
set textColor(value: Color): void
Gets or sets the text color of the outline node.
Parameters
- value: Color
Returns void

textStyle

get textStyle(): OutlineNodeFontStyle
Gets or sets the text style of the outline node.

Returns OutlineNodeFontStyle
set textStyle(value: OutlineNodeFontStyle): void
Gets or sets the text style of the outline node.
Parameters
- value: OutlineNodeFontStyle
Returns void

title

get title(): string | null
Gets or sets the title of the outline node.

Returns string | null
set title(value: string | null): void
Gets or sets the title of the outline node.
Parameters
- value: string | null
Returns void

Methods

free

free(): void
Detaches the object from the ObjectManager and deallocates its memory, if possible.

Returns void
Inherited from ObjectBase.free

rebind

rebind(omTo: ObjectManager): 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

Class OutlineNode

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns OutlineNode

Parameters

Returns OutlineNode

Accessors

action

Returns ActionBase | null

Parameters

Returns void

children

Returns OutlineNodeCollection

dest

Returns DestinationBase | null

Parameters

Returns void

doc

Returns PdfDocument | null

expanded

Returns boolean

Parameters

Returns void

hasChildren

Returns boolean

id

Returns number

om

Returns ObjectManager

owner

Returns OutlineNodeCollection | null

parent

Returns OutlineNode | null

textColor

Returns Color

Parameters

Returns void

textStyle

Returns OutlineNodeFontStyle

Parameters

Returns void

title

Returns string | null

Parameters

Returns void

Methods

free

Returns void

rebind

Parameters

Returns void

Settings

On This Page