Class for a PDF outline item (bookmark).

Inheritance Hierarchy

System.Object
  BitMiracle.Docotic.Pdf.PdfOutlineItem

Namespace: BitMiracle.Docotic.Pdf
Assembly: BitMiracle.Docotic.Pdf (in BitMiracle.Docotic.Pdf.dll)

Syntax

C#
public sealed class PdfOutlineItem
VB
Public NotInheritable Class PdfOutlineItem

The PdfOutlineItem type exposes the following members.

Properties

  NameDescription
Public propertyAction
Gets or sets the action to be performed when this PdfOutlineItem is activated.
Public propertyBold
(PDF 1.4) Gets or sets a value indicating whether this PdfOutlineItem should be displayed in bold.
Public propertyChildCount
Gets the number of child outline items of this PdfOutlineItem.
Public propertyChildren
Gets the collection of child outline items of this PdfOutlineItem.
Public propertyColor
(PDF 1.4) Gets or sets the color to be used for the outline entry's text.
Public propertyItalic
(PDF 1.4) Gets or sets a value indicating whether this PdfOutlineItem should be displayed in italic.
Public propertyOpen
Gets or sets a value indicating whether this PdfOutlineItem is open.
Public propertyPage
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.
Public propertyPageIndex
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.
Public propertyParent
Gets the parent of this PdfOutlineItem in the outline hierarchy.
Public propertyTitle
Gets or sets the text to be displayed on the screen for this PdfOutlineItem.

Methods

  NameDescription
Public methodAddChild(String)
Adds new PdfOutlineItem with specified title to the end of this PdfOutlineItem's collection of child items.
Public methodAddChild(String, PdfAction)
Adds new PdfOutlineItem with specified title and action to the end of this PdfOutlineItem's collection of child items.
Public methodAddChild(String, PdfDocumentView)
Adds new PdfOutlineItem with specified title and document view to the end of this PdfOutlineItem's collection of child items.
Public methodAddChild(String, PdfPage)
Adds new PdfOutlineItem with specified title and page to the end of this PdfOutlineItem's collection of child items.
Public methodAddChild(String, Int32)
Adds new PdfOutlineItem with specified title and page index to the end of this PdfOutlineItem's collection of child items.
Public methodEquals (Inherited from Object.)
Public methodGetChild
Gets the child outline item with the specified index.
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodIndexOfChild(String)
Retrieves the zero-based index of the first occurrence of a child PdfOutlineItem with specified title.
Public methodIndexOfChild(PdfOutlineItem)
Retrieves the zero-based index of the first occurrence of the specified child PdfOutlineItem.
Public methodInsertChild(Int32, String)
Inserts new PdfOutlineItem with specified title into the collection of this PdfOutlineItem's child items at the specified index.
Public methodInsertChild(Int32, String, PdfAction)
Inserts new PdfOutlineItem with specified title and action into the collection of this PdfOutlineItem's child items at the specified index.
Public methodInsertChild(Int32, String, PdfDocumentView)
Inserts new PdfOutlineItem with specified title and document view into the collection of this PdfOutlineItem's child items at the specified index.
Public methodInsertChild(Int32, String, PdfPage)
Inserts new PdfOutlineItem with specified title and page into the collection of this PdfOutlineItem's child items at the specified index.
Public methodInsertChild(Int32, String, Int32)
Inserts new PdfOutlineItem with specified title and page index into the collection of this PdfOutlineItem's child items at the specified index.
Public methodRemoveAllChildren
Removes all items from the collection of this PdfOutlineItem's child items.
Public methodRemoveChild
Removes the specified PdfOutlineItem from the collection of this PdfOutlineItem's child items.
Public methodRemoveChildAt
Removes the PdfOutlineItem with specified index from the collection of this PdfOutlineItem's child items.
Public methodToString
Returns a String that represents this instance.
(Overrides Object.ToString().)

See Also