PDFString Class Documentation

classPDFString : 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

NameTreePDFString

Constructor & Destructor Documentation

PDFString

PDFString(PDFStringrhs, InternalConstructsignifier)

Parameters

rhs: PDFString
signifier: InternalConstruct

PDFString

PDFString(stringvalue, Documentdoc, boolindirect, boolstoredAsHex)

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

PDFString(stringvalue, Documentdoc, boolindirect, boolstoredAsHex, boolstoredAsUTF16)

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

PDFString(stringvalue, PDFObjectdocFromObj, boolindirect, boolstoredAsHex)

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

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

PDFString(stringvalue, PDFObjectdocFromObj, boolindirect, boolstoredAsHex, boolstoredAsUTF16)

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

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

PDFString(System.Byte[]value, Documentdoc, boolindirect, boolstoredAsHex)

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

PDFString(System.Byte[]value, PDFObjectdocFromObj, boolindirect, boolstoredAsHex)

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

Bytes

System.Byte[]Bytes[get]

Document

DocumentDocument[get]

Generation

intGeneration[get]

ID

intID[get]

Indirect

boolIndirect[get]

PDFHashValue

intPDFHashValue[get]

StoredAsHex

boolStoredAsHex[get]

Value

stringValue[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 new static PDFStringConstructorRetrieve(System.IntPtrignored)

Parameters

ignored: System.IntPtr

Returns:

new static PDFString

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