PDFDict Class Documentation
class PDFDict : PDFObjectNamespace: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
Constructor & Destructor Documentation
PDFDict
PDFDict(Document doc, bool indirect)Parameters
doc: DocumentDocument object containing this PDFDict
indirect: boolflag marking this as an indirect PDFObject
General constructor
PDFDict
PDFDict(PDFObject docFromObj, bool indirect)Parameters
docFromObj: PDFObjectThe new PDFArray will be created in the same document as this object.
indirect: boolflag marking this as an indirect PDFObject
General constructor
Property Documentation
Document
Document Document[get]Generation
int Generation[get]ID
int ID[get]Indirect
bool Indirect[get]Keys
System.Collections.Generic.IList< PDFObject > Keys[get]PDFHashValue
int PDFHashValue[get]XMPMetadata
string XMPMetadata[get, set]Member Function Documentation
Clone
PDFObject Clone()Returns:
PDFObjectA new PDFObject that is a copy of this object.
Makes a new copy of this PDFObject in memory, in the same document and using same direct/indirect setting as this PDFObject.
Clone
Parameters
doc: DocumentThe target document in which to create the copy.
Returns:
PDFObjectA new PDFObject that is a copy of this object in the specified document.
Makes a new copy of this PDFObject in memory, in the supplied document, using the same direct/indirect setting as this PDFObject.
Clone
Parameters
doc: DocumentThe target document in which to create the copy.
indirect: boolIf true, the copy will be an indirect object; if false, it will be direct.
Returns:
PDFObjectA new PDFObject that is a copy of this object in the specified document.
Makes a new copy of this PDFObject in memory, in the supplied document, using supplied direct/indirect setting.
Clone
Parameters
obj: PDFObjectThe reference object whose document will be used for the copy.
Returns:
PDFObjectA new PDFObject that is a copy of this object in the same document as obj.
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
Parameters
obj: PDFObjectThe reference object whose document will be used for the copy.
indirect: boolIf true, the copy will be an indirect object; if false, it will be direct.
Returns:
PDFObjectA new PDFObject that is a copy of this object in the same document as obj.
Makes a new copy of this PDFObject in memory, in the same document as another object, using supplied direct/indirect setting.
CompareTo
PDFObjectComparison CompareTo(PDFObject rhs)Parameters
rhs: PDFObjectthe other PDFObject to compare.
Returns:
PDFObjectComparisonA 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.
Contains
bool Contains(PDFName key)Parameters
key: PDFNameA PDFName for the key
Returns:
booltrue if the given key exists
Tests whether the given key exists in the dictionary
Contains
bool Contains(string key)Parameters
key: stringA string representing the name for the key
Returns:
booltrue if the given key exists
Tests whether the given key exists in the dictionary
Destroy
void Destroy()Returns:
voidDestroys 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
void Dispose()Returns:
voidEnumPDFObjects
bool EnumPDFObjects(PDFObjectEnumProc enumProc)Parameters
enumProc: PDFObjectEnumProcA 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:
boolReturns 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 bool Equals(object obj)Parameters
obj: object
Returns:
override boolGet
Parameters
key: PDFNameA PDFName for the key
Returns:
PDFObjectA PDFObject matching the key
Returns the object matching the given key.
Get
PDFObject Get(string key)Parameters
key: stringA string representing the name for the key
Returns:
PDFObjectA PDFObject matching the key
Returns the object matching the given key string.
Put
Parameters
Returns:
voidPuts an object with the matching key into the dictionary, adding the entry if the key is not already present.
Put
void Put(string key, PDFObject obj)Parameters
key: stringA string representing the name for the key
obj: PDFObjectA PDFObject to add to the dictionary
Returns:
voidPuts an object with the matching key string into the dictionary, adding the entry if the key is not already present.
Remove
void Remove(PDFName key)Parameters
key: PDFNameA PDFName for the key
Returns:
voidRemoves a key/object pair from the dictionary.
Remove
void Remove(string key)Parameters
key: stringA string representing the name for the key
Returns:
voidRemoves a key/object pair from the dictionary.
ToString
override string ToString()Returns:
override stringA string describing this PDFDict and its properties.
Returns a string representation of this PDFDict.