PDFObject Class Documentation

classPDFObject : SystemIDisposable

Namespace:Datalogics::PDFL

Inherits from:
SystemIDisposable
Derived classes:
PDFArray, PDFBoolean, PDFDict, PDFInteger, PDFName, PDFReal, PDFStream, PDFString

Detailed Description

Represents the underlying simple data element of an object in 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, such as PDFArray, an indexed array of data elements.

PDFObject is the superclass of these simple objects. A PDFObject cannot be directly instantiated, but any of its subclasses may.

Any PDFObject may be either direct or indirect. A direct object exists within its collection object (such as a PDFArray) and can be referenced only within that collection object. An indirect object exists outside of any collection object and can be referenced by many collection objects.

Referenced by

AxialShadingPatternCalGrayColorSpaceCalRGBColorSpaceColorSpaceDeviceNColorSpaceDocumentFileSpecificationICCBasedColorSpaceIndexedColorSpaceLabColorSpaceNameTreeNamedColorSpaceNumberTreePDFArrayPDFBooleanPDFDictPDFIntegerPDFNamePDFObjectPDFObjectEnumProcPDFRealPDFStreamPDFStringPatternRemoteDestinationSeparationColorSpaceShadingPattern

Constructor & Destructor Documentation

PDFObject

PDFObject(PDFObjectrhs, InternalConstructsignifier)

Parameters

rhs: PDFObject
signifier: InternalConstruct

~PDFObject

~PDFObject()

Property Documentation

Document

DocumentDocument[get]

Generation

intGeneration[get]

ID

intID[get]

Indirect

boolIndirect[get]

PDFHashValue

intPDFHashValue[get]

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 PDFObjectConstructorRetrieve(System.IntPtrignored)

Parameters

ignored: System.IntPtr

Returns:

PDFObject

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

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