New to Telerik Document ProcessingStart a free 30-day trial

Bookmark node in the PDF outline that triggers a destination or action and structures hierarchical navigation.

Definition

Namespace:Telerik.Windows.Documents.Fixed.Model.Navigation

Assembly:Telerik.Windows.Documents.Fixed.dll

Syntax:

C#
public class BookmarkItem : FixedDocumentElementBase, IFixedDocumentElement

Inheritance: objectFixedDocumentElementBaseBookmarkItem

Implements: IFixedDocumentElement

Inherited Members FixedDocumentElementBase.Parent

Constructors

Create a new BookmarkItem that executes the provided action (and subsequent actions in the collection) when activated.

C#
public BookmarkItem(string title, Action action)
Parameters:titlestring

The text to be displayed for this bookmark item.

actionAction

The action first action in a collection of actions to be performed when this bookmark item is activated.

Exceptions:

ArgumentNullException

Thrown when the title or action is null.

Create a new BookmarkItem that navigates to the specified destination when activated.

C#
public BookmarkItem(string title, Destination destination)
Parameters:titlestring

The text to be displayed for this bookmark item.

destinationDestination

The destination to be displayed when this bookmark item is activated.

Exceptions:

ArgumentNullException

Thrown when the title or destination is null.

Create a new BookmarkItem that targets the specified named destination for indirect navigation.

C#
public BookmarkItem(string title, NamedDestination namedDestination)
Parameters:titlestring

The text to be displayed for this bookmark item.

namedDestinationNamedDestination

The named destination to be displayed when this bookmark item is activated.

Exceptions:

ArgumentNullException

Thrown when the title or namedDestination is null.

Properties

Gets the ordered collection of actions executed when the bookmark is activated.

C#
public ActionCollection Actions { get; }
Property Value:

The actions.

Gets the collection of direct child bookmarks forming this node's subtree.

C#
public BookmarksCollection Children { get; }

Gets the destination shown in the viewer when the bookmark is activated.

C#
public Destination Destination { get; }

Gets or sets whether this bookmark's child items are initially expanded when the document loads, controlling outline visibility.

C#
public bool IsExpanded { get; set; }

Gets the named destination this bookmark resolves to for indirection across the document.

C#
public NamedDestination NamedDestination { get; }

Gets or sets the bookmark text color (RGB), influencing outline appearance.

C#
public RgbColor TextColor { get; set; }
Exceptions:

ArgumentNullException

Thrown when the value is null.

Gets or sets the visual style flags (bold / italic) applied to the bookmark text.

C#
public BookmarkItemStyles TextStyle { get; set; }

Gets or sets the display text shown for the bookmark in the outline panel.

C#
public string Title { get; set; }
Exceptions:

ArgumentNullException

Thrown when the value is null.