Class PDFObject

constructor

• new PDFObject(options?: Options): PDFObject

  Create a PDFObject instance. Instead of creating an instance in new mode, use create to create an instance.

  Parameters

  • Optionaloptions: Options

    Create a PDFObject instance with the specified options.

  Returns PDFObject

  Example

  const pdObject = await PDFObject.create();
  Copy

options

destroy

• destroy(): Promise<void>

  Destroys the pdfObject.

  Returns Promise<void>

  A promise that resolves when the object is destroyed.

getArray

• getArray(): Promise<null | PDFObjectType>

  Retrieves the array of the object.

  Returns Promise<null | PDFObjectType>

  A promise that resolves to a PDFObject instance.

getConstString

• getConstString(obj?: PDFObjectType): Promise<string>

  Retrieves the constant string of the object.

  Parameters

  • Optionalobj: PDFObjectType

    The object from which to retrieve the constant string.

  Returns Promise<string>

  A promise that resolves to the constant string of the object.

getDict

• getDict(): Promise<null | PDFObjectType>

  Retrieves the dictionary of the object.

  Returns Promise<null | PDFObjectType>

  A promise that resolves to a PDFObject instance.

getDirect

• getDirect(): Promise<null | PDFObjectType>

  Retrieves the direct reference of the object.

  Returns Promise<null | PDFObjectType>

  A promise that resolves to a PDFObject instance.

getDirectType

• getDirectType(): Promise<number>

  Retrieves the direct type of the object.

  Returns Promise<number>

  A promise that resolves to a number representing the direct type of the object.

getInteger

• getInteger(): Promise<number>

  Retrieves the integer value of the object.

  Returns Promise<number>

  A promise that resolves to the integer value of the object.

getNumber

• getNumber(): Promise<number>

  Retrieves the numeric value of the object.

  Returns Promise<number>

  A promise that resolves to the numeric value of the object.

getObjNum

• getObjNum(): Promise<number>

  Retrieves the object number.

  Returns Promise<number>

  A promise that resolves to a number representing the object's number.

getString

• getString(): Promise<string>

  Retrieves the string representation of the object.

  Returns Promise<string>

  A promise that resolves to a string representing the object.

getType

• getType(): Promise<number>

  Retrieves the type of the object.

  Returns Promise<number>

  A promise that resolves to a number representing the object type which is one of the FPD_OBJ_xxxx constants.
  including:

  • DefineConst.FPD_OBJ_INVALID = 0
  • DefineConst.FPD_OBJ_BOOLEAN = 1
  • DefineConst.FPD_OBJ_NUMBER = 2
  • DefineConst.FPD_OBJ_STRING = 3
  • DefineConst.FPD_OBJ_NAME = 4
  • DefineConst.FPD_OBJ_ARRAY = 5
  • DefineConst.FPD_OBJ_DICTIONARY = 6
  • DefineConst.FPD_OBJ_STREAM = 7
  • DefineConst.FPD_OBJ_NULL = 8
  • DefineConst.FPD_OBJ_REFERENCE = 9

getUnicodeText

• getUnicodeText(): Promise<string>

  Retrieves the Unicode text of the object.

  Returns Promise<string>

  A promise that resolves to the Unicode text of the object.

isIdentical

• isIdentical(otherObj: PDFObjectType): Promise<boolean>

  Determines if the current object is identical to another object.

  Parameters

  • otherObj: PDFObjectType

    Another PDFObject instance to compare with.

  Returns Promise<boolean>

  A promise that resolves to a boolean indicating whether the two objects are identical.

isModified

• isModified(): Promise<boolean>

  Determines if the object has been modified.

  Returns Promise<boolean>

  A promise that resolves to a boolean indicating whether the object has been modified.

setModified

• setModified(modified?: boolean): Promise<void>

  Sets whether the object has been modified.

  Parameters

  • Optionalmodified: boolean = false

    Whether the object has been modified. Defaults to false.

  Returns Promise<void>

  A promise that resolves when the modification status is set.

setUnicodeText

• setUnicodeText(str: string): Promise<void>

  Sets the Unicode text to the object.

  Parameters

  • str: string

    The string to set.

  Returns Promise<void>

  A promise that resolves when the text is set.

Staticcreate

• create(options?: Options): Promise<PDFObjectType>

  Creates a PDFObject instance.

  Parameters

  • Optionaloptions: Options

    The configuration options required for creation, containing necessary initialization information.

  Returns Promise<PDFObjectType>

  A promise that resolves to a PDFObject instance.