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

Constructor	Description
constructor()	Default Constructor.

Properties

Property	Type	Description
text	string	Title of a bookmark.
destination	Cell	The cell to which the bookmark link.
destinationName	string	Gets or sets name of destination.
isOpen	boolean	When this property is true, the bookmarkentry will expand, otherwise it will collapse.
isCollapse	boolean	When this property is true, the bookmarkentry will collapse, otherwise it will expand.

Methods

Method	Description
getText()	@deprecated. Please use the ’text’ property instead. Title of a bookmark.
setText(string)	@deprecated. Please use the ’text’ property instead. Title of a bookmark.
getDestination()	@deprecated. Please use the ‘destination’ property instead. The cell to which the bookmark link.
setDestination(Cell)	@deprecated. Please use the ‘destination’ property instead. The cell to which the bookmark link.
getDestinationName()	@deprecated. Please use the ‘destinationName’ property instead. Gets or sets name of destination.
setDestinationName(string)	@deprecated. Please use the ‘destinationName’ property instead. Gets or sets name of destination.
isOpen()	@deprecated. Please use the ‘isOpen’ property instead. When this property is true, the bookmarkentry will expand, otherwise it will collapse.
setIsOpen(boolean)	@deprecated. Please use the ‘isOpen’ property instead. When this property is true, the bookmarkentry will expand, otherwise it will collapse.
isCollapse()	@deprecated. Please use the ‘isCollapse’ property instead. When this property is true, the bookmarkentry will collapse, otherwise it will expand.
setIsCollapse(boolean)	@deprecated. Please use the ‘isCollapse’ property instead. 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();

text

Title of a bookmark.

text : string;

destination

The cell to which the bookmark link.

destination : Cell;

destinationName

Gets or sets name of destination.

destinationName : string;

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;

isCollapse

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

isCollapse : boolean;

getText()

@deprecated. Please use the ’text’ property instead. Title of a bookmark.

getText() : string;

setText(string)

@deprecated. Please use the ’text’ property instead. Title of a bookmark.

setText(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

getDestination()

@deprecated. Please use the ‘destination’ property instead. The cell to which the bookmark link.

getDestination() : Cell;

Returns

Cell

setDestination(Cell)

@deprecated. Please use the ‘destination’ property instead. The cell to which the bookmark link.

setDestination(value: Cell) : void;

Parameters:

Parameter	Type	Description
value	Cell	The value to set.

getDestinationName()

@deprecated. Please use the ‘destinationName’ property instead. 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)

@deprecated. Please use the ‘destinationName’ property instead. 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()

@deprecated. Please use the ‘isOpen’ property instead. When this property is true, the bookmarkentry will expand, otherwise it will collapse.

isOpen() : boolean;

setIsOpen(boolean)

@deprecated. Please use the ‘isOpen’ property instead. 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()

@deprecated. Please use the ‘isCollapse’ property instead. When this property is true, the bookmarkentry will collapse, otherwise it will expand.

isCollapse() : boolean;

setIsCollapse(boolean)

@deprecated. Please use the ‘isCollapse’ property instead. 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;