PdfOutlineItem Class
An item of the document outline, a bookmark (ISO 32000-2, 12.3.3).
public sealed class PdfOutlineItemConstructors
| Name | Description |
|---|---|
| PdfOutlineItem(string, PdfDestination?) | Initializes a new instance of the PdfOutlineItem class. |
PdfOutlineItem(string, PdfDestination?)
PdfOutlineItem.csInitializes a new instance of the PdfOutlineItem class.
public PdfOutlineItem(string title, PdfDestination? destination = null)Parameters
titlestring- The text of the item.
destinationPdfDestination?- The destination, or
null.
Properties
| Name | Description |
|---|---|
| Action | Gets or sets the action of the item (/A, ISO 32000-2, 12.6) when it is not a destination, such as opening a URI or running a named action; null when the item has a PdfOutlineItem.Destination or nothing. Setting an action removes the destination. The action is written when the document is saved. |
| Children | Gets the children of the item. |
| Color | Gets or sets the color of the text (PDF 1.4), or null for black. It must be an RGB color. |
| Destination | Gets or sets the destination, or null when the item has none or has an action of another kind. Setting a destination removes the PdfOutlineItem.Action. |
| IsBold | Gets or sets a value indicating whether the text is bold (PDF 1.4). |
| IsItalic | Gets or sets a value indicating whether the text is italic (PDF 1.4). |
| IsOpen | Gets or sets a value indicating whether the children of the item are shown when the document is opened. |
| Title | Gets or sets the text of the item. |
Action
PdfOutlineItem.csGets or sets the action of the item (/A, ISO 32000-2, 12.6) when it is not a destination, such as opening a URI or running a named action; null when the item has a PdfOutlineItem.Destination or nothing. Setting an action removes the destination. The action is written when the document is saved.
public PdfAction? Action { get; set; }Property value
Children
PdfOutlineItem.csColor
PdfOutlineItem.csGets or sets the color of the text (PDF 1.4), or null for black. It must be an RGB color.
public PdfColor? Color { get; set; }Destination
PdfOutlineItem.csGets or sets the destination, or null when the item has none or has an action of another kind. Setting a destination removes the PdfOutlineItem.Action.
public PdfDestination? Destination { get; set; }