ClassBookmarkItem
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:
public class BookmarkItem : FixedDocumentElementBase, IFixedDocumentElementInheritance: objectFixedDocumentElementBaseBookmarkItem
Implements:
Inherited Members
Constructors
BookmarkItem(string, Action)
Create a new BookmarkItem that executes the provided action (and subsequent actions in the collection) when activated.
Declaration
public BookmarkItem(string title, Action action)Parameters
title
The text to be displayed for this bookmark item.
action
The action first action in a collection of actions to be performed when this bookmark item is activated.
Exceptions
Thrown when the title or action is null.
BookmarkItem(string, Destination)
Create a new BookmarkItem that navigates to the specified destination when activated.
Declaration
public BookmarkItem(string title, Destination destination)Parameters
title
The text to be displayed for this bookmark item.
destination
The destination to be displayed when this bookmark item is activated.
Exceptions
Thrown when the title or destination is null.
BookmarkItem(string, NamedDestination)
Create a new BookmarkItem that targets the specified named destination for indirect navigation.
Declaration
public BookmarkItem(string title, NamedDestination namedDestination)Parameters
title
The text to be displayed for this bookmark item.
namedDestination
The named destination to be displayed when this bookmark item is activated.
Exceptions
Thrown when the title or namedDestination is null.
Properties
Actions
Gets the ordered collection of actions executed when the bookmark is activated.
Declaration
public ActionCollection Actions { get; }Property Value
The actions.
Children
Gets the collection of direct child bookmarks forming this node's subtree.
Declaration
public BookmarksCollection Children { get; }Property Value
Destination
Gets the destination shown in the viewer when the bookmark is activated.
IsExpanded
Gets or sets whether this bookmark's child items are initially expanded when the document loads, controlling outline visibility.
NamedDestination
Gets the named destination this bookmark resolves to for indirection across the document.
Declaration
public NamedDestination NamedDestination { get; }Property Value
TextColor
Gets or sets the bookmark text color (RGB), influencing outline appearance.
Declaration
public RgbColor TextColor { get; set; }Property Value
Exceptions
Thrown when the value is null.
TextStyle
Gets or sets the visual style flags (bold / italic) applied to the bookmark text.
Declaration
public BookmarkItemStyles TextStyle { get; set; }Property Value
Title
Gets or sets the display text shown for the bookmark in the outline panel.
Declaration
public string Title { get; set; }Property Value
Exceptions
Thrown when the value is null.