PdfBookmarkEntry

PdfBookmarkEntry class

PdfBookmarkEntry is an entry in pdf bookmark. if Text property of current instance is null or “”, current instance will be hidden and children will be inserted on current level.

class PdfBookmarkEntry;

Constructors

Name	Description
constructor()	Default Constructor.

Methods

Method	Description
getText()	Title of a bookmark.
setText(string)	Title of a bookmark.
getDestination()	The cell to which the bookmark link.
setDestination(Cell)	The cell to which the bookmark link.
getDestinationName()	Gets or sets name of destination.
setDestinationName(string)	Gets or sets name of destination.
isOpen()	When this property is true, the bookmarkentry will expand, otherwise it will collapse.
setIsOpen(boolean)	When this property is true, the bookmarkentry will expand, otherwise it will collapse.
isCollapse()	When this property is true, the bookmarkentry will collapse, otherwise it will expand.
setIsCollapse(boolean)	When this property is true, the bookmarkentry will collapse, otherwise it will expand.
isNull()	Checks whether the implementation object is null.

constructor()

Default Constructor.

constructor();

getText()

Title of a bookmark.

getText() : string;

setText(string)

Title of a bookmark.

setText(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

getDestination()

The cell to which the bookmark link.

getDestination() : Cell;

Returns

Cell

setDestination(Cell)

The cell to which the bookmark link.

setDestination(value: Cell) : void;

Parameters:

Parameter	Type	Description
value	Cell	The value to set.

getDestinationName()

Gets or sets name of destination.

getDestinationName() : string;

Remarks

If destination name is set, the destination will be defined as a named destination with this name.

setDestinationName(string)

Gets or sets name of destination.

setDestinationName(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

Remarks

If destination name is set, the destination will be defined as a named destination with this name.

isOpen()

When this property is true, the bookmarkentry will expand, otherwise it will collapse.

isOpen() : boolean;

setIsOpen(boolean)

When this property is true, the bookmarkentry will expand, otherwise it will collapse.

setIsOpen(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

isCollapse()

When this property is true, the bookmarkentry will collapse, otherwise it will expand.

isCollapse() : boolean;

setIsCollapse(boolean)

When this property is true, the bookmarkentry will collapse, otherwise it will expand.

setIsCollapse(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

isNull()

Checks whether the implementation object is null.

isNull() : boolean;