Interface PDFDictionaryType

interface PDFDictionaryType {
    addReference: (
        key: string,
        doc: DocType,
        objNum: number,
    ) => Promise<void>;
    addValue: (key: string, obj: AddValueObjType) => Promise<void>;
    destroy: () => Promise<void>;
    getArray: (key: string) => Promise<null | PDFArrayType>;
    getBoolean: (key: string, defaultBool?: boolean) => Promise<boolean>;
    getCount: () => Promise<number>;
    getDict: (key: string) => Promise<null | PDFDictionaryType>;
    getElement: (key: string) => Promise<null | PDFObjectType>;
    getElementValue: (key: string) => Promise<null | PDFObjectType>;
    getFloat: (key: string) => Promise<number>;
    getInteger: (key: string, defaultInt: number) => Promise<number>;
    getInteger64: (key: string) => Promise<number>;
    getMatrix: (key: string) => Promise<Matrix>;
    getName: (key: string) => Promise<null | PDFObjectType>;
    getNumber: (key: string) => Promise<number>;
    getRect: (key: string) => Promise<Rect>;
    getString: (key: string) => Promise<string>;
    getUnicodeText: (key: string) => Promise<string>;
    isIdentical: (otherDict: PDFDictionaryType) => Promise<boolean>;
    keyExist: (key: string) => Promise<boolean>;
    options: Options;
    removeAt: (key: string) => Promise<void>;
    replaceKey: (oldKey: string, newKey: string) => Promise<void>;
    setAt: (key: string, obj: PDFObjectType, doc: DocType) => Promise<void>;
    setAtBoolean: (key: string, bool: boolean) => Promise<void>;
    setAtInteger: (key: string, num: number) => Promise<void>;
    setAtMatrix: (key: string, matrix: Matrix) => Promise<void>;
    setAtName: (key: string, name: string) => Promise<void>;
    setAtNumber: (key: string, num: number) => Promise<void>;
    setAtRect: (key: string, rect: Rect) => Promise<void>;
    setAtReference2ToDoc: (
        key: string,
        doc: DocType,
        obj: PDFObjectType,
    ) => Promise<void>;
    setAtReferenceToDoc: (
        key: string,
        doc: DocType,
        objNum: number,
    ) => Promise<void>;
    setAtString: (key: string, str: string) => Promise<void>;
    setNewAt: (
        key: string,
        objectType: number,
    ) => Promise<null | PDFObjectType>;
    getStartPosition(): Promise<null | POSITION>;
}

Implemented by

Properties

addReference addValue destroy getArray getBoolean getCount getDict getElement getElementValue getFloat getInteger getInteger64 getMatrix getName getNumber getRect getString getUnicodeText isIdentical keyExist options removeAt replaceKey setAt setAtBoolean setAtInteger setAtMatrix setAtName setAtNumber setAtRect setAtReference2ToDoc setAtReferenceToDoc setAtString setNewAt

Methods

getStartPosition

Properties

addReference

addReference: (key: string, doc: DocType, objNum: number) => Promise<void>

为由 key 指定的元素添加一个引用对象。

Type declaration

    • (key: string, doc: DocType, objNum: number): Promise<void>

    • Parameters

      • key: string

        输入的键字符串。

      • doc: DocType

        输入的文档对象。

      • objNum: number

        引用对象所指向的对象编号。

      Returns Promise<void>

addValue

addValue: (key: string, obj: AddValueObjType) => Promise<void>

向字典中添加一个新的键值对。

Type declaration

    • (key: string, obj: AddValueObjType): Promise<void>

    • Parameters

      • key: string

        输入的键字符串。

      • obj: AddValueObjType

        输入的值对象。

      Returns Promise<void>

destroy

destroy: () => Promise<void>

销毁当前对象。

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

getArray

getArray: (key: string) => Promise<null | PDFArrayType>

获取由键指定的数组对象。

Type declaration

    • (key: string): Promise<null | PDFArrayType>

    • Parameters

      • key: string

        输入的键字符串。

      Returns Promise<null | PDFArrayType>

      返回由键指定的数组对象。

getBoolean

getBoolean: (key: string, defaultBool?: boolean) => Promise<boolean>

获取由 key 指定的元素的布尔值。

Type declaration

    • (key: string, defaultBool?: boolean): Promise<boolean>

    • Parameters

      • key: string

        输入的键字符串。

      • OptionaldefaultBool: boolean

        默认布尔值。默认值为 false。

      Returns Promise<boolean>

      返回由 key 指定的元素的布尔值。

getCount

getCount: () => Promise<number>

获取字典中的元素数量。

Type declaration

    • (): Promise<number>

    • Returns Promise<number>

      返回字典中元素的数量。

getDict

getDict: (key: string) => Promise<null | PDFDictionaryType>

获取由键指定的字典对象。

Type declaration

    • (key: string): Promise<null | PDFDictionaryType>

    • Parameters

      • key: string

        输入的键字符串。

      Returns Promise<null | PDFDictionaryType>

      返回由键指定的字典对象。

getElement

getElement: (key: string) => Promise<null | PDFObjectType>

获取指定索引处的对象。

Type declaration

    • (key: string): Promise<null | PDFObjectType>

    • Parameters

      • key: string

        要获取的索引。

      Returns Promise<null | PDFObjectType>

      返回指定索引处的对象。

getElementValue

getElementValue: (key: string) => Promise<null | PDFObjectType>

返回直接对象或被引用的间接对象。

Type declaration

    • (key: string): Promise<null | PDFObjectType>

    • Parameters

      • key: string

        输入的键字符串。

      Returns Promise<null | PDFObjectType>

      返回直接对象或被引用的间接对象。

getFloat

getFloat: (key: string) => Promise<number>

获取浮点数值。

Type declaration

    • (key: string): Promise<number>

    • Parameters

      • key: string

        输入的键字符串。

      Returns Promise<number>

      返回由 key 指定元素的浮点数值。

getInteger

getInteger: (key: string, defaultInt: number) => Promise<number>

获取由键指定的元素的整数值。

Type declaration

    • (key: string, defaultInt: number): Promise<number>

    • Parameters

      • key: string

        输入的键字符串。

      • defaultInt: number

        默认整数值。

      Returns Promise<number>

      返回由键指定的元素的整数值。

getInteger64

getInteger64: (key: string) => Promise<number>

获取由指定键对应元素的 64 位整数值。

Type declaration

    • (key: string): Promise<number>

    • Parameters

      • key: string

        输入的键字符串。

      Returns Promise<number>

      返回由指定键对应元素的 64 位整数值。

getMatrix

getMatrix: (key: string) => Promise<Matrix>

获取由指定键标识的元素的矩阵值。

Type declaration

    • (key: string): Promise<Matrix>

    • Parameters

      • key: string

        输入的键字符串。

      Returns Promise<Matrix>

      返回由指定键标识的元素的矩阵值。

getName

getName: (key: string) => Promise<null | PDFObjectType>

获取由指定 key 对应的名称对象。

Type declaration

    • (key: string): Promise<null | PDFObjectType>

    • Parameters

      • key: string

        输入的 key 字符串。

      Returns Promise<null | PDFObjectType>

      返回由指定 key 对应的名称对象。

getNumber

getNumber: (key: string) => Promise<number>

获取由指定键对应的元素的数值。

Type declaration

    • (key: string): Promise<number>

    • Parameters

      • key: string

        输入的键字符串。

      Returns Promise<number>

      返回由指定键对应的元素的数值。

getRect

getRect: (key: string) => Promise<Rect>

获取由指定键对应的元素的矩形值。

Type declaration

    • (key: string): Promise<Rect>

    • Parameters

      • key: string

        输入的键字符串。

      Returns Promise<Rect>

      返回由指定键对应的元素的矩形值。

getString

getString: (key: string) => Promise<string>

获取由指定键对应的字符串对象。

Type declaration

    • (key: string): Promise<string>

    • Parameters

      • key: string

        输入的键字符串。

      Returns Promise<string>

      返回由指定键对应的字符串对象。

getUnicodeText

getUnicodeText: (key: string) => Promise<string>

获取由 key 指定元素的 Unicode 文本。

Type declaration

    • (key: string): Promise<string>

    • Parameters

      • key: string

        输入的 key 字符串。

      Returns Promise<string>

      返回由 key 指定元素的 Unicode 文本。

isIdentical

isIdentical: (otherDict: PDFDictionaryType) => Promise<boolean>

将当前值与另一个对象进行比较。

Type declaration

    • (otherDict: PDFDictionaryType): Promise<boolean>

    • Parameters

      Returns Promise<boolean>

      如果两个对象相同则返回 true，否则返回 false。

keyExist

keyExist: (key: string) => Promise<boolean>

检查字典中是否存在该键。

Type declaration

    • (key: string): Promise<boolean>

    • Parameters

      • key: string

        输入的键字符串。

      Returns Promise<boolean>

      如果键在字典中存在则返回 true，否则返回 false。

options

options: Options

removeAt

removeAt: (key: string) => Promise<void>

移除由键指定的元素。

Type declaration

    • (key: string): Promise<void>

    • Parameters

      • key: string

        输入的键字符串。

      Returns Promise<void>

replaceKey

replaceKey: (oldKey: string, newKey: string) => Promise<void>

将由 key 指定的元素的键替换为新的键字符串。

Type declaration

    • (oldKey: string, newKey: string): Promise<void>

    • Parameters

      • oldKey: string

        旧的键字符串。

      • newKey: string

        新的键字符串。

      Returns Promise<void>

setAt

setAt: (key: string, obj: PDFObjectType, doc: DocType) => Promise<void>

设置元素数据。

Type declaration

    • (key: string, obj: PDFObjectType, doc: DocType): Promise<void>

    • Parameters

      • key: string

        输入的键字符串。

      • obj: PDFObjectType

        输入的元素数据，类型为 PDFObjectType。

      • doc: DocType

        输入的文档对象。

      Returns Promise<void>

setAtBoolean

setAtBoolean: (key: string, bool: boolean) => Promise<void>

为由键指定的元素设置布尔对象的布尔值。

Type declaration

    • (key: string, bool: boolean): Promise<void>

    • Parameters

      • key: string

        输入的键字符串。

      • bool: boolean

        布尔值。

      Returns Promise<void>

setAtInteger

setAtInteger: (key: string, num: number) => Promise<void>

为由键指定的元素设置一个 32 位整数的数字对象。

Type declaration

    • (key: string, num: number): Promise<void>

    • Parameters

      • key: string

        输入的键字符串。

      • num: number

        数值。

      Returns Promise<void>

setAtMatrix

setAtMatrix: (key: string, matrix: Matrix) => Promise<void>

为由 key 指定的元素设置矩阵对象。

Type declaration

    • (key: string, matrix: Matrix): Promise<void>

    • Parameters

      • key: string

        输入的键字符串。

      • matrix: Matrix

        输入的矩阵对象。

      Returns Promise<void>

setAtName

setAtName: (key: string, name: string) => Promise<void>

为由 key 指定的元素设置名称对象字符串。

Type declaration

    • (key: string, name: string): Promise<void>

    • Parameters

      • key: string

        输入的键字符串。

      • name: string

        名称字符串。

      Returns Promise<void>

setAtNumber

setAtNumber: (key: string, num: number) => Promise<void>

为由键指定的元素设置一个数字对象。

Type declaration

    • (key: string, num: number): Promise<void>

    • Parameters

      • key: string

        输入的键字符串。

      • num: number

        数字值。

      Returns Promise<void>

setAtRect

setAtRect: (key: string, rect: Rect) => Promise<void>

为由 key 指定的元素设置矩形区域。

Type declaration

    • (key: string, rect: Rect): Promise<void>

    • Parameters

      • key: string

        输入的键字符串。

      • rect: Rect

        输入的矩形对象。

      Returns Promise<void>

setAtReference2ToDoc

setAtReference2ToDoc: (
    key: string,
    doc: DocType,
    obj: PDFObjectType,
) => Promise<void>

为由 key 指定的元素设置引用对象。

Type declaration

    • (key: string, doc: DocType, obj: PDFObjectType): Promise<void>

    • Parameters

      • key: string

        输入的键字符串。

      • doc: DocType

        输入的文档对象。

      • obj: PDFObjectType

        引用对象所指向的对象。

      Returns Promise<void>

setAtReferenceToDoc

setAtReferenceToDoc: (
    key: string,
    doc: DocType,
    objNum: number,
) => Promise<void>

为由 key 指定的元素设置引用对象。

Type declaration

    • (key: string, doc: DocType, objNum: number): Promise<void>

    • Parameters

      • key: string

        输入的键字符串。

      • doc: DocType

        输入的文档对象。

      • objNum: number

        引用对象所指向的对象编号。

      Returns Promise<void>

setAtString

setAtString: (key: string, str: string) => Promise<void>

为由键指定的元素设置字符串或字符串对象。

Type declaration

    • (key: string, str: string): Promise<void>

    • Parameters

      • key: string

        输入的键字符串。

      • str: string

        字符串值。

      Returns Promise<void>

setNewAt

setNewAt: (key: string, objectType: number) => Promise<null | PDFObjectType>

根据 object_type 分配并在指定位置设置对象元素。

Type declaration

    • (key: string, objectType: number): Promise<null | PDFObjectType>

    • Parameters

      • key: string

        输入的键字符串。

      • objectType: number

        对象类型。如下面所示：

        • DefineConst.FPD_OBJ_INVALID
        • DefineConst.FPD_OBJ_BOOLEAN
        • DefineConst.FPD_OBJ_NUMBER
        • DefineConst.FPD_OBJ_STRING
        • DefineConst.FPD_OBJ_NAME
        • DefineConst.FPD_OBJ_ARRAY
        • DefineConst.FPD_OBJ_DICTIONARY
        • DefineConst.FPD_OBJ_STREAM
        • DefineConst.FPD_OBJ_NULL
        • DefineConst.FPD_OBJ_REFERENCE

      Returns Promise<null | PDFObjectType>

Methods

getStartPosition

  • getStartPosition(): Promise<null | POSITION>

    获取间接对象的起始位置。

    Returns Promise<null | POSITION>

    返回间接对象的起始位置。

Settings

Member Visibility

On This Page

Properties
Methods