Class BookmarkItem
Bookmark node in the PDF outline that triggers a destination or action and structures hierarchical navigation.
Inheritance
System.Object
BookmarkItem
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Assembly: Telerik.Windows.Documents.Fixed.dll
Syntax
public class BookmarkItem : FixedDocumentElementBase, IFixedDocumentElement, IContextClonable<BookmarkItem>
Constructors
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
|
System.String
title
The text to be displayed for this bookmark item.
|
|
Action
action
The action first action in a collection of actions to be performed when this bookmark item is activated.
|
Exceptions
|
System.ArgumentNullException
Thrown when the title or action is null.
|
Create a new BookmarkItem that navigates to the specified destination when activated.
Declaration
public BookmarkItem(string title, Destination destination)
Parameters
|
System.String
title
The text to be displayed for this bookmark item.
|
|
Destination
destination
The destination to be displayed when this bookmark item is activated.
|
Exceptions
|
System.ArgumentNullException
Thrown when the title or destination is null.
|
Create a new BookmarkItem that targets the specified named destination for indirect navigation.
Declaration
public BookmarkItem(string title, NamedDestination namedDestination)
Parameters
|
System.String
title
The text to be displayed for this bookmark item.
|
|
NamedDestination
namedDestination
The named destination to be displayed when this bookmark item is activated.
|
Exceptions
|
System.ArgumentNullException
Thrown when the title or namedDestination is null.
|
Properties
Gets the (obsolete) single action invoked when the bookmark is activated.
Declaration
[Obsolete("Use Actions instead.")]
public Action Action { get; }
Property Value
Gets the ordered collection of actions executed when the bookmark is activated.
Declaration
public ActionCollection Actions { get; }
Property Value
Gets the collection of direct child bookmarks forming this node's subtree.
Declaration
public BookmarksCollection Children { get; }
Property Value
Gets the destination shown in the viewer when the bookmark is activated.
Declaration
public Destination Destination { get; }
Property Value
Gets or sets whether this bookmark's child items are initially expanded when the document loads, controlling outline visibility.
Declaration
public bool IsExpanded { get; set; }
Property Value
Gets the named destination this bookmark resolves to for indirection across the document.
Declaration
public NamedDestination NamedDestination { get; }
Property Value
Gets or sets the bookmark text color (RGB), influencing outline appearance.
Declaration
public RgbColor TextColor { get; set; }
Property Value
Exceptions
|
System.ArgumentNullException
Thrown when the value is null.
|
Gets or sets the visual style flags (bold / italic) applied to the bookmark text.
Declaration
public BookmarkItemStyles TextStyle { get; set; }
Property Value
Gets or sets the display text shown for the bookmark in the outline panel.
Declaration
public string Title { get; set; }
Property Value
Exceptions
|
System.ArgumentNullException
Thrown when the value is null.
|