OutlineNode

Class: OutlineNode

Defines the outline node within PDF document.

Extends

ObjectBase

Constructors

Constructor

new OutlineNode(
   om, 
   title?, 
   action?, 
   expanded?): OutlineNode;

Initialize a new instance of the OutlineNode class.

Parameters

om

ObjectManager

ObjectManager that controls the lifetime of the OutlineNode.

title?

string

The title of OutlineNode.

action?

| DestinationProperties | ActionProperties | DestinationBase | ActionBase

The action which should be performed or destination defining the new document view.

expanded?

boolean

Indicates whether the node should be expanded.

Returns

OutlineNode

Overrides

ObjectBase.constructor

Constructor

new OutlineNode(
   title?, 
   action?, 
   expanded?): OutlineNode;

Initialize a new instance of the OutlineNode class.

Parameters

title?

string

The title of OutlineNode.

action?

| DestinationProperties | ActionProperties | DestinationBase | ActionBase

The action which should be performed or destination defining the new document view.

expanded?

boolean

Indicates whether the node should be expanded.

Returns

OutlineNode

Overrides

ObjectBase.constructor

Accessors

action

Get Signature

get action(): ActionBase;

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

Set Signature

set action(value): void;

Parameters

value

| ActionProperties | ActionBase

Returns

void

children

Get Signature

get children(): OutlineNodeCollection;

Gets the OutlineNodeCollection collection containing child nodes.

Returns

OutlineNodeCollection

dest

Get Signature

get dest(): DestinationBase;

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

Set Signature

set dest(value): void;

Parameters

value

| DestinationProperties | DestinationBase

Returns

void

doc

Get Signature

get doc(): PdfDocument;

Gets the PdfDocument owning this object.

Returns

PdfDocument

expanded

Get Signature

get expanded(): boolean;

Gets or sets a value indicating whether this OutlineNode expanded and its child nodes are visible.

Returns

boolean

Set Signature

set expanded(value): void;

Gets or sets a value indicating whether this OutlineNode expanded and its child nodes are visible.

Parameters

value

boolean

Returns

void

hasChildren

Get Signature

get hasChildren(): boolean;

Gets a value indicating whether children collection is not empty.

Returns

boolean

id

Get Signature

get id(): number;

Gets the reference to the object.

Returns

number

Inherited from

ObjectBase.id

om

Get Signature

get om(): ObjectManager;

Gets the owner ObjectManager instance.

Returns

ObjectManager

Inherited from

ObjectBase.om

owner

Get Signature

get owner(): OutlineNodeCollection;

Gets the OutlineNodeCollection collection containing this object.

Returns

OutlineNodeCollection

parent

Get Signature

get parent(): OutlineNode;

Gets the parent OutlineNode.

Returns

OutlineNode

textColor

Get Signature

get textColor(): Color;

Gets or sets the text color of the outline node.

Returns

Color

Set Signature

set textColor(value): void;

Gets or sets the text color of the outline node.

Parameters

value

Color

Returns

void

textStyle

Get Signature

get textStyle(): OutlineNodeFontStyle;

Gets or sets the text style of the outline node.

Returns

OutlineNodeFontStyle

Set Signature

set textStyle(value): void;

Gets or sets the text style of the outline node.

Parameters

value

OutlineNodeFontStyle

Returns

void

title

Get Signature

get title(): string;

Gets or sets the title of the outline node.

Returns

string

Set Signature

set title(value): void;

Gets or sets the title of the outline node.

Parameters

value

string

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): 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