Inheritance diagram for iTextSharp.text.pdf.PdfOutline:

Public Member Functions
	PdfOutline (PdfOutline parent, PdfAction action, string title)

	PdfOutline (PdfOutline parent, PdfAction action, string title, bool open)

	PdfOutline (PdfOutline parent, PdfDestination destination, string title)

	PdfOutline (PdfOutline parent, PdfDestination destination, string title, bool open)

	PdfOutline (PdfOutline parent, PdfAction action, PdfString title)

	PdfOutline (PdfOutline parent, PdfAction action, PdfString title, bool open)

	PdfOutline (PdfOutline parent, PdfDestination destination, PdfString title)

	PdfOutline (PdfOutline parent, PdfDestination destination, PdfString title, bool open)

	PdfOutline (PdfOutline parent, PdfAction action, Paragraph title)

	PdfOutline (PdfOutline parent, PdfAction action, Paragraph title, bool open)

	PdfOutline (PdfOutline parent, PdfDestination destination, Paragraph title)

	PdfOutline (PdfOutline parent, PdfDestination destination, Paragraph title, bool open)

bool	SetDestinationPage (PdfIndirectReference pageReference)

override void	ToPdf (PdfWriter writer, Stream os)

void	AddKid (PdfOutline outline)

Public Member Functions inherited from iTextSharp.text.pdf.PdfDictionary
	PdfDictionary ()

	PdfDictionary (PdfName type)

void	Put (PdfName key, PdfObject value)

void	PutEx (PdfName key, PdfObject value)

void	Remove (PdfName key)

PdfObject	Get (PdfName key)

bool	IsFont ()

bool	IsPage ()

bool	IsPages ()

bool	IsCatalog ()

bool	IsOutlineTree ()

void	Merge (PdfDictionary other)

void	MergeDifferent (PdfDictionary other)

bool	Contains (PdfName key)

virtual IDictionaryEnumerator	GetEnumerator ()

override String	ToString ()

PdfObject	GetDirectObject (PdfName key)

PdfDictionary	GetAsDict (PdfName key)

PdfArray	GetAsArray (PdfName key)

PdfStream	GetAsStream (PdfName key)

PdfString	GetAsString (PdfName key)

PdfNumber	GetAsNumber (PdfName key)

PdfName	GetAsName (PdfName key)

PdfBoolean	GetAsBoolean (PdfName key)

PdfIndirectReference	GetAsIndirectObject (PdfName key)

Public Member Functions inherited from iTextSharp.text.pdf.PdfObject
virtual byte[]	GetBytes ()

bool	CanBeInObjStm ()

override string	ToString ()

bool	IsNull ()

bool	IsBoolean ()

bool	IsNumber ()

bool	IsString ()

bool	IsName ()

bool	IsArray ()

bool	IsDictionary ()

bool	IsStream ()

bool	IsIndirect ()

Protected Attributes
ArrayList	kids = new ArrayList()

PdfWriter	writer

Protected Attributes inherited from iTextSharp.text.pdf.PdfObject
byte[]	bytes

int	type

PRIndirectReference	indRef

Properties
PdfIndirectReference	IndirectReference `[get, set]`

PdfOutline	Parent `[get]`

PdfDestination	PdfDestination `[get]`

int	Level `[get]`

ArrayList	Kids `[get, set]`

string	Tag `[get, set]`

string	Title `[get, set]`

bool	Open `[get, set]`

Color	Color `[get, set]`

int	Style `[get, set]`

Properties inherited from iTextSharp.text.pdf.PdfDictionary
ICollection	Keys `[get]`

int	Size `[get]`

Properties inherited from iTextSharp.text.pdf.PdfObject
int	Length `[get]`

string	Content `[set]`

int	Type `[get]`

PRIndirectReference	IndRef `[get, set]`

Additional Inherited Members
Static Public Attributes inherited from iTextSharp.text.pdf.PdfDictionary
static PdfName	FONT = PdfName.FONT

static PdfName	OUTLINES = PdfName.OUTLINES

static PdfName	PAGE = PdfName.PAGE

static PdfName	PAGES = PdfName.PAGES

static PdfName	CATALOG = PdfName.CATALOG

Static Public Attributes inherited from iTextSharp.text.pdf.PdfObject
const int	BOOLEAN = 1

const int	NUMBER = 2

const int	STRING = 3

const int	NAME = 4

const int	ARRAY = 5

const int	DICTIONARY = 6

const int	STREAM = 7

const int	NULL = 8

const int	INDIRECT = 10

const string	NOTHING = ""

const string	TEXT_PDFDOCENCODING = "PDF"

const string	TEXT_UNICODE = "UnicodeBig"

Protected Member Functions inherited from iTextSharp.text.pdf.PdfObject
	PdfObject (int type)

	PdfObject (int type, string content)

	PdfObject (int type, byte[] bytes)

Detailed Description

PdfOutline is an object that represents a PDF outline entry.

An outline allows a user to access views of a document by name.
This object is described in the 'Portable Document Format Reference Manual version 1.3' section 6.7 (page 104-106)

See also: PdfDictionary

Constructor & Destructor Documentation

◆ PdfOutline() [1/12]

iTextSharp.text.pdf.PdfOutline.PdfOutline	(	PdfOutline	parent,
		PdfAction	action,
		string	title
	)

Constructs a PdfOutline.

This is the constructor for an outline entry. The open mode is true.

Parameters

parent	the parent of this outline item
action	the `PdfAction` for this outline item
title	the title of this outline item

◆ PdfOutline() [2/12]

iTextSharp.text.pdf.PdfOutline.PdfOutline	(	PdfOutline	parent,
		PdfAction	action,
		string	title,
		bool	open
	)

Constructs a PdfOutline.

This is the constructor for an outline entry.

Parameters

parent	the parent of this outline item
action	the `PdfAction` for this outline item
title	the title of this outline item
open	`true` if the children are visible

◆ PdfOutline() [3/12]

iTextSharp.text.pdf.PdfOutline.PdfOutline	(	PdfOutline	parent,
		PdfDestination	destination,
		string	title
	)

Constructs a PdfOutline.

This is the constructor for an outline entry. The open mode is true.

Parameters

parent	the parent of this outline item
destination	the destination for this outline item
title	the title of this outline item

◆ PdfOutline() [4/12]

iTextSharp.text.pdf.PdfOutline.PdfOutline	(	PdfOutline	parent,
		PdfDestination	destination,
		string	title,
		bool	open
	)

Constructs a PdfOutline.

This is the constructor for an outline entry.

Parameters

parent	the parent of this outline item
destination	the destination for this outline item
title	the title of this outline item
open	`true` if the children are visible

◆ PdfOutline() [5/12]

iTextSharp.text.pdf.PdfOutline.PdfOutline	(	PdfOutline	parent,
		PdfAction	action,
		PdfString	title
	)

Constructs a PdfOutline.

This is the constructor for an outline entry. The open mode is true.

Parameters

parent	the parent of this outline item
action	the `PdfAction` for this outline item
title	the title of this outline item

◆ PdfOutline() [6/12]

iTextSharp.text.pdf.PdfOutline.PdfOutline	(	PdfOutline	parent,
		PdfAction	action,
		PdfString	title,
		bool	open
	)

Constructs a PdfOutline.

This is the constructor for an outline entry.

Parameters

parent	the parent of this outline item
action	the `PdfAction` for this outline item
title	the title of this outline item
open	`true` if the children are visible

◆ PdfOutline() [7/12]

iTextSharp.text.pdf.PdfOutline.PdfOutline	(	PdfOutline	parent,
		PdfDestination	destination,
		PdfString	title
	)

Constructs a PdfOutline.

This is the constructor for an outline entry. The open mode is true.

Parameters

parent	the parent of this outline item
destination	the destination for this outline item
title	the title of this outline item

◆ PdfOutline() [8/12]

iTextSharp.text.pdf.PdfOutline.PdfOutline	(	PdfOutline	parent,
		PdfDestination	destination,
		PdfString	title,
		bool	open
	)

Constructs a PdfOutline.

This is the constructor for an outline entry.

Parameters

parent	the parent of this outline item
destination	the destination for this outline item
title	the title of this outline item
open	`true` if the children are visible

◆ PdfOutline() [9/12]

iTextSharp.text.pdf.PdfOutline.PdfOutline	(	PdfOutline	parent,
		PdfAction	action,
		Paragraph	title
	)

Constructs a PdfOutline.

This is the constructor for an outline entry. The open mode is true.

Parameters

parent	the parent of this outline item
action	the `PdfAction` for this outline item
title	the title of this outline item

◆ PdfOutline() [10/12]

iTextSharp.text.pdf.PdfOutline.PdfOutline	(	PdfOutline	parent,
		PdfAction	action,
		Paragraph	title,
		bool	open
	)

Constructs a PdfOutline.

This is the constructor for an outline entry.

Parameters

parent	the parent of this outline item
action	the `PdfAction` for this outline item
title	the title of this outline item
open	`true` if the children are visible

◆ PdfOutline() [11/12]

iTextSharp.text.pdf.PdfOutline.PdfOutline	(	PdfOutline	parent,
		PdfDestination	destination,
		Paragraph	title
	)

Constructs a PdfOutline.

This is the constructor for an outline entry. The open mode is true.

Parameters

parent	the parent of this outline item
destination	the destination for this outline item
title	the title of this outline item

◆ PdfOutline() [12/12]

iTextSharp.text.pdf.PdfOutline.PdfOutline	(	PdfOutline	parent,
		PdfDestination	destination,
		Paragraph	title,
		bool	open
	)

Constructs a PdfOutline.

This is the constructor for an outline entry.

Parameters

parent	the parent of this outline item
destination	the destination for this outline item
title	the title of this outline item
open	`true` if the children are visible

Member Function Documentation

◆ AddKid()

void iTextSharp.text.pdf.PdfOutline.AddKid ( PdfOutline outline )

◆ SetDestinationPage()

bool iTextSharp.text.pdf.PdfOutline.SetDestinationPage ( PdfIndirectReference pageReference )

Set the page of the PdfDestination-object.

Parameters

pageReference indirect reference to the page

Returns: true if this page was set as the PdfDestination-page.

◆ ToPdf()

override void iTextSharp.text.pdf.PdfOutline.ToPdf	(	PdfWriter	writer,
		Stream	os
	)

virtual

Returns the PDF representation of this PdfOutline.

Parameters

writer	the encryption information
os

Exceptions

IOException

Reimplemented from iTextSharp.text.pdf.PdfDictionary.

Member Data Documentation

◆ kids

ArrayList iTextSharp.text.pdf.PdfOutline.kids = new ArrayList()

protected

◆ writer

PdfWriter iTextSharp.text.pdf.PdfOutline.writer

protected

Property Documentation

◆ Color

Color iTextSharp.text.pdf.PdfOutline.Color

getset

◆ IndirectReference

PdfIndirectReference iTextSharp.text.pdf.PdfOutline.IndirectReference

getset

Gets the indirect reference of this PdfOutline.

Returns: the PdfIndirectReference to this outline.

◆ Kids

ArrayList iTextSharp.text.pdf.PdfOutline.Kids

getset

◆ Level

int iTextSharp.text.pdf.PdfOutline.Level

get

returns the level of this outline.

Returns: a level

◆ Open

bool iTextSharp.text.pdf.PdfOutline.Open

getset

Setter for property open.

Parameters

open	New value of property open.

◆ Parent

PdfOutline iTextSharp.text.pdf.PdfOutline.Parent

get

Gets the parent of this PdfOutline.

Returns: the PdfOutline that is the parent of this outline.

◆ PdfDestination

PdfDestination iTextSharp.text.pdf.PdfOutline.PdfDestination

get

Gets the destination for this outline.

Returns: the destination

◆ Style

int iTextSharp.text.pdf.PdfOutline.Style

getset

◆ Tag

string iTextSharp.text.pdf.PdfOutline.Tag

getset

Getter for property tag.

Returns: Value of property tag.

◆ Title

string iTextSharp.text.pdf.PdfOutline.Title

getset

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

src/core/iTextSharp/text/pdf/PdfOutline.cs

Public Member Functions

Protected Attributes

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PdfOutline() [1/12]

◆ PdfOutline() [2/12]

◆ PdfOutline() [3/12]

◆ PdfOutline() [4/12]

◆ PdfOutline() [5/12]

◆ PdfOutline() [6/12]

◆ PdfOutline() [7/12]

◆ PdfOutline() [8/12]

◆ PdfOutline() [9/12]

◆ PdfOutline() [10/12]

◆ PdfOutline() [11/12]

◆ PdfOutline() [12/12]

Member Function Documentation

◆ AddKid()

◆ SetDestinationPage()

◆ ToPdf()

Member Data Documentation

◆ kids

◆ writer

Property Documentation

◆ Color

◆ IndirectReference

◆ Kids

◆ Level

◆ Open

◆ Parent

◆ PdfDestination

◆ Style

◆ Tag

◆ Title