Represents a PDF dictionary object. More...

Inheritance diagram for PdfSharp.Pdf.PdfDictionary:

Classes
class	DictionaryElements
	Represents the interface to the elements of a PDF dictionary. More...

class	PdfStream
	The PDF stream objects. More...

Public Member Functions
	PdfDictionary ()
	Initializes a new instance of the PdfDictionary class. More...

	PdfDictionary (PdfDocument document)
	Initializes a new instance of the PdfDictionary class. More...

new PdfDictionary	Clone ()
	Creates a copy of this dictionary. Direct values are deep copied. Indirect references are not modified. More...

IEnumerator	GetEnumerator ()
	Returns an enumerator that iterates through a collection. More...

override string	ToString ()
	Returns a string with the content of this object in a readable form. Useful for debugging purposes only. More...

PdfStream	CreateStream (byte[] value)
	Creates the stream of this dictionary and initializes it with the specified byte array. The function must not be called if the dictionary already has a stream. More...

Public Member Functions inherited from PdfSharp.Pdf.PdfObject
new PdfObject	Clone ()
	Creates a copy of this object. The clone does not belong to a document, i.e. its owner and its iref are null. More...

Public Member Functions inherited from PdfSharp.Pdf.PdfItem
PdfItem	Clone ()
	Creates a copy of this object. More...

Protected Member Functions
	PdfDictionary (PdfDictionary dict)
	Initializes a new instance from an existing dictionary. Used for object type transformation. More...

override object	Copy ()
	This function is useful for importing objects from external documents. The returned object is not yet complete. irefs refer to external objects and directed objects are cloned but their document property is null. A cloned dictionary or array needs a 'fix-up' to be a valid object. More...

Protected Member Functions inherited from PdfSharp.Pdf.PdfObject
	PdfObject ()
	Initializes a new instance of the PdfObject class. More...

	PdfObject (PdfDocument document)
	Initializes a new instance of the PdfObject class. More...

	PdfObject (PdfObject obj)
	Initializes a new instance from an existing object. Used for object type transformation. More...

override object	Copy ()
	Implements the copy mechanism. Must be overridden in derived classes. More...

Protected Attributes
DictionaryElements	elements
	The elements of the dictionary. More...

Properties
DictionaryElements	Elements `[get]`
	Gets the hashtable containing the elements of this dictionary. More...

PdfStream	Stream `[get, set]`
	Gets or sets the PDF stream belonging to this dictionary. Returns null if the dictionary has no stream. To create the stream, call the CreateStream function. More...

Properties inherited from PdfSharp.Pdf.PdfObject
virtual PdfDocument	Owner `[get]`
	Gets the PdfDocument this object belongs to. More...

bool	IsIndirect `[get]`
	Indicates whether the object is an indirect object. More...

PdfObjectInternals	Internals `[get]`
	Gets the PdfInternals object of this document, that grants access to some internal structures which are not part of the public interface of PdfDocument. More...

PdfReference	Reference `[get, set]`
	Gets the indirect reference of this object. If the value is null, this object is a direct object. More...

Detailed Description

Represents a PDF dictionary object.

Constructor & Destructor Documentation

◆ PdfDictionary() [1/3]

PdfSharp.Pdf.PdfDictionary.PdfDictionary ( )

Initializes a new instance of the PdfDictionary class.

◆ PdfDictionary() [2/3]

PdfSharp.Pdf.PdfDictionary.PdfDictionary ( PdfDocument document )

Initializes a new instance of the PdfDictionary class.

Parameters

document The document.

◆ PdfDictionary() [3/3]

PdfSharp.Pdf.PdfDictionary.PdfDictionary ( PdfDictionary dict )

protected

Initializes a new instance from an existing dictionary. Used for object type transformation.

Member Function Documentation

◆ Clone()

new PdfDictionary PdfSharp.Pdf.PdfDictionary.Clone ( )

Creates a copy of this dictionary. Direct values are deep copied. Indirect references are not modified.

◆ Copy()

override object PdfSharp.Pdf.PdfDictionary.Copy ( )

protectedvirtual

This function is useful for importing objects from external documents. The returned object is not yet complete. irefs refer to external objects and directed objects are cloned but their document property is null. A cloned dictionary or array needs a 'fix-up' to be a valid object.

Reimplemented from PdfSharp.Pdf.PdfItem.

◆ CreateStream()

PdfStream PdfSharp.Pdf.PdfDictionary.CreateStream ( byte[] value )

Creates the stream of this dictionary and initializes it with the specified byte array. The function must not be called if the dictionary already has a stream.

◆ GetEnumerator()

IEnumerator PdfSharp.Pdf.PdfDictionary.GetEnumerator ( )

Returns an enumerator that iterates through a collection.

◆ ToString()

override string PdfSharp.Pdf.PdfDictionary.ToString ( )

Returns a string with the content of this object in a readable form. Useful for debugging purposes only.

Member Data Documentation

◆ elements

DictionaryElements PdfSharp.Pdf.PdfDictionary.elements

protected

The elements of the dictionary.

Property Documentation

◆ Elements

DictionaryElements PdfSharp.Pdf.PdfDictionary.Elements

get

Gets the hashtable containing the elements of this dictionary.

◆ Stream

PdfStream PdfSharp.Pdf.PdfDictionary.Stream

getset

Gets or sets the PDF stream belonging to this dictionary. Returns null if the dictionary has no stream. To create the stream, call the CreateStream function.

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

PdfSharp.Pdf/PdfDictionary.cs

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Properties