Class PDFObject

constructor

• new PDFObject(options?: Options): PDFObject

  创建一个 PDFObject 实例。 请使用 create 来创建实例，而不是通过 new 模式创建实例。

  Parameters

  • Optionaloptions: Options

    使用指定的选项创建一个 PDFObject 实例。

  Returns PDFObject

  Example

  const pdObject = await PDFObject.create();
  Copy

options

destroy

• destroy(): Promise<void>

  销毁 pdfObject。

  Returns Promise<void>

  当对象被销毁时 resolve 的 Promise。

getArray

• getArray(): Promise<null | PDFObjectType>

  获取对象的数组。

  Returns Promise<null | PDFObjectType>

  一个解析为 PDFObject 实例的 Promise。

getConstString

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

  获取对象的常量字符串。

  Parameters

  • Optionalobj: PDFObjectType

    要从中获取常量字符串的对象。

  Returns Promise<string>

  一个 Promise，解析为该对象的常量字符串。

getDict

• getDict(): Promise<null | PDFObjectType>

  获取对象的字典。

  Returns Promise<null | PDFObjectType>

  一个解析为 PDFObject 实例的 Promise。

getDirect

• getDirect(): Promise<null | PDFObjectType>

  检索对象的直接引用。

  Returns Promise<null | PDFObjectType>

  一个解析为 PDFObject 实例的 Promise。

getDirectType

• getDirectType(): Promise<number>

  获取对象的直接类型。

  Returns Promise<number>

  一个 Promise，解析为表示对象直接类型的数字。

getInteger

• getInteger(): Promise<number>

  获取对象的整数值。

  Returns Promise<number>

  一个 Promise，解析为对象的整数值。

getNumber

• getNumber(): Promise<number>

  获取对象的数值。

  Returns Promise<number>

  一个 Promise，解析为对象的数值。

getObjNum

• getObjNum(): Promise<number>

  获取对象编号。

  Returns Promise<number>

  一个 Promise，解析为表示对象编号的数字。

getString

• getString(): Promise<string>

  获取对象的字符串表示形式。

  Returns Promise<string>

  一个 Promise，解析为表示该对象的字符串。

getType

• getType(): Promise<number>

  获取对象的类型。

  Returns Promise<number>

  一个 Promise，解析为一个数字，表示对象类型，为 FPD_OBJ_xxxx 常量之一。
  包括：

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

  获取对象的 Unicode 文本。

  Returns Promise<string>

  一个解析为对象 Unicode 文本的 Promise。

isIdentical

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

  判断当前对象是否与另一个对象完全相同。

  Parameters

  • otherObj: PDFObjectType

    用于比较的另一个 PDFObject 实例。

  Returns Promise<boolean>

  一个 Promise，解析为一个布尔值，表示这两个对象是否完全相同。

isModified

• isModified(): Promise<boolean>

  确定对象是否已被修改。

  Returns Promise<boolean>

  一个 Promise，解析为一个布尔值，指示对象是否已被修改。

setModified

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

  设置对象是否已被修改。

  Parameters

  • Optionalmodified: boolean = false

    对象是否已被修改。默认为 false。

  Returns Promise<void>

  在修改状态设置完成时解析的 Promise。

setUnicodeText

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

  将 Unicode 文本设置到对象中。

  Parameters

  • str: string

    要设置的字符串。

  Returns Promise<void>

  当文本设置完成时解析的 Promise。

Staticcreate

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

  创建一个 PDFObject 实例。

  Parameters

  • Optionaloptions: Options

    创建所需的配置选项，包含必要的初始化信息。

  Returns Promise<PDFObjectType>

  一个解析为 PDFObject 实例的 Promise。