PDFArray Class

class PDFArray : PDFObject

Namespace: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.

Referenced by

Document OptionalContentMembershipDict PDFStream ViewDestination

Uses types

Document PDFObject PDFObjectComparison PDFObjectEnumProc

Constructor & Destructor Documentation

PDFArray(Document doc, bool indirect)

Parameters

doc: Document: Document object containing this PDFArray
indirect: bool: flag marking this as an indirect PDFObject

General constructor

PDFArray(PDFObject docFromObj, bool indirect)

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 Document[get]

The Document of which this object is a member.

Returns null if the Document is not known by PDFL, or if it is a temporary document.

If the Document is not null, then it shares the same internal data with other Document objects that refer to the same file. Document objects returned this way do not contribute to the internal count that keeps the Document open, and will become invalid if the main reference to the document is disposed.

int Generation[get]

The generation number for this object.

Only indirect objects have a generation number.

Exceptions

ApplicationException: direct objects do not have a generation number.

int ID[get]

The ID number for this object.

Only indirect objects have an ID number.

Exceptions

ApplicationException: direct objects do not have an ID number.

bool Indirect[get]

Indicates if this object is indirect or direct.

int Length[get]

The number of elements in this array.

int PDFHashValue[get]

The 32-bit hash value for this object.

The hash value is used internally to quickly access the object, and is not generally useful for PDFObject users. Note that two PDFObjects with equal hash values are not necessarily equal; use Equals() to check for equality.

Member Function Documentation

void Add(PDFObject object_)

Parameters

object_: PDFObject

Returns:

void

Adds an object to the end of the array

rhs: PDFObject: the other PDFObject to compare.

Returns:

PDFObjectComparison

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.

void Destroy()

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.

void Dispose()

Returns:

void

bool EnumPDFObjects(PDFObjectEnumProc enumProc)

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:

bool

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.

override bool Equals(object obj)

Parameters

obj: object

Returns:

override bool

PDFObject Get(int index)

Parameters

index: int: the position of the object to retrieve.

Returns:

PDFObject

Returns the object at the given index.

void Insert(int index, PDFObject object_)

Parameters

index: int: the position at which to insert.
object_: PDFObject

Returns:

void

Inserts an object at the given index, displacing existing objects. All objects following this will have their index increased by one.

void Put(int index, PDFObject obj)

Parameters

index: int: the position at which to place the object.
obj: PDFObject: the object to place at the given index.

Returns:

void

Puts 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.

void Remove(PDFObject object_)

Parameters

object_: PDFObject

Returns:

void

Removes the first object that matches the given object. The length of the array is reduced by 1.

void RemoveAt(int index)

Parameters

index: int: the position of the object to remove.

Returns:

void

Removes the object at the given index. The length of the array is reduced by 1.

override string ToString()

Returns:

override string