• DR-IT Software
  • Products
  • Documentation
  • Product page
  • Examples
  • API reference
  • Support
Show / Hide Table of Contents

Class OutlineItem

A single bookmark (outline) entry. Has a display title, an optional navigation destination, and can contain child bookmarks via its Outlines property.

Inheritance
object
OutlineItem
Inherited Members
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
object.GetType()
Namespace: DRIT.Pdf.Outlines
Assembly: DRIT.Pdf.dll
Syntax
public sealed class OutlineItem

Properties

DestinationArguments

Destination arguments currently configured for this bookmark.

Declaration
public IReadOnlyList<double> DestinationArguments { get; }
Property Value
Type Description
IReadOnlyList<double>

DestinationPage

The target page of this bookmark destination, if set.

Declaration
public Page? DestinationPage { get; }
Property Value
Type Description
Page

DestinationViewType

The destination view type currently configured for this bookmark.

Declaration
public DestinationViewType DestinationViewType { get; }
Property Value
Type Description
DestinationViewType

Outlines

Child bookmark items nested under this item.

Declaration
public OutlineCollection Outlines { get; }
Property Value
Type Description
OutlineCollection

Title

The display title shown in the viewer's bookmarks panel.

Declaration
public string Title { get; set; }
Property Value
Type Description
string

Methods

SetDestination(Page, DestinationViewType, params double[])

Set the destination this bookmark navigates to when clicked. For FitRectangle supply left, bottom, right, top. For XYZ supply left, top, zoom (0 = inherit).

Declaration
public void SetDestination(Page page, DestinationViewType viewType, params double[] args)
Parameters
Type Name Description
Page page
DestinationViewType viewType
double[] args
Back to top

DR-IT Software documentation

DR-IT Software · Products · Documentation index · Product page · Downloads · Support · Licensing

Generated by DocFX