Table of Contents

Class PdfOutlineItem

Namespace
BitMiracle.Docotic.Pdf
Assembly
BitMiracle.Docotic.Pdf.dll

Class for a PDF outline item (bookmark).

public sealed class PdfOutlineItem
Inheritance
PdfOutlineItem
Inherited Members

Remarks

The PDF bookmarks section describes ways to add outlines to PDF documents.

The Docotic.Pdf Library Documentation page contains links to articles, guides, and sample code.

Properties

Action

Gets or sets the action to be performed when this PdfOutlineItem is activated.

Bold

(PDF 1.4) Gets or sets a value indicating whether this PdfOutlineItem should be displayed in bold.

ChildCount

Gets the number of child outline items of this PdfOutlineItem.

Children

Gets the collection of child outline items of this PdfOutlineItem.

Color

(PDF 1.4) Gets or sets the color to be used for the outline entry's text.

Italic

(PDF 1.4) Gets or sets a value indicating whether this PdfOutlineItem should be displayed in italic.

Open

Gets or sets a value indicating whether this PdfOutlineItem is open.

Page

Gets the page that should be displayed when this PdfOutlineItem is activated or null if there is no such page specified for this outline item.

PageIndex

Gets the index of the page that should be displayed when this PdfOutlineItem is activated or -1 if there is no such page specified for this outline item.

Parent

Gets the parent of this PdfOutlineItem in the outline hierarchy.

Title

Gets or sets the text to be displayed on the screen for this PdfOutlineItem.

Methods

AddChild(string)

Adds new PdfOutlineItem with specified title to the end of this PdfOutlineItem's collection of child items.

AddChild(string, PdfAction)

Adds new PdfOutlineItem with specified title and action to the end of this PdfOutlineItem's collection of child items.

AddChild(string, PdfDocumentView)

Adds new PdfOutlineItem with specified title and document view to the end of this PdfOutlineItem's collection of child items.

AddChild(string, PdfPage)

Adds new PdfOutlineItem with specified title and page to the end of this PdfOutlineItem's collection of child items.

AddChild(string, int)

Adds new PdfOutlineItem with specified title and page index to the end of this PdfOutlineItem's collection of child items.

GetChild(int)

Gets the child outline item with the specified index.

IndexOfChild(PdfOutlineItem)

Retrieves the zero-based index of the first occurrence of the specified child PdfOutlineItem.

IndexOfChild(string)

Retrieves the zero-based index of the first occurrence of a child PdfOutlineItem with specified title.

InsertChild(int, string)

Inserts new PdfOutlineItem with specified title into the collection of this PdfOutlineItem's child items at the specified index.

InsertChild(int, string, PdfAction)

Inserts new PdfOutlineItem with specified title and action into the collection of this PdfOutlineItem's child items at the specified index.

InsertChild(int, string, PdfDocumentView)

Inserts new PdfOutlineItem with specified title and document view into the collection of this PdfOutlineItem's child items at the specified index.

InsertChild(int, string, PdfPage)

Inserts new PdfOutlineItem with specified title and page into the collection of this PdfOutlineItem's child items at the specified index.

InsertChild(int, string, int)

Inserts new PdfOutlineItem with specified title and page index into the collection of this PdfOutlineItem's child items at the specified index.

RemoveAllChildren()

Removes all items from the collection of this PdfOutlineItem's child items.

RemoveChild(PdfOutlineItem)

Removes the specified PdfOutlineItem from the collection of this PdfOutlineItem's child items.

RemoveChildAt(int)

Removes the PdfOutlineItem with specified index from the collection of this PdfOutlineItem's child items.

ToString()

Returns a string that represents this PdfOutlineItem instance.