Represents an outline item in the outlines tree. An 'outline' is also known as a 'bookmark'.
Inheritance Hierarchy
PdfEdit.PdfPdfItem
PdfEdit.PdfPdfObject
PdfEdit.PdfPdfDictionary
PdfEdit.PdfPdfOutline
Namespace: PdfEdit.Pdf
Assembly: PdfPrintingNet (in PdfPrintingNet.dll) Version: 5.1.1.0 (5.1.1.0)
Syntax
The PdfOutline type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | PdfOutline |
Initializes a new instance of the PdfOutline class.
|
| PdfOutline(PdfDictionary) |
Initializes a new instance from an existing dictionary. Used for object type transformation.
|
| PdfOutline(String, PdfPage) |
Initializes a new instance of the PdfOutline class.
|
| PdfOutline(String, PdfPage, Boolean) |
Initializes a new instance of the PdfOutline class.
|
| PdfOutline(String, PdfPage, Boolean, PdfOutlineStyle) |
Initializes a new instance of the PdfOutline class.
|
| PdfOutline(String, PdfPage, Boolean, PdfOutlineStyle, XColor) |
Initializes a new instance of the PdfOutline class.
|
Methods
| Name | Description | |
|---|---|---|
| Clone |
Creates a copy of this dictionary. Direct values are deep copied. Indirect references are not
modified.
(Inherited from PdfDictionary.) |
| CreateStream |
Creates the stream of this dictionary and initializes it with the specified byte array.
The function must not be called if the dictionary already has a stream.
(Inherited from PdfDictionary.) |
| Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
| GetEnumerator |
Returns an enumerator that iterates through the dictionary elements.
(Inherited from PdfDictionary.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| ToString |
Returns a string with the content of this object in a readable form. Useful for debugging purposes only.
(Inherited from PdfDictionary.) |
Fields
| Name | Description | |
|---|---|---|
 | ForceFilters |
List of filters which will be applied on the PdfDictionary stream.
(Inherited from PdfDictionary.) |
Properties
| Name | Description | |
|---|---|---|
 | Bottom |
Gets or sets the bottom postion of the page positioned at the bottom side of the window.
Applies only if PageDestinationType is FitR.
|
| DestinationPage |
Gets or sets the destination page.
|
| Elements |
Gets the dictionary containing the elements of this dictionary.
(Inherited from PdfDictionary.) |
| HasChildren |
Gets a value indicating whether this outline object has child items.
|
| Internals |
Gets the PdfInternals object of this document, that grants access to some internal structures
which are not part of the public interface of PdfDocument.
(Inherited from PdfObject.) |
| IsIndirect |
Indicates whether the object is an indirect object.
(Inherited from PdfObject.) |
| Left |
Gets or sets the left postion of the page positioned at the left side of the window.
Applies only if PageDestinationType is Xyz, FitV, FitR, or FitBV.
|
| Opened |
Gets or sets whether the outline item is opened (or expanded).
|
| Outlines |
Gets the outline collection of this node.
|
| Owner |
Gets the PdfDocument this object belongs to.
(Inherited from PdfObject.) |
| PageDestinationType |
Gets or sets the type of the page destination.
|
| Parent |
Gets the parent of this outline item. The root item has no parent and returns null.
|
| Reference |
Gets the indirect reference of this object. If the value is null, this object is a direct object.
(Inherited from PdfObject.) |
| Right |
Gets or sets the right postion of the page positioned at the right side of the window.
Applies only if PageDestinationType is FitR.
|
| Stream |
Gets or sets the PDF stream belonging to this dictionary. Returns null if the dictionary has
no stream. To create the stream, call the CreateStream function.
(Inherited from PdfDictionary.) |
| Style |
Gets or sets the style of the outline text.
|
| TextColor |
Gets or sets the color of the text.
|
| Title |
Gets or sets the title.
|
| Top |
Gets or sets the top postion of the page positioned at the top side of the window.
Applies only if PageDestinationType is Xyz, FitH, FitR, ob FitBH.
|
| Zoom |
Gets or sets the zoom faction of the page.
Applies only if PageDestinationType is Xyz.
|
See Also