PDFDict Class Documentation

classPDFDict : PDFObject

Namespace:Datalogics::PDFL

Inherits from:
PDFObject

Detailed Description

Represents an associative collection of data elements within a PDF document.

All objects in a PDF document are built from a collection of simpler objects that represent fundamental datatypes like numbers, strings and arrays. PDFObject and its subclasses allow direct access and manipulation of these simple objects. Some subclasses represent single data elements, such as PDFInteger, which represents a single integer value. Other subclasses represent a collection of PDFObjects, like PDFArray, an indexed array of data elements.

A PDFDict is a heterogenous collection object that maps other PDFObjects (including other PDFDicts) to PDFName objects.

Referenced by

ActionAnnotationBookmarkCircleAnnotationContainerDeviceNColorSpaceDocumentExtendedGraphicStateFontFreeTextAnnotationGoToActionHighlightAnnotationInkAnnotationLaunchActionLineAnnotationLinkAnnotationNameTreeNumberTreeOptionalContentConfigOptionalContentGroupPDFDictPDFStreamPagePolyLineAnnotationPolygonAnnotationRedactionRemoteGoToActionSquareAnnotationTextMarkupAnnotationURIActionUnderlineAnnotation

Constructor & Destructor Documentation

PDFDict

PDFDict(PDFDictrhs, InternalConstructsignifier)

Parameters

rhs: PDFDict
signifier: InternalConstruct

PDFDict

PDFDict(Documentdoc, boolindirect)

Parameters

doc: Document

Document object containing this PDFDict

indirect: bool

flag marking this as an indirect PDFObject

General constructor

PDFDict

PDFDict(PDFObjectdocFromObj, boolindirect)

Parameters

docFromObj: PDFObject

The new PDFArray will be created in the same document as this object.

indirect: bool

flag marking this as an indirect PDFObject

General constructor

Property Documentation

Document

DocumentDocument[get]

Generation

intGeneration[get]

ID

intID[get]

Indirect

boolIndirect[get]

Keys

System.Collections.Generic.IList< PDFObject >Keys[get]

PDFHashValue

intPDFHashValue[get]

XMPMetadata

stringXMPMetadata[get, set]

Member Function Documentation

Clone

PDFObjectClone()

Returns:

PDFObject

Makes a new copy of this PDFObject in memory, in the same document and using same direct/indirect setting as this PDFObject.

Clone

PDFObjectClone(Documentdoc)

Parameters

doc: Document

Returns:

PDFObject

Makes a new copy of this PDFObject in memory, in the supplied document, using the same direct/indirect setting as this PDFObject.

Clone

PDFObjectClone(Documentdoc, boolindirect)

Parameters

doc: Document
indirect: bool

Returns:

PDFObject

Makes a new copy of this PDFObject in memory, in the supplied document, using supplied direct/indirect setting.

Clone

PDFObjectClone(PDFObjectobj)

Parameters

obj: PDFObject

Returns:

PDFObject

Makes a new copy of this PDFObject in memory, in the same document as another object, using the same direct/indirect setting as this PDFObject.

Clone

PDFObjectClone(PDFObjectobj, boolindirect)

Parameters

obj: PDFObject
indirect: bool

Returns:

PDFObject

Makes a new copy of this PDFObject in memory, in the same document as another object, using supplied direct/indirect setting.

CompareTo

PDFObjectComparisonCompareTo(PDFObjectrhs)

Parameters

rhs: PDFObject

the other PDFObject to compare.

Returns:

A PDFObjectComparison value that relates this object to the rhs object

Compares this object to another object. The result is useful for ordering or sorting PDFObjects. No other significance should be attached to the result. In particular, an unequal result indicates nothing about the type of either object.

The result is valid only within a single instance of the document.

ConstructorRetrieve

static new static PDFDictConstructorRetrieve(System.IntPtrignored)

Parameters

ignored: System.IntPtr

Returns:

new static PDFDict

Contains

boolContains(PDFNamekey)

Parameters

key: PDFName

A PDFName for the key

Returns:

true if the given key exists

Tests whether the given key exists in the dictionary

Contains

boolContains(stringkey)

Parameters

key: string

A string representing the name for the key

Returns:

true if the given key exists

Tests whether the given key exists in the dictionary

Destroy

voidDestroy()

Returns:

void

Destroys this object.

This method does nothing if this object is a direct scalar object.

If a composite object (an array, dictionary or stream) is destroyed:

All the direct objects in it are automatically destroyed.

The indirect objects in it are not destroyed.

Dispose

voidDispose()

Returns:

void

DisposeChildren

voidDisposeChildren()

Returns:

void

EnumPDFObjects

boolEnumPDFObjects(PDFObjectEnumProcenumProc)

Parameters

enumProc: PDFObjectEnumProc

A user-supplied callback to call for each element of the object. of obj. Neither proc nor any routine called by proc may modify the object. Doing so can produce undefined results or errors. For example, if the object is an array, enumProc must not call Remove(); if the object is a dictionary, enumProc must not call Put().

Returns:

Returns true if every call to enumProc returned true. As soon as any call to enumProc returns false, the enumeration stops and EnumPDFObject() returns false.

Enumerates the elements of a PDFObject by calling a user-supplied procedure for each component of the object.

For scalars or strings, the proc is not called, and CosObjEnum() returns true.

For dictionaries, proc is called for each key-value pair. The order in which the key-value pairs are enumerated is undefined.

For arrays, proc is called with each element as the first paramater to proc, and the NULL object as the second parameter. Array elements are enumerated in ascending order of index.

For streams, proc is called once, with the stream's dictionary as the first parameter to the proc and the NULL object as the second parameter.

Equals

override boolEquals(objectobj)

Parameters

obj: object

Returns:

override bool

Get

PDFObjectGet(PDFNamekey)

Parameters

key: PDFName

A PDFName for the key

Returns:

A PDFObject matching the key

Returns the object matching the given key.

Get

PDFObjectGet(stringkey)

Parameters

key: string

A string representing the name for the key

Returns:

A PDFObject matching the key

Returns the object matching the given key string.

Put

voidPut(PDFNamekey, PDFObjectobj)

Parameters

key: PDFName

A PDFName for the key

obj: PDFObject

A PDFObject to add to the dictionary

Returns:

void

Puts an object with the matching key into the dictionary, adding the entry if the key is not already present.

Put

voidPut(stringkey, PDFObjectobj)

Parameters

key: string

A string representing the name for the key

obj: PDFObject

A PDFObject to add to the dictionary

Returns:

void

Puts an object with the matching key string into the dictionary, adding the entry if the key is not already present.

Remove

voidRemove(PDFNamekey)

Parameters

key: PDFName

A PDFName for the key

Returns:

void

Removes a key/object pair from the dictionary.

Remove

voidRemove(stringkey)

Parameters

key: string

A string representing the name for the key

Returns:

void

Removes a key/object pair from the dictionary.

SameTypeEquals

boolSameTypeEquals(PDFObjectarg0)

Parameters

arg0: PDFObject

Returns:

bool

ToString

override stringToString()

Returns:

override string

fromCPtr

static PDFObjectfromCPtr(System.IntPtrfromCPtrParm)

Parameters

fromCPtrParm: System.IntPtr

Returns:

PDFObject