PDFArray Class Documentation
classPDFArray : PDFObjectNamespace:Datalogics::PDFL
- Inherits from:
PDFObject
Detailed Description
Represents an array 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. For example, PDFInteger represents a single integer value. Others represent a collection of PDFObjects, like PDFArray, an indexed array of data elements.
A PDFArray is a heterogenous collection object that gathers other PDFObjects (including other PDFArrays) into an indexed list.
Constructor & Destructor Documentation
PDFArray
PDFArray(PDFArrayrhs, InternalConstructsignifier)Parameters
rhs: PDFArraysignifier: InternalConstruct
PDFArray
PDFArray(Documentdoc, boolindirect)Parameters
doc: DocumentDocument object containing this PDFArray
indirect: boolflag marking this as an indirect PDFObject
General constructor
PDFArray
PDFArray(PDFObjectdocFromObj, boolindirect)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
DocumentDocument[get]Generation
intGeneration[get]ID
intID[get]Indirect
boolIndirect[get]Length
intLength[get]PDFHashValue
intPDFHashValue[get]Member Function Documentation
Add
voidAdd(PDFObjectobject_)Parameters
object_: PDFObject
Returns:
voidAdds an object to the end of the array
Clone
PDFObjectClone()Returns:
PDFObjectMakes a new copy of this PDFObject in memory, in the same document and using same direct/indirect setting as this PDFObject.
Clone
Parameters
doc: Document
Returns:
PDFObjectMakes a new copy of this PDFObject in memory, in the supplied document, using the same direct/indirect setting as this PDFObject.
Clone
Parameters
doc: Documentindirect: bool
Returns:
PDFObjectMakes a new copy of this PDFObject in memory, in the supplied document, using supplied direct/indirect setting.
Clone
Parameters
obj: PDFObject
Returns:
PDFObjectMakes 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: PDFObjectindirect: bool
Returns:
PDFObjectMakes 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: PDFObjectthe other PDFObject to compare.
Returns:
A PDFObjectComparison value that relates this object to the rhs objectCompares 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 PDFArrayConstructorRetrieve(System.IntPtrignored)Parameters
ignored: System.IntPtr
Returns:
new static PDFArrayDestroy
voidDestroy()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
voidDispose()Returns:
voidDisposeChildren
voidDisposeChildren()Returns:
voidEnumPDFObjects
boolEnumPDFObjects(PDFObjectEnumProcenumProc)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:
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 boolGet
PDFObjectGet(intindex)Parameters
index: int
Returns:
PDFObjectReturns the object at the given index.
Insert
voidInsert(intindex, PDFObjectobject_)Parameters
index: intobject_: PDFObject
Returns:
voidInserts an object at the given index, displacing existing objects. All objects following this will have their index increased by one.
Put
voidPut(intindex, PDFObjectobj)Parameters
index: intobj: PDFObject
Returns:
voidPuts an object at the given index, replacing the existing item. The index can be greater than the current length of the array; the array will be extended and the empty slots filled with null objects.
Remove
voidRemove(PDFObjectobject_)Parameters
object_: PDFObject
Returns:
voidRemoves the first object that matches the given object. The length of the array is reduced by 1.
RemoveAt
voidRemoveAt(intindex)Parameters
index: int
Returns:
voidRemoves the object at the given index. The length of the array is reduced by 1.
SameTypeEquals
boolSameTypeEquals(PDFObjectarg0)Parameters
arg0: PDFObject
Returns:
boolToString
override stringToString()Returns:
override stringfromCPtr
static PDFObjectfromCPtr(System.IntPtrfromCPtrParm)Parameters
fromCPtrParm: System.IntPtr