Class BookmarkItem

Represents a PDF bookmark (outline) item.

Inheritance
System.Object
FixedDocumentElementBase
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()
Namespace: Telerik.Windows.Documents.Fixed.Model.Navigation
Assembly: Telerik.Windows.Documents.Fixed.dll

Syntax

public class BookmarkItem : FixedDocumentElementBase, IFixedDocumentElement, IContextClonable<BookmarkItem>

Constructors

BookmarkItem(String, Action)

Initializes a new instance of the BookmarkItem class.

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.

BookmarkItem(String, Destination)

Initializes a new instance of the BookmarkItem class.

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.

BookmarkItem(String, NamedDestination)

Initializes a new instance of the BookmarkItem class.

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

Action

Gets the action to be performed when this bookmark item is activated.

Declaration
[Obsolete("Use Actions instead.")]
public Action Action { get; }
Property Value
Action

Actions

Gets the actions for the bookmark item.

Declaration
public ActionCollection Actions { get; }
Property Value
ActionCollection

The actions.

Children

Gets the immediate child elements for this bookmark item.

Declaration
public BookmarksCollection Children { get; }
Property Value
BookmarksCollection

Destination

Gets the destination to be displayed when this bookmark item is activated.

Declaration
public Destination Destination { get; }
Property Value
Destination

IsExpanded

Gets or sets whether the bookmark item is open or closed by default. For example, when an item is open by default, its children are initially visible when document is loaded.

Declaration
public bool IsExpanded { get; set; }
Property Value
System.Boolean

NamedDestination

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

Declaration
public NamedDestination NamedDestination { get; }
Property Value
NamedDestination

TextColor

Gets or sets the color of the bookmark item's text in RGB color space.

Declaration
public RgbColor TextColor { get; set; }
Property Value
RgbColor

Exceptions
System.ArgumentNullException

Thrown when the value is null.

TextStyle

Gets or sets the style characteristics for displaying the bookmark item's text.

Declaration
public BookmarkItemStyles TextStyle { get; set; }
Property Value
BookmarkItemStyles

Title

Gets or sets the text to be displayed for this bookmark item.

Declaration
public string Title { get; set; }
Property Value
System.String

Exceptions
System.ArgumentNullException

Thrown when the value is null.