Skip to content

# PDFOutlineItem

Namespace: O2S.Components.PDF4NET

Defines a PDF outline item.

    public class PDFOutlineItem

Inheritance Object → PDFOutlineItem

Remarks

An outline item defines an entry in the document outline.

## Constructors

### PDFOutlineItem()

Initializes a new PDFOutlineItem object.

    public PDFOutlineItem()

## Properties

### Action

Gets or sets the outline item action.

    public PDFAction Action { get; set; }

Property Value

PDFAction
The action to be performed when this item is activated.

Remarks

PDFOutlineItem.Destination and PDFOutlineItem.Action properties are mutually exclusive.

### Color

Gets or sets the color.

    public PDFRgbColor Color { get; set; }

Property Value

PDFRgbColor
The color to be used for the outline item's text.

### CosDictionary

Gets the COS dictionary asssociated with this object.

    public PDFCosDictionary CosDictionary { get; }

Property Value

PDFCosDictionary
The internal COS dictionary.

Remarks

Incorrect manipulation of the information in the COS dictionary can lead to invalid PDF files.

### Destination

Gets or sets the outline item destination.

    public PDFDestination Destination { get; set; }

Property Value

PDFDestination
The destination to be displayed when this item is activated.

Remarks

PDFOutlineItem.Destination and PDFOutlineItem.Action properties are mutually exclusive.

### Expanded

Gets or sets a value indicating the initial state of the outline item.

    public bool Expanded { get; set; }

Property Value

Boolean
If true, the outline item is expanded when it is displayed.

### Items

Gets the collection of child outline items.

    public PDFOutlineItemCollection Items { get; }

Property Value

PDFOutlineItemCollection
A PDFOutlineItemCollection that represents the child outline items.

### Parent

Gets the parent of the outline item.

    public PDFOutlineItem Parent { get; internal set; }

Property Value

PDFOutlineItem
The parent outline item.

Remarks

This property is null (Nothing in VB.NET) for top level outline items.

### Title

Gets or sets the title.

    public string Title { get; set; }

Property Value

String
The text to be displayed on the screen for this item.

### VisualStyle

Gets or sets the visual style.

    public PDFOutlineItemVisualStyle VisualStyle { get; set; }

Property Value

PDFOutlineItemVisualStyle
A PDFOutlineItemVisualStyle that represents the style for displaying the outline item's text

## Methods

### ToString()

Returns a String that represents the current Object.

    public string ToString()

Returns

String
String that represents the current Object.