PDFString Class

class PDFString : PDFObject

Namespace:Datalogics::PDFL

Inherits from:: PDFObject

Detailed Description

Represents an array of unsigned bytes within a PDF document.

A PDFString is a single data element that represents an array of unsigned bytes. It may be inserted into any collection object. PDFString may be a string of human readable text, but this is not required, and it may be stored either as characters or as hex values.

Referenced by

NameTree

Uses types

Document PDFObject PDFObjectComparison PDFObjectEnumProc

Constructor & Destructor Documentation

PDFString(string value, Document doc, bool indirect, bool storedAsHex)

Parameters

value: string: String stored in this PDFString
doc: Document: Document object containing this PDFString
indirect: bool: flag marking this as an indirect PDFObject
storedAsHex: bool: flag indicating this PDFString should be stored as hex values

String constructor

The provided string value is a Unicode string object. If it only contains characters within the PDFDocEncoding character set, it will be stored in that encoding; otherwise it will be stored in the document as UTF-16BE.

PDFString(string value, Document doc, bool indirect, bool storedAsHex, bool storedAsUTF16)

Parameters

value: string: String stored in this PDFString
doc: Document: Document object containing this PDFString
indirect: bool: flag marking this as an indirect PDFObject
storedAsHex: bool: flag indicating this PDFString should be stored as hex values
storedAsUTF16: bool: flag indicating this PDFString should be stored as UTF-16BE, even if it could be encoded as PDFDocEncoding

String constructor

The provided string value is a Unicode string object. If storedAsUTF16 is true, it will be stored in the document at UTF-16BE. Otherwise it will be stored as PDFDocEncoding if it only contains characters within the PDFDocEncoding character set, else it will be stored as UTF-16BE.

PDFString(string value, PDFObject docFromObj, bool indirect, bool storedAsHex)

Parameters

value: string: String stored in this PDFString
docFromObj: PDFObject: The new PDFString will be created in the same document as this object.
indirect: bool: flag marking this as an indirect PDFObject
storedAsHex: bool: flag indicating this PDFString should be stored as hex values

String constructor

PDFString(string value, PDFObject docFromObj, bool indirect, bool storedAsHex, bool storedAsUTF16)

Parameters

value: string: String stored in this PDFString
docFromObj: PDFObject: The new PDFString will be created in the same document as this object.
indirect: bool: flag marking this as an indirect PDFObject
storedAsHex: bool: flag indicating this PDFString should be stored as hex values
storedAsUTF16: bool: flag indicating this PDFString should be stored as UTF-16BE, even if it could be encoded as PDFDocEncoding

String constructor

PDFString(System.Byte[] value, Document doc, bool indirect, bool storedAsHex)

Parameters

value: System.Byte[]: Array of bytes stored in this PDFString
doc: Document: Document object containing this PDFString
indirect: bool: flag marking this as an indirect PDFObject
storedAsHex: bool: flag indicating this PDFString should be stored as hex values

General constructor

PDFString(System.Byte[] value, PDFObject docFromObj, bool indirect, bool storedAsHex)

Parameters

value: System.Byte[]: Array of bytes stored in this PDFString
docFromObj: PDFObject: The new PDFString will be created in the same document as this object.
indirect: bool: flag marking this as an indirect PDFObject
storedAsHex: bool: flag indicating this PDFString should be stored as hex values

General constructor

Property Documentation

System.Byte[] Bytes[get]

The raw byte array of this PDFString.

This method returns the raw data of the PDFString, without respect to any encoding. It should be used when the contents of the object represent data instead of human readable text, or when direct access to the underlying data is required.

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

bool StoredAsHex[get]

Indicates that the data is stored as hexadecimal values.

string Value[get]

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

override string ToString()

Returns:

override string

A string describing this PDFString.

Returns a string representation of this PDFString.

The string includes the object's indirect status, value, and hex storage flag.