Represents an outline tree (table of contents) for a PDF document. More...

Inheritance diagram for VectSharp.PDF.OutlineTree:

Public Member Functions
	OutlineTree ()
	Create a new OutlineTree. More...

int	IndexOf (OutlineTreeNode item)

void	Insert (int index, OutlineTreeNode item)

void	RemoveAt (int index)

void	Add (OutlineTreeNode item)

void	Clear ()

bool	Contains (OutlineTreeNode item)

void	CopyTo (OutlineTreeNode[] array, int arrayIndex)

bool	Remove (OutlineTreeNode item)

IEnumerator< OutlineTreeNode >	GetEnumerator ()

Static Public Member Functions
static OutlineTree	CreateFromHeadings (List<(int level, string heading, string tag)> headings, int topLevel=1)
	Creates an OutlineTree from a list of headings, such as the one produced by VectSharp.Markdown. More...

Properties
List< OutlineTreeNode >	TopLevelItems `[get]`
	The top-level items in the outline. More...

int	Count `[get]`

bool	IsReadOnly `[get]`

OutlineTreeNode	this[int index] `[get, set]`

Detailed Description

Represents an outline tree (table of contents) for a PDF document.

Definition at line 26 of file OutlineTree.cs.

Constructor & Destructor Documentation

◆ OutlineTree()

VectSharp.PDF.OutlineTree.OutlineTree ( )

Create a new OutlineTree.

Definition at line 45 of file OutlineTree.cs.

Member Function Documentation

◆ Add()

void VectSharp.PDF.OutlineTree.Add ( OutlineTreeNode item )

Definition at line 104 of file OutlineTree.cs.

◆ Clear()

void VectSharp.PDF.OutlineTree.Clear ( )

Definition at line 110 of file OutlineTree.cs.

◆ Contains()

bool VectSharp.PDF.OutlineTree.Contains ( OutlineTreeNode item )

Definition at line 116 of file OutlineTree.cs.

◆ CopyTo()

void VectSharp.PDF.OutlineTree.CopyTo	(	OutlineTreeNode[]	array,
		int	arrayIndex
	)

Definition at line 122 of file OutlineTree.cs.

◆ CreateFromHeadings()

static OutlineTree VectSharp.PDF.OutlineTree.CreateFromHeadings	(	List<(int level, string heading, string tag)>	headings,
		int	topLevel = `1`
	)

static

Creates an OutlineTree from a list of headings, such as the one produced by VectSharp.Markdown.

Parameters

headings	The list of headings. Each element specifies a heading level (starting from 1), the text for the heading, and a tag for the corresponding object in the document.
topLevel	The heading level for top-level headings. Headings above this level will not be included in the outline tree. Setting this to a value higher than 1 is useful e.g. if the document has a title included as a level 1 heading.

Returns: An OutlineTree representation of the heading list.

Definition at line 56 of file OutlineTree.cs.

◆ GetEnumerator()

IEnumerator< OutlineTreeNode > VectSharp.PDF.OutlineTree.GetEnumerator ( )

Definition at line 134 of file OutlineTree.cs.

◆ IndexOf()

int VectSharp.PDF.OutlineTree.IndexOf ( OutlineTreeNode item )

Definition at line 86 of file OutlineTree.cs.

◆ Insert()

void VectSharp.PDF.OutlineTree.Insert	(	int	index,
		OutlineTreeNode	item
	)

Definition at line 92 of file OutlineTree.cs.

◆ Remove()

bool VectSharp.PDF.OutlineTree.Remove ( OutlineTreeNode item )

Definition at line 128 of file OutlineTree.cs.

◆ RemoveAt()

void VectSharp.PDF.OutlineTree.RemoveAt ( int index )

Definition at line 98 of file OutlineTree.cs.

Property Documentation

◆ Count

int VectSharp.PDF.OutlineTree.Count

get

Definition at line 34 of file OutlineTree.cs.

◆ IsReadOnly

bool VectSharp.PDF.OutlineTree.IsReadOnly

get

Definition at line 37 of file OutlineTree.cs.

◆ this[int index]

OutlineTreeNode VectSharp.PDF.OutlineTree.this[int index]

getset

Definition at line 40 of file OutlineTree.cs.

◆ TopLevelItems

List<OutlineTreeNode> VectSharp.PDF.OutlineTree.TopLevelItems

get

The top-level items in the outline.

Definition at line 31 of file OutlineTree.cs.

The documentation for this class was generated from the following file:

VectSharp.PDF/OutlineTree.cs

Public Member Functions

Static Public Member Functions

Properties