A representation of a Dictionary as described by the PDF Specification. More...

Inheritance diagram for iText.Kernel.Pdf.PdfDictionary:

Public Member Functions
	PdfDictionary ()
	Creates a new PdfDictionary instance. More...

	PdfDictionary (IDictionary< PdfName, PdfObject > map)
	Creates a new PdfDictionary instance. More...

	PdfDictionary (ICollection< KeyValuePair< PdfName, PdfObject >> entrySet)
	Creates a new PdfDictionary instance. More...

	PdfDictionary (iText.Kernel.Pdf.PdfDictionary dictionary)
	Creates a new PdfDictionary instance. More...

virtual int	Size ()
	Returns the number of key-value pairs in this PdfDictionary. More...

virtual bool	IsEmpty ()
	Returns true if there are no key-value pairs in this PdfDictionary. More...

virtual bool	ContainsKey (PdfName key)
	Returns true if this PdfDictionary contains the specified key. More...

virtual bool	ContainsValue (PdfObject value)
	Returns true if this PdfDictionary contains the specified value. More...

virtual PdfObject	Get (PdfName key)
	Returns the value associated to this key. More...

virtual PdfArray	GetAsArray (PdfName key)
	Returns the value associated to this key as a PdfArray. More...

virtual iText.Kernel.Pdf.PdfDictionary	GetAsDictionary (PdfName key)
	Returns the value associated to this key as a PdfDictionary. More...

virtual PdfStream	GetAsStream (PdfName key)
	Returns the value associated to this key as a PdfStream. More...

virtual PdfNumber	GetAsNumber (PdfName key)
	Returns the value associated to this key as a PdfNumber. More...

virtual PdfName	GetAsName (PdfName key)
	Returns the value associated to this key as a PdfName. More...

virtual PdfString	GetAsString (PdfName key)
	Returns the value associated to this key as a PdfString. More...

virtual PdfBoolean	GetAsBoolean (PdfName key)
	Returns the value associated to this key as a PdfBoolean. More...

virtual Rectangle	GetAsRectangle (PdfName key)
	Returns the value associated to this key as a Rectangle. More...

virtual ? float	GetAsFloat (PdfName key)
	Returns the value associated to this key as a Float. More...

virtual ? int	GetAsInt (PdfName key)
	Returns the value associated to this key as an Integer. More...

virtual ? bool	GetAsBool (PdfName key)
	Returns the value associated to this key as a Boolean. More...

virtual PdfObject	Put (PdfName key, PdfObject value)
	Inserts the value into this PdfDictionary and associates it with the specified key. More...

virtual PdfObject	Remove (PdfName key)
	Removes the specified key from this PdfDictionary. More...

virtual void	PutAll (iText.Kernel.Pdf.PdfDictionary d)
	Inserts all the key-value pairs into this PdfDictionary. More...

virtual void	Clear ()
	Removes all key-value pairs from this PdfDictionary. More...

virtual ICollection< PdfName >	KeySet ()
	Returns all the keys of this PdfDictionary as a Set. More...

virtual ICollection< PdfObject >	Values (bool asDirects)
	Returns all the values of this map in a Collection. More...

virtual ICollection< PdfObject >	Values ()
	Returns all the values of this map in a Collection. More...

virtual ICollection< KeyValuePair< PdfName, PdfObject > >	EntrySet ()
	Returns a Set holding the key-value pairs as Map::Entry objects. More...

override byte	GetObjectType ()
	Gets object type. More...

override String	ToString ()

virtual iText.Kernel.Pdf.PdfDictionary	Clone (IList< PdfName > excludeKeys)
	Creates clones of the dictionary in the current document. More...

virtual iText.Kernel.Pdf.PdfDictionary	CopyTo (PdfDocument document, IList< PdfName > excludeKeys, bool allowDuplicating)
	Copies dictionary to specified document. More...

virtual iText.Kernel.Pdf.PdfDictionary	CopyTo (PdfDocument document, IList< PdfName > excludeKeys, bool allowDuplicating, ICopyFilter copyFilter)
	Copies dictionary to specified document. More...

virtual PdfObject	Get (PdfName key, bool asDirect)

virtual void	MergeDifferent (iText.Kernel.Pdf.PdfDictionary other)
	This method merges different fields from two dictionaries into the current one More...

Public Member Functions inherited from iText.Kernel.Pdf.PdfObject
void	Flush ()
	Flushes the object to the document. More...

void	Flush (bool canBeInObjStm)
	Flushes the object to the document. More...

virtual PdfIndirectReference	GetIndirectReference ()
	Gets the indirect reference associated with the object. More...

virtual bool	IsIndirect ()
	Checks if object is indirect. More...

virtual PdfObject	MakeIndirect (PdfDocument document, PdfIndirectReference reference)
	Marks object to be saved as indirect. More...

virtual PdfObject	MakeIndirect (PdfDocument document)
	Marks object to be saved as indirect. More...

virtual bool	IsFlushed ()
	Indicates is the object has been flushed or not. More...

virtual bool	IsModified ()
	Indicates is the object has been set as modified or not. More...

virtual PdfObject	Clone ()
	Creates clone of the object which belongs to the same document as original object. More...

virtual PdfObject	Clone (ICopyFilter filter)
	Creates clone of the object which belongs to the same document as original object. More...

virtual PdfObject	CopyTo (PdfDocument document)
	Copies object to a specified document. More...

virtual PdfObject	CopyTo (PdfDocument document, bool allowDuplicating)
	Copies object to a specified document. More...

virtual PdfObject	CopyTo (PdfDocument document, ICopyFilter copyFilter)
	Copies object to a specified document. More...

virtual PdfObject	CopyTo (PdfDocument document, bool allowDuplicating, ICopyFilter copyFilter)
	Copies object to a specified document. More...

virtual PdfObject	SetModified ()
	Sets the 'modified' flag to the indirect object, the flag denotes that the object was modified since the document opening. More...

virtual bool	IsReleaseForbidden ()
	Checks if it's forbidden to release this PdfObject instance. More...

virtual void	Release ()

virtual bool	IsNull ()
	Checks if this `PdfObject` is of the type `PdfNull`. More...

virtual bool	IsBoolean ()
	Checks if this `PdfObject` is of the type `PdfBoolean`. More...

virtual bool	IsNumber ()
	Checks if this `PdfObject` is of the type `PdfNumber`. More...

virtual bool	IsString ()
	Checks if this `PdfObject` is of the type `PdfString`. More...

virtual bool	IsName ()
	Checks if this `PdfObject` is of the type `PdfName`. More...

virtual bool	IsArray ()
	Checks if this `PdfObject` is of the type `PdfArray`. More...

virtual bool	IsDictionary ()
	Checks if this `PdfObject` is of the type `PdfDictionary`. More...

virtual bool	IsStream ()
	Checks if this `PdfObject` is of the type `PdfStream`. More...

virtual bool	IsIndirectReference ()
	Checks if this `PdfObject` is of the type `PdfIndirectReference`. More...

virtual bool	IsLiteral ()
	Checks if this `PdfObject` is of the type `PdfLiteral`. More...

Package Functions
override PdfObject	NewInstance ()
	Creates new instance of object. More...

override void	CopyContent (PdfObject from, PdfDocument document)
	Copies object content from object 'from'. More...

override void	CopyContent (PdfObject from, PdfDocument document, ICopyFilter copyFilter)
	Copies object content from object 'from'. More...

virtual void	ReleaseContent ()
	Release content of PdfDictionary. More...

Package Functions inherited from iText.Kernel.Pdf.PdfObject
virtual PdfObject	SetIndirectReference (PdfIndirectReference indirectReference)

virtual bool	CheckState (short state)
	Checks state of the flag of current object. More...

virtual PdfObject	SetState (short state)
	Sets special states of current object. More...

virtual PdfObject	ClearState (short state)
	Clear state of the flag of current object. More...

Additional Inherited Members
Static Public Attributes inherited from iText.Kernel.Pdf.PdfObject
const byte	ARRAY = 1

const byte	BOOLEAN = 2

const byte	DICTIONARY = 3

const byte	LITERAL = 4

const byte	INDIRECT_REFERENCE = 5

const byte	NAME = 6

const byte	NULL = 7

const byte	NUMBER = 8

const byte	STREAM = 9

const byte	STRING = 10

Package Attributes inherited from iText.Kernel.Pdf.PdfObject
PdfIndirectReference	indirectReference = null
	If object is flushed the indirect reference is kept here. More...

Static Package Attributes inherited from iText.Kernel.Pdf.PdfObject
const short	FLUSHED = 1
	Indicates if the object has been flushed. More...

const short	FREE = 1 << 1
	Indicates that the indirect reference of the object could be reused or have to be marked as free. More...

const short	READING = 1 << 2
	Indicates that definition of the indirect reference of the object still not found (e.g. keys in XRefStm). More...

const short	MODIFIED = 1 << 3
	Indicates that object changed (is used in append mode). More...

const short	ORIGINAL_OBJECT_STREAM = 1 << 4
	Indicates that the indirect reference of the object represents ObjectStream from original document. More...

const short	MUST_BE_FLUSHED = 1 << 5
	For internal usage only. More...

const short	MUST_BE_INDIRECT = 1 << 6
	Indicates that the object shall be indirect when it is written to the document. More...

const short	FORBID_RELEASE = 1 << 7
	Indicates that the object is highly sensitive and we do not want to release it even if release() is called. More...

const short	READ_ONLY = 1 << 8
	Indicates that we do not want this object to be ever written into the resultant document (because of multiple objects read from the same reference inconsistency). More...

const short	UNENCRYPTED = 1 << 9
	Indicates that this object is not encrypted in the encrypted document. More...

Detailed Description

A representation of a Dictionary as described by the PDF Specification.

A representation of a Dictionary as described by the PDF Specification. A Dictionary is a mapping between keys and values. Keys are PdfNames and the values are PdfObjects . Each key can only be associated with one value and adding a new value to an existing key will override the previous value. A value of null should be ignored when the PdfDocument is closed.

Constructor & Destructor Documentation

◆ PdfDictionary() [1/4]

iText.Kernel.Pdf.PdfDictionary.PdfDictionary ( )

inline

Creates a new PdfDictionary instance.

◆ PdfDictionary() [2/4]

iText.Kernel.Pdf.PdfDictionary.PdfDictionary ( IDictionary< PdfName, PdfObject > map )

inline

Creates a new PdfDictionary instance.

Creates a new PdfDictionary instance. This constructor inserts the content of the specified Map into this PdfDictionary instance.

Parameters

map	Map containing values to be inserted into PdfDictionary

◆ PdfDictionary() [3/4]

iText.Kernel.Pdf.PdfDictionary.PdfDictionary ( ICollection< KeyValuePair< PdfName, PdfObject >> entrySet )

inline

Creates a new PdfDictionary instance.

Creates a new PdfDictionary instance. This constructor inserts the content of the specified Set into this PdfDictionary instance.

Parameters

entrySet Set containing Map::Entries to be inserted into PdfDictionary

◆ PdfDictionary() [4/4]

iText.Kernel.Pdf.PdfDictionary.PdfDictionary ( iText.Kernel.Pdf.PdfDictionary dictionary )

inline

Creates a new PdfDictionary instance.

Creates a new PdfDictionary instance. This constructor inserts the content of the specified PdfDictionary into this PdfDictionary instance.

Parameters

dictionary PdfDictionary containing values to be inserted into PdfDictionary

Member Function Documentation

◆ Clear()

virtual void iText.Kernel.Pdf.PdfDictionary.Clear ( )

inlinevirtual

Removes all key-value pairs from this PdfDictionary.

◆ Clone()

virtual iText.Kernel.Pdf.PdfDictionary iText.Kernel.Pdf.PdfDictionary.Clone ( IList< PdfName > excludeKeys )

inlinevirtual

Creates clones of the dictionary in the current document.

Creates clones of the dictionary in the current document. It's possible to pass a list of keys to exclude when cloning.

Parameters

excludeKeys list of objects to exclude when cloning dictionary.

Returns: cloned dictionary.

◆ ContainsKey()

virtual bool iText.Kernel.Pdf.PdfDictionary.ContainsKey ( PdfName key )

inlinevirtual

Returns true if this PdfDictionary contains the specified key.

Parameters

key	the key to check

Returns: true if key is present in the PdfDictionary

◆ ContainsValue()

virtual bool iText.Kernel.Pdf.PdfDictionary.ContainsValue ( PdfObject value )

inlinevirtual

Returns true if this PdfDictionary contains the specified value.

Parameters

value the value to check

Returns: true if value is present in the PdfDictionary

◆ CopyContent() [1/2]

override void iText.Kernel.Pdf.PdfDictionary.CopyContent	(	PdfObject	from,
		PdfDocument	document
	)

inlinepackagevirtual

Copies object content from object 'from'.

Reimplemented from iText.Kernel.Pdf.PdfObject.

Reimplemented in iText.Kernel.Pdf.PdfStream.

◆ CopyContent() [2/2]

override void iText.Kernel.Pdf.PdfDictionary.CopyContent	(	PdfObject	from,
		PdfDocument	document,
		ICopyFilter	copyFilter
	)

inlinepackagevirtual

Copies object content from object 'from'.

Reimplemented from iText.Kernel.Pdf.PdfObject.

Reimplemented in iText.Kernel.Pdf.PdfStream.

◆ CopyTo() [1/2]

virtual iText.Kernel.Pdf.PdfDictionary iText.Kernel.Pdf.PdfDictionary.CopyTo	(	PdfDocument	document,
		IList< PdfName >	excludeKeys,
		bool	allowDuplicating
	)

inlinevirtual

Copies dictionary to specified document.

Copies dictionary to specified document. It's possible to pass a list of keys to exclude when copying.

Parameters

document	document to copy dictionary to.
excludeKeys	list of objects to exclude when copying dictionary.
allowDuplicating

PdfObject.CopyTo(PdfDocument, bool)

Returns: copied dictionary.

◆ CopyTo() [2/2]

virtual iText.Kernel.Pdf.PdfDictionary iText.Kernel.Pdf.PdfDictionary.CopyTo	(	PdfDocument	document,
		IList< PdfName >	excludeKeys,
		bool	allowDuplicating,
		ICopyFilter	copyFilter
	)

inlinevirtual

Copies dictionary to specified document.

Copies dictionary to specified document. It's possible to pass a list of keys to exclude when copying.

Parameters

document	document to copy dictionary to.
excludeKeys	list of objects to exclude when copying dictionary.
allowDuplicating

PdfObject.CopyTo(PdfDocument, bool)

Parameters

copyFilter

iText.Kernel.Utils.ICopyFilter a filter to apply while copying arrays and dictionaries Use iText.Kernel.Utils.NullCopyFilter for no filtering

Returns: copied dictionary.

◆ EntrySet()

virtual ICollectionPdfName, PdfObject> > iText.Kernel.Pdf.PdfDictionary.EntrySet ( )

inlinevirtual

Returns a Set holding the key-value pairs as Map::Entry objects.

Returns a Set holding the key-value pairs as Map::Entry objects.
NOTE: since 7.0.1 it returns collection of direct objects. If you want to get PdfIndirectReference instances for the indirect objects value, you shall use Get(PdfName, bool) method.

Returns: a Set of Map.Entry objects

◆ Get() [1/2]

virtual PdfObject iText.Kernel.Pdf.PdfDictionary.Get ( PdfName key )

inlinevirtual

Returns the value associated to this key.

Parameters

key	the key of which the associated value needs to be returned

Returns: the value associated with this key

◆ Get() [2/2]

virtual PdfObject iText.Kernel.Pdf.PdfDictionary.Get	(	PdfName	key,
		bool	asDirect
	)

inlinevirtual

Parameters

asDirect	true is to extract direct object always.
key	the key to get the value from the map

Returns: key if indirect reference is present

◆ GetAsArray()

virtual PdfArray iText.Kernel.Pdf.PdfDictionary.GetAsArray ( PdfName key )

inlinevirtual

Returns the value associated to this key as a PdfArray.

Returns the value associated to this key as a PdfArray. If the value isn't a PdfArray, null is returned.

Parameters

key	the key of which the associated value needs to be returned

Returns: PdfArray associated with this key

◆ GetAsBool()

virtual ? bool iText.Kernel.Pdf.PdfDictionary.GetAsBool ( PdfName key )

inlinevirtual

Returns the value associated to this key as a Boolean.

Returns the value associated to this key as a Boolean. If the value isn't a PdfBoolean, null is returned.

Parameters

key	the key of which the associated value needs to be returned

Returns: Boolean associated with this key

◆ GetAsBoolean()

virtual PdfBoolean iText.Kernel.Pdf.PdfDictionary.GetAsBoolean ( PdfName key )

inlinevirtual

Returns the value associated to this key as a PdfBoolean.

Returns the value associated to this key as a PdfBoolean. If the value isn't a PdfBoolean, null is returned.

Parameters

key	the key of which the associated value needs to be returned

Returns: PdfBoolean associated with this key

◆ GetAsDictionary()

virtual iText.Kernel.Pdf.PdfDictionary iText.Kernel.Pdf.PdfDictionary.GetAsDictionary ( PdfName key )

inlinevirtual

Returns the value associated to this key as a PdfDictionary.

Returns the value associated to this key as a PdfDictionary. If the value isn't a PdfDictionary, null is returned.

Parameters

key	the key of which the associated value needs to be returned

Returns: PdfDictionary associated with this key

◆ GetAsFloat()

virtual ? float iText.Kernel.Pdf.PdfDictionary.GetAsFloat ( PdfName key )

inlinevirtual

Returns the value associated to this key as a Float.

Returns the value associated to this key as a Float. If the value isn't a Pdfnumber, null is returned.

Parameters

key	the key of which the associated value needs to be returned

Returns: Float associated with this key

◆ GetAsInt()

virtual ? int iText.Kernel.Pdf.PdfDictionary.GetAsInt ( PdfName key )

inlinevirtual

Returns the value associated to this key as an Integer.

Returns the value associated to this key as an Integer. If the value isn't a Pdfnumber, null is returned.

Parameters

key	the key of which the associated value needs to be returned

Returns: Integer associated with this key

◆ GetAsName()

virtual PdfName iText.Kernel.Pdf.PdfDictionary.GetAsName ( PdfName key )

inlinevirtual

Returns the value associated to this key as a PdfName.

Returns the value associated to this key as a PdfName. If the value isn't a PdfName, null is returned.

Parameters

key	the key of which the associated value needs to be returned

Returns: PdfName associated with this key

◆ GetAsNumber()

virtual PdfNumber iText.Kernel.Pdf.PdfDictionary.GetAsNumber ( PdfName key )

inlinevirtual

Returns the value associated to this key as a PdfNumber.

Returns the value associated to this key as a PdfNumber. If the value isn't a PdfNumber, null is returned.

Parameters

key	the key of which the associated value needs to be returned

Returns: PdfNumber associated with this key

◆ GetAsRectangle()

virtual Rectangle iText.Kernel.Pdf.PdfDictionary.GetAsRectangle ( PdfName key )

inlinevirtual

Returns the value associated to this key as a Rectangle.

Returns the value associated to this key as a Rectangle. If the value isn't a PdfArray of which the firt four elements are PdfNumbers, null is returned.

Parameters

key	the key of which the associated value needs to be returned

Returns: PdfArray associated with this key

See also: PdfArray.ToRectangle()

◆ GetAsStream()

virtual PdfStream iText.Kernel.Pdf.PdfDictionary.GetAsStream ( PdfName key )

inlinevirtual

Returns the value associated to this key as a PdfStream.

Returns the value associated to this key as a PdfStream. If the value isn't a PdfStream, null is returned.

Parameters

key	the key of which the associated value needs to be returned

Returns: PdfStream associated with this key

◆ GetAsString()

virtual PdfString iText.Kernel.Pdf.PdfDictionary.GetAsString ( PdfName key )

inlinevirtual

Returns the value associated to this key as a PdfString.

Returns the value associated to this key as a PdfString. If the value isn't a PdfString, null is returned.

Parameters

key	the key of which the associated value needs to be returned

Returns: PdfString associated with this key

◆ GetObjectType()

override byte iText.Kernel.Pdf.PdfDictionary.GetObjectType ( )

inlinevirtual

Gets object type.

Returns: object type.

Implements iText.Kernel.Pdf.PdfObject.

Reimplemented in iText.Kernel.Pdf.PdfStream.

◆ IsEmpty()

virtual bool iText.Kernel.Pdf.PdfDictionary.IsEmpty ( )

inlinevirtual

Returns true if there are no key-value pairs in this PdfDictionary.

Returns: true if there are no key-value pairs in this PdfDictionary

◆ KeySet()

virtual ICollection<PdfName> iText.Kernel.Pdf.PdfDictionary.KeySet ( )

inlinevirtual

Returns all the keys of this PdfDictionary as a Set.

Returns: Set of keys

◆ MergeDifferent()

virtual void iText.Kernel.Pdf.PdfDictionary.MergeDifferent ( iText.Kernel.Pdf.PdfDictionary other )

inlinevirtual

This method merges different fields from two dictionaries into the current one

Parameters

other a dictionary whose fields should be merged into the current dictionary.

◆ NewInstance()

override PdfObject iText.Kernel.Pdf.PdfDictionary.NewInstance ( )

inlinepackagevirtual

Creates new instance of object.

Returns: new instance of object.

Implements iText.Kernel.Pdf.PdfObject.

Reimplemented in iText.Kernel.Pdf.PdfStream.

◆ Put()

virtual PdfObject iText.Kernel.Pdf.PdfDictionary.Put	(	PdfName	key,
		PdfObject	value
	)

inlinevirtual

Inserts the value into this PdfDictionary and associates it with the specified key.

Inserts the value into this PdfDictionary and associates it with the specified key. If the key is already present in this PdfDictionary, this method will override the old value with the specified one.

Parameters

key	key to insert or to override
value	the value to associate with the specified key

Returns: the previous PdfObject associated with this key

◆ PutAll()

virtual void iText.Kernel.Pdf.PdfDictionary.PutAll ( iText.Kernel.Pdf.PdfDictionary d )

inlinevirtual

Inserts all the key-value pairs into this PdfDictionary.

Parameters

d	PdfDictionary holding the key-value pairs to be copied

◆ ReleaseContent()

virtual void iText.Kernel.Pdf.PdfDictionary.ReleaseContent ( )

inlinepackagevirtual

Release content of PdfDictionary.

Reimplemented in iText.Kernel.Pdf.PdfStream.

◆ Remove()

virtual PdfObject iText.Kernel.Pdf.PdfDictionary.Remove ( PdfName key )

inlinevirtual

Removes the specified key from this PdfDictionary.

Parameters

key	key to be removed

Returns: the removed value associated with the specified key

◆ Size()

virtual int iText.Kernel.Pdf.PdfDictionary.Size ( )

inlinevirtual

Returns the number of key-value pairs in this PdfDictionary.

Returns: number of key-value pairs

◆ Values() [1/2]

virtual ICollection<PdfObject> iText.Kernel.Pdf.PdfDictionary.Values ( )

inlinevirtual

Returns all the values of this map in a Collection.

Returns all the values of this map in a Collection.
NOTE: since 7.0.1 it returns collection of direct objects. If you want to get PdfIndirectReference instances for the indirect objects value, you shall use Values(bool) method.

Returns: a Collection holding all the values

◆ Values() [2/2]

virtual ICollection<PdfObject> iText.Kernel.Pdf.PdfDictionary.Values ( bool asDirects )

inlinevirtual

Returns all the values of this map in a Collection.

Parameters

asDirects if false, collection will contain PdfIndirectReference instances for the indirect objects in dictionary, otherwise it will contain collection of direct objects.

Returns: a Collection holding all the values

Public Member Functions

Package Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PdfDictionary() [1/4]

◆ PdfDictionary() [2/4]

◆ PdfDictionary() [3/4]

◆ PdfDictionary() [4/4]

Member Function Documentation

◆ Clear()

◆ Clone()

◆ ContainsKey()

◆ ContainsValue()

◆ CopyContent() [1/2]

◆ CopyContent() [2/2]

◆ CopyTo() [1/2]

◆ CopyTo() [2/2]

◆ EntrySet()

◆ Get() [1/2]

◆ Get() [2/2]

◆ GetAsArray()

◆ GetAsBool()

◆ GetAsBoolean()

◆ GetAsDictionary()

◆ GetAsFloat()

◆ GetAsInt()

◆ GetAsName()

◆ GetAsNumber()

◆ GetAsRectangle()

◆ GetAsStream()

◆ GetAsString()

◆ GetObjectType()

◆ IsEmpty()

◆ KeySet()

◆ MergeDifferent()

◆ NewInstance()

◆ Put()

◆ PutAll()

◆ ReleaseContent()

◆ Remove()

◆ Size()

◆ Values() [1/2]

◆ Values() [2/2]