Inheritance diagram for iTextSharp.text.pdf.PdfDictionary:

Public Member Functions
	PdfDictionary ()

	PdfDictionary (PdfName type)

override void	ToPdf (PdfWriter writer, Stream os)

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 ()

Static Public Attributes
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"

Properties
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
Protected Member Functions inherited from iTextSharp.text.pdf.PdfObject
	PdfObject (int type)

	PdfObject (int type, string content)

	PdfObject (int type, byte[] bytes)

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

int	type

PRIndirectReference	indRef

Detailed Description

PdfDictionary is the Pdf dictionary object.

A dictionary is an associative table containing pairs of objects. The first element of each pair is called the key and the second element is called the value. Unlike dictionaries in the PostScript language, a key must be a PdfName. A value can be any kind of PdfObject, including a dictionary. A dictionary is generally used to collect and tie together the attributes of a complex object, with each key-value pair specifying the name and value of an attribute.
A dictionary is represented by two left angle brackets (<<), followed by a sequence of key-value pairs, followed by two right angle brackets (>>).
This object is described in the 'Portable Document Format Reference Manual version 1.3' section 4.7 (page 40-41).

See also: PdfObject; PdfName; BadPdfFormatException

Constructor & Destructor Documentation

◆ PdfDictionary() [1/2]

iTextSharp.text.pdf.PdfDictionary.PdfDictionary ( )

Constructs an empty PdfDictionary-object.

◆ PdfDictionary() [2/2]

iTextSharp.text.pdf.PdfDictionary.PdfDictionary ( PdfName type )

Constructs a PdfDictionary-object of a certain type.

Parameters

type	a `PdfName`

Member Function Documentation

◆ Contains()

bool iTextSharp.text.pdf.PdfDictionary.Contains ( PdfName key )

◆ Get()

PdfObject iTextSharp.text.pdf.PdfDictionary.Get ( PdfName key )

Gets a PdfObject with a certain key from the PdfDictionary.

Parameters

key	key of the entry (a `PdfName`)

Returns: the previous PdfObject corresponding with the key

◆ GetAsArray()

PdfArray iTextSharp.text.pdf.PdfDictionary.GetAsArray ( PdfName key )

◆ GetAsBoolean()

PdfBoolean iTextSharp.text.pdf.PdfDictionary.GetAsBoolean ( PdfName key )

◆ GetAsDict()

PdfDictionary iTextSharp.text.pdf.PdfDictionary.GetAsDict ( PdfName key )

All the getAs functions will return either null, or the specified object type This function will automatically look up indirect references. There's one obvious exception, the one that will only return an indirect reference. All direct objects come back as a null. Mark A Storer (2/17/06)

Parameters

key

Returns: the appropriate object in its final type, or null

◆ GetAsIndirectObject()

PdfIndirectReference iTextSharp.text.pdf.PdfDictionary.GetAsIndirectObject ( PdfName key )

◆ GetAsName()

PdfName iTextSharp.text.pdf.PdfDictionary.GetAsName ( PdfName key )

◆ GetAsNumber()

PdfNumber iTextSharp.text.pdf.PdfDictionary.GetAsNumber ( PdfName key )

◆ GetAsStream()

PdfStream iTextSharp.text.pdf.PdfDictionary.GetAsStream ( PdfName key )

◆ GetAsString()

PdfString iTextSharp.text.pdf.PdfDictionary.GetAsString ( PdfName key )

◆ GetDirectObject()

PdfObject iTextSharp.text.pdf.PdfDictionary.GetDirectObject ( PdfName key )

This function behaves the same as 'get', but will never return an indirect reference, it will always look such references up and return the actual object.

Parameters

key

Returns: null, or a non-indirect object

◆ GetEnumerator()

virtual IDictionaryEnumerator iTextSharp.text.pdf.PdfDictionary.GetEnumerator ( )

virtual

◆ IsCatalog()

bool iTextSharp.text.pdf.PdfDictionary.IsCatalog ( )

Checks if a Dictionary is of the type CATALOG.

Returns: true if it is, false if it isn't.

◆ IsFont()

bool iTextSharp.text.pdf.PdfDictionary.IsFont ( )

Checks if a Dictionary is of the type FONT.

Returns: true if it is, false if it isn't.

◆ IsOutlineTree()

bool iTextSharp.text.pdf.PdfDictionary.IsOutlineTree ( )

Checks if a Dictionary is of the type OUTLINES.

Returns: true if it is, false if it isn't.

◆ IsPage()

bool iTextSharp.text.pdf.PdfDictionary.IsPage ( )

Checks if a Dictionary is of the type PAGE.

Returns: true if it is, false if it isn't.

◆ IsPages()

bool iTextSharp.text.pdf.PdfDictionary.IsPages ( )

Checks if a Dictionary is of the type PAGES.

Returns: true if it is, false if it isn't.

◆ Merge()

void iTextSharp.text.pdf.PdfDictionary.Merge ( PdfDictionary other )

◆ MergeDifferent()

void iTextSharp.text.pdf.PdfDictionary.MergeDifferent ( PdfDictionary other )

◆ Put()

void iTextSharp.text.pdf.PdfDictionary.Put	(	PdfName	key,
		PdfObject	value
	)

Adds a PdfObject and its key to the PdfDictionary. If the value is null or PdfNull the key is deleted.

Parameters

key	key of the entry (a `PdfName`)
value	value of the entry (a `PdfObject`)

◆ PutEx()

void iTextSharp.text.pdf.PdfDictionary.PutEx	(	PdfName	key,
		PdfObject	value
	)

Adds a PdfObject and its key to the PdfDictionary. If the value is null it does nothing.

Parameters

key	key of the entry (a `PdfName`)
value	value of the entry (a `PdfObject`)

◆ Remove()

void iTextSharp.text.pdf.PdfDictionary.Remove ( PdfName key )

Removes a PdfObject and its key from the PdfDictionary.

Parameters

key	key of the entry (a `PdfName`)

◆ ToPdf()

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

virtual

Returns the PDF representation of this PdfDictionary.

Returns: an array of byte

Reimplemented from iTextSharp.text.pdf.PdfObject.

Reimplemented in iTextSharp.text.pdf.PRStream, iTextSharp.text.pdf.PdfStream, iTextSharp.text.pdf.PdfOutline, and iTextSharp.text.pdf.PdfEFStream.

◆ ToString()

override String iTextSharp.text.pdf.PdfDictionary.ToString ( )