Interface DocType

interface DocType {
    addHeaderFooter: (
        headerFooterInfo: HeaderFooterElementInfoType,
    ) => Promise<boolean>;
    addStandardFont: (
        font: string,
        encoding?: FontEncodingType,
    ) => Promise<null | PDFFontType>;
    addWatermark: (watermarkInfo: WatermarkElementInfoType) => Promise<boolean>;
    clearChangeMark: () => Promise<void>;
    close: (options?: CloseOptions) => Promise<boolean>;
    createButtonForm: (
        __namedParameters: {
            name: string;
            pageIndex: number;
            rect: Rect;
            rotate?: number;
        },
    ) => Promise<null | AnnotType>;
    createCheckboxForm: (
        __namedParameters: {
            name: string;
            pageIndex: number;
            rect: Rect;
            rotate?: number;
        },
    ) => Promise<null | AnnotType>;
    createComboxForm: (
        __namedParameters: {
            name: string;
            pageIndex: number;
            rect: Rect;
            rotate?: number;
        },
    ) => Promise<null | AnnotType>;
    createListboxForm: (
        __namedParameters: {
            name: string;
            pageIndex: number;
            rect: Rect;
            rotate?: number;
        },
    ) => Promise<null | AnnotType>;
    createPdfNewPageDict: (
        pageIndex: number,
    ) => Promise<null | PDFDictionaryType>;
    createRadioButtonForm: (
        __namedParameters: {
            name: string;
            pageIndex: number;
            rect: Rect;
            rotate?: number;
        },
    ) => Promise<null | AnnotType>;
    createSignatureForm: (
        __namedParameters: {
            name: string;
            pageIndex: number;
            rect: Rect;
            rotate?: number;
        },
    ) => Promise<null | AnnotType>;
    createTextFieldForm: (
        __namedParameters: {
            name: string;
            pageIndex: number;
            rect: Rect;
            rotate?: number;
        },
    ) => Promise<null | AnnotType>;
    destroy: () => Promise<void>;
    doPrint: () => Promise<void>;
    doPrintSilently: () => Promise<void>;
    doSave: (options: SaveDocOptionType) => Promise<boolean>;
    doSaveAs: () => Promise<void>;
    extractPages: (extraPageArr: number[], savPath: string) => Promise<boolean>;
    getCurrentDocView: () => Promise<null | DocViewType>;
    getCurrentPageIndex: () => Promise<number>;
    getDocView: (viewIndex: number) => Promise<null | DocViewType>;
    getDocViewCount: () => Promise<number>;
    getFileName: () => Promise<string>;
    getInterForm: () => Promise<null | InterFormType>;
    getPage: (index: number) => Promise<null | PageType>;
    getPageCount: () => Promise<number>;
    getPermissions: () => Promise<number>;
    getRoot: () => Promise<null | PDFObjectType>;
    getRootBookmark: () => Promise<null | BookmarkType>;
    getTextSelectTool: () => Promise<null | TextSelectToolType>;
    insertPages: (options: InsertPagesType) => Promise<boolean>;
    isDocModify: () => Promise<boolean>;
    options: Options;
    printPages: (firstPage: number, lastPage: number) => Promise<void>;
    printSetup: () => Promise<void>;
    reloadPage: (pageIndex: number, disableGoto: boolean) => Promise<boolean>;
    removeHeaderFooter: (
        specifyHeaderFooterDicValue: string,
    ) => Promise<boolean>;
    removeWatermark: (specifyWatermarkDicValue: string) => Promise<boolean>;
    replacePages: (__namedParameters: ReplacePagesType) => Promise<boolean>;
    resizePage: (options: ResizePageOptions) => Promise<boolean>;
    savePdf: (
        srcFileName: string,
        flag?: number,
        enable?: boolean,
    ) => Promise<boolean>;
    setChangeMark: () => Promise<void>;
    setPermissions: (permission: number) => Promise<void>;
}

Implemented by

Properties

addHeaderFooter

addHeaderFooter: (
headerFooterInfo: HeaderFooterElementInfoType,
) => Promise<boolean>

在不更新文档视图的情况下添加页眉和页脚。

Type declaration

- (headerFooterInfo: HeaderFooterElementInfoType): Promise<boolean>
- Parameters
  - headerFooterInfo: HeaderFooterElementInfoType
    用于设置页眉和页脚的信息
  Returns Promise<boolean>
  - 如果操作成功则为 TRUE，否则为 FALSE。

addStandardFont

addStandardFont: (
font: string,
encoding?: FontEncodingType,
) => Promise<null | PDFFontType>

将标准字体添加到文档中。

Type declaration

- (font: string, encoding?: FontEncodingType): Promise<null | PDFFontType>
- Parameters
  - font: string
    字体名称。
  - Optionalencoding: FontEncodingType
    字体编码。
  Returns Promise<null | PDFFontType>
  返回一个新的 PDFFont 实例。

addWatermark

addWatermark: (watermarkInfo: WatermarkElementInfoType) => Promise<boolean>

添加水印且不更新文档视图。

Type declaration

- (watermarkInfo: WatermarkElementInfoType): Promise<boolean>
- Parameters
  - watermarkInfo: WatermarkElementInfoType
    用于设置 WatermarkElementInfoType 的信息
  Returns Promise<boolean>
  成功返回 1，失败返回 0

clearChangeMark

clearChangeMark: () => Promise<void>

使所有修改失效。

Type declaration

- (): Promise<void>
- Returns Promise<void>
  - 如果操作成功则为 TRUE，否则为 FALSE。

close

close: (options?: CloseOptions) => Promise<boolean>

关闭文档对象。

Type declaration

- (options?: CloseOptions): Promise<boolean>
- Parameters
  - Optionaloptions: CloseOptions
    关闭参数，默认值：{'promptToSave': true, 'showCancel': true}
  Returns Promise<boolean>
  - 关闭操作的结果

createButtonForm

createButtonForm: (
    __namedParameters: {
        name: string;
        pageIndex: number;
        rect: Rect;
        rotate?: number;
    },
) => Promise<null | AnnotType>

创建一个按钮表单域。

Type declaration

- (
      __namedParameters: {
          name: string;
          pageIndex: number;
          rect: Rect;
          rotate?: number;
      },
  ): Promise<null | AnnotType>
- Parameters
  - __namedParameters: { name: string; pageIndex: number; rect: Rect; rotate?: number }
  Returns Promise<null | AnnotType>
  - 创建的按钮表单域。

Example

const doc = await app.getActiveDoc();
const pageIndex = await doc.getCurrentPageIndex();
const rect = {
    left: 200,
    top: 550,
    right: 300,
    bottom: 500
};
const buttonForm = await doc.createButtonForm({
   pageIndex,
   rect,
   rotate: 0,
   name: 'MyButton'
});
console.log(buttonForm); // Button form field

createCheckboxForm

createCheckboxForm: (
    __namedParameters: {
        name: string;
        pageIndex: number;
        rect: Rect;
        rotate?: number;
    },
) => Promise<null | AnnotType>

创建一个复选框表单域。

Type declaration

- (
      __namedParameters: {
          name: string;
          pageIndex: number;
          rect: Rect;
          rotate?: number;
      },
  ): Promise<null | AnnotType>
- Parameters
  - __namedParameters: { name: string; pageIndex: number; rect: Rect; rotate?: number }
  Returns Promise<null | AnnotType>
  - 创建的复选框表单域。

createComboxForm

createComboxForm: (
    __namedParameters: {
        name: string;
        pageIndex: number;
        rect: Rect;
        rotate?: number;
    },
) => Promise<null | AnnotType>

创建一个组合框表单字段。

Type declaration

- (
      __namedParameters: {
          name: string;
          pageIndex: number;
          rect: Rect;
          rotate?: number;
      },
  ): Promise<null | AnnotType>
- Parameters
  - __namedParameters: { name: string; pageIndex: number; rect: Rect; rotate?: number }
  Returns Promise<null | AnnotType>
  - 创建的组合框表单字段。

Example

const doc = await app.getActiveDoc();
const pageIndex = await doc.getCurrentPageIndex();
const rect = {
    left: 200,
    top: 550,
    right: 300,
    bottom: 500
};
const comboboxForm = await doc.createComboxForm({
    pageIndex,
    rect,
    rotate: 0,
    name: 'MyComboBox'
});
console.log(comboboxForm); // Combobox form field

createListboxForm

createListboxForm: (
    __namedParameters: {
        name: string;
        pageIndex: number;
        rect: Rect;
        rotate?: number;
    },
) => Promise<null | AnnotType>

创建一个列表框表单字段。

Type declaration

- (
      __namedParameters: {
          name: string;
          pageIndex: number;
          rect: Rect;
          rotate?: number;
      },
  ): Promise<null | AnnotType>
- Parameters
  - __namedParameters: { name: string; pageIndex: number; rect: Rect; rotate?: number }
  Returns Promise<null | AnnotType>
  - 创建的列表框表单字段。

Example

const doc = await app.getActiveDoc();
const pageIndex = await doc.getCurrentPageIndex();
const rect = {
    left: 200,
    top: 550,
    right: 300,
    bottom: 500
};
const listboxForm = await doc.createListboxForm({
    pageIndex,
    rect,
    rotate: 0,
    name: 'MyListBox'
});
console.log(listboxForm); // Listbox form field

createPdfNewPageDict

createPdfNewPageDict: (pageIndex: number) => Promise<null | PDFDictionaryType>

创建新页面。

Type declaration

- (pageIndex: number): Promise<null | PDFDictionaryType>
- Parameters
  - pageIndex: number
    新页面的索引位置。
  Returns Promise<null | PDFDictionaryType>
  - 新页面的字典。

createRadioButtonForm

createRadioButtonForm: (
    __namedParameters: {
        name: string;
        pageIndex: number;
        rect: Rect;
        rotate?: number;
    },
) => Promise<null | AnnotType>

创建一个单选按钮表单域。

Type declaration

- (
      __namedParameters: {
          name: string;
          pageIndex: number;
          rect: Rect;
          rotate?: number;
      },
  ): Promise<null | AnnotType>
- Parameters
  - __namedParameters: { name: string; pageIndex: number; rect: Rect; rotate?: number }
  Returns Promise<null | AnnotType>
  - 创建的单选按钮表单域。

Example

const doc = await app.getActiveDoc();
const pageIndex = await doc.getCurrentPageIndex();
const rect = {
   left: 200,
   top: 550,
   right: 300,
   bottom: 500
};
const radioButtonForm = await doc.createRadioButtonForm({
   pageIndex,
   rect,
   rotate: 0,
   name: 'MyRadioButton'
});
console.log(radioButtonForm); // Radio button form field

createSignatureForm

createSignatureForm: (
    __namedParameters: {
        name: string;
        pageIndex: number;
        rect: Rect;
        rotate?: number;
    },
) => Promise<null | AnnotType>

创建一个签名表单域。

Type declaration

- (
      __namedParameters: {
          name: string;
          pageIndex: number;
          rect: Rect;
          rotate?: number;
      },
  ): Promise<null | AnnotType>
- Parameters
  - __namedParameters: { name: string; pageIndex: number; rect: Rect; rotate?: number }
  Returns Promise<null | AnnotType>
  - 创建的签名表单域。

Example

const doc = await app.getActiveDoc();
const pageIndex = await doc.getCurrentPageIndex();
const rect = {
    left: 200,
    top: 550,
    right: 300,
    bottom: 500
};
const signatureForm = await doc.createSignatureForm({
    pageIndex,
    rect,
    rotate: 0,
    name: 'MySignature'
});
console.log(signatureForm); // Signature form field

createTextFieldForm

createTextFieldForm: (
    __namedParameters: {
        name: string;
        pageIndex: number;
        rect: Rect;
        rotate?: number;
    },
) => Promise<null | AnnotType>

创建一个文本字段表单。

Type declaration

- (
      __namedParameters: {
          name: string;
          pageIndex: number;
          rect: Rect;
          rotate?: number;
      },
  ): Promise<null | AnnotType>
- Parameters
  - __namedParameters: { name: string; pageIndex: number; rect: Rect; rotate?: number }
  Returns Promise<null | AnnotType>
  - 创建的文本字段表单。

Example

const doc = await app.getActiveDoc();
const pageIndex = await doc.getCurrentPageIndex();
const rect = {
    left: 200,
    top: 550,
    right: 300,
    bottom: 500
};
const textFieldForm = await doc.createTextFieldForm({
    pageIndex,
    rect,
    rotate: 0,
    name: 'MyTextField'
});
console.log(textFieldForm); // Text field form

destroy

destroy: () => Promise<void>

doPrint

doPrint: () => Promise<void>

打印当前文档。

Type declaration

- (): Promise<void>
- Returns Promise<void>

doPrintSilently

doPrintSilently: () => Promise<void>

执行打印操作，不包含用户对话框。

Type declaration

- (): Promise<void>
- Returns Promise<void>

doSave

doSave: (options: SaveDocOptionType) => Promise<boolean>

保存文档。

Type declaration

- (options: SaveDocOptionType): Promise<boolean>
- Parameters
  - options: SaveDocOptionType
    保存选项对象。
    
    保存文档选项。
    - OptionaldocPDFOptimizer?: boolean
      指示是否启用文档 PDF 优化器。
    - OptionalpromptInfo?: boolean
      指示是否弹出提示信息。
    - OptionalsaveAsTempFile?: boolean
      指示是否将文档保存为临时文件。
    - OptionalshowProgressBar?: boolean
      指示是否显示进度条。
  Returns Promise<boolean>

doSaveAs

doSaveAs: () => Promise<void>

在保存前通过文件对话框提示用户指定保存路径，将文档另存为其他文件。

Type declaration

- (): Promise<void>
- Returns Promise<void>

extractPages

extractPages: (extraPageArr: number[], savPath: string) => Promise<boolean>

从当前文档中提取页面。

Type declaration

- (extraPageArr: number[], savPath: string): Promise<boolean>
- Parameters
  - extraPageArr: number[]
    要提取的页码数组。
  - savPath: string
    用于保存提取后页面的路径。
  Returns Promise<boolean>
  一个 Promise：如果提取操作成功则解析为 true，否则为 false。

getCurrentDocView

getCurrentDocView: () => Promise<null | DocViewType>

获取指定文档当前的 DocView。

Type declaration

- (): Promise<null | DocViewType>
- Returns Promise<null | DocViewType>
  - 当前的 DocView。

getCurrentPageIndex

getCurrentPageIndex: () => Promise<number>

获取当前页索引

Type declaration

- (): Promise<number>
- Returns Promise<number>

getDocView

getDocView: (viewIndex: number) => Promise<null | DocViewType>

获取指定文档的 DocView。

Type declaration

- (viewIndex: number): Promise<null | DocViewType>
- Parameters
  - viewIndex: number
    要获取的 DocView 的索引。
  Returns Promise<null | DocViewType>
  - 指定的 DocView。

getDocViewCount

getDocViewCount: () => Promise<number>

获取指定文档的 DocView 数量。

Type declaration

- (): Promise<number>
- Returns Promise<number>
  - DocView 的数量。

getFileName

getFileName: () => Promise<string>

获取文件名。

Type declaration

- (): Promise<string>
- Returns Promise<string>
  - 文件名。

getInterForm

getInterForm: () => Promise<null | InterFormType>

获取文档的交互式表单。

Type declaration

- (): Promise<null | InterFormType>
- Returns Promise<null | InterFormType>
  - 文档的交互式表单。

getPage

getPage: (index: number) => Promise<null | PageType>

从指定的文档中获取指定的 Page。

Type declaration

- (index: number): Promise<null | PageType>
- Parameters
  - index: number
    页面索引，从 0 开始。
  Returns Promise<null | PageType>
  - 指定的 Page。

getPageCount

getPageCount: () => Promise<number>

获取文档中的页数。

Type declaration

- (): Promise<number>
- Returns Promise<number>
  - 文档的页数。

getPermissions

getPermissions: () => Promise<number>

获取文档的权限。

Type declaration

- (): Promise<number>
- Returns Promise<number>
  文档权限。结果类似：

getRoot

getRoot: () => Promise<null | PDFObjectType>

获取文档的根对象。

Type declaration

- (): Promise<null | PDFObjectType>
- Returns Promise<null | PDFObjectType>
  - 文档的根 PDFObject。

getRootBookmark

getRootBookmark: () => Promise<null | BookmarkType>

获取根书签。

Type declaration

- (): Promise<null | BookmarkType>
- Returns Promise<null | BookmarkType>
  - 根书签。

getTextSelectTool

getTextSelectTool: () => Promise<null | TextSelectToolType>

获取文档的文本选择工具。

Type declaration

- (): Promise<null | TextSelectToolType>
- Returns Promise<null | TextSelectToolType>

insertPages

insertPages: (options: InsertPagesType) => Promise<boolean>

在指定位置将一个文档的页面插入到另一个文档中。

Type declaration

- (options: InsertPagesType): Promise<boolean>
- Parameters
  - options: InsertPagesType
  Returns Promise<boolean>
  一个 Promise，如果插入成功则解析为 true，否则为 false。

isDocModify

isDocModify: () => Promise<boolean>

检查文档是否已被修改。

Type declaration

- (): Promise<boolean>
- Returns Promise<boolean>
  - 如果文档已被修改则为 TRUE，否则为 FALSE。

options

options: Options

printPages

printPages: (firstPage: number, lastPage: number) => Promise<void>

从指定的页范围打印文档。

Type declaration

- (firstPage: number, lastPage: number): Promise<void>
- Parameters
  - firstPage: number
    起始页索引（从 0 开始）
  - lastPage: number
    结束页索引（从 0 开始）
  Returns Promise<void>

printSetup

printSetup: () => Promise<void>

打开当前文档的打印对话框。

Type declaration

- (): Promise<void>
- Returns Promise<void>

reloadPage

reloadPage: (pageIndex: number, disableGoto: boolean) => Promise<boolean>

重新加载指定页面，用于刷新页面视图。

Type declaration

- (pageIndex: number, disableGoto: boolean): Promise<boolean>
- Parameters
  - pageIndex: number
    指定的页面索引。
  - disableGoto: boolean
  Returns Promise<boolean>
  - 如果操作成功则为 TRUE，否则为 FALSE。

removeHeaderFooter

removeHeaderFooter: (specifyHeaderFooterDicValue: string) => Promise<boolean>

在不更新文档视图的情况下移除页眉和页脚。

Type declaration

- (specifyHeaderFooterDicValue: string): Promise<boolean>
- Parameters
  - specifyHeaderFooterDicValue: string
    指定的水印 DictValue
  Returns Promise<boolean>
  - 如果操作成功则为 TRUE，否则为 FALSE。

removeWatermark

removeWatermark: (specifyWatermarkDicValue: string) => Promise<boolean>

移除水印而不更新文档视图。

Type declaration

- (specifyWatermarkDicValue: string): Promise<boolean>
- Parameters
  - specifyWatermarkDicValue: string
    指定的水印字典值
  Returns Promise<boolean>

replacePages

replacePages: (__namedParameters: ReplacePagesType) => Promise<boolean>

异步替换当前 PDF 文档中的页面。

Type declaration

- (__namedParameters: ReplacePagesType): Promise<boolean>
- Parameters
  - __namedParameters: ReplacePagesType
  Returns Promise<boolean>
  一个 Promise，如果替换操作成功则返回 true，否则返回 false。

resizePage

resizePage: (options: ResizePageOptions) => Promise<boolean>

调整页面大小。

Type declaration

- (options: ResizePageOptions): Promise<boolean>
- Parameters
  - options: ResizePageOptions
    调整页面大小的选项
  Returns Promise<boolean>
  表示调整操作是否成功

savePdf

savePdf: (
    srcFileName: string,
    flag?: number,
    enable?: boolean,
) => Promise<boolean>

保存 PDF 文档的数据

Type declaration

- (srcFileName: string, flag?: number, enable?: boolean): Promise<boolean>
- Parameters
  - srcFileName: string
    输出文件名（例如：D:\123.pdf）
  - Optionalflag: number
    保存标志，默认值为 FPD_SAVE_DEFAULT (0)
  - Optionalenable: boolean
    是否启用数据压缩，默认值为 false
  Returns Promise<boolean>
  - 如果操作成功返回 TRUE，否则返回 FALSE。

setChangeMark

setChangeMark: () => Promise<void>

设置修改标志。Reader 有一个内置标志用于指示文档是否已被修改，如果该标志的值有效，文件工具栏上的保存按钮将被启用，否则保存按钮将被禁用。

Type declaration

- (): Promise<void>
- Returns Promise<void>

setPermissions

setPermissions: (permission: number) => Promise<void>

设置文档权限。

Type declaration

- (permission: number): Promise<void>
- Parameters
  - permission: number
    权限值：
    
    DefineConst.FR_PERM_PRINT
    
    DefineConst.FR_PERM_MODIFY_CONTENT
    
    DefineConst.FR_PERM_EXTRACT_COPY
    
    DefineConst.FR_PERM_EXTRACT_ACCESS
    
    DefineConst.FR_PERM_ANNOTATE
    
    DefineConst.FR_PERM_FILL_FORM
    
    DefineConst.FR_PERM_ASSEMBLE
    
    DefineConst.FR_PERM_PRINT_HIGN
  Returns Promise<void>

Interface DocType

Implemented by

Index

Properties

Properties

addHeaderFooter

Type declaration

Parameters

Returns Promise<boolean>

addStandardFont

Type declaration

Parameters

Returns Promise<null | PDFFontType>

addWatermark

Type declaration

Parameters

Returns Promise<boolean>

clearChangeMark

Type declaration

Returns Promise<void>

close

Type declaration

Parameters

Returns Promise<boolean>

createButtonForm

Type declaration

Parameters

Returns Promise<null | AnnotType>

Example

createCheckboxForm

Type declaration

Parameters

Returns Promise<null | AnnotType>

createComboxForm

Type declaration

Parameters

Returns Promise<null | AnnotType>

Example

createListboxForm

Type declaration

Parameters

Returns Promise<null | AnnotType>

Example

createPdfNewPageDict

Type declaration

Parameters

Returns Promise<null | PDFDictionaryType>

createRadioButtonForm

Type declaration

Parameters

Returns Promise<null | AnnotType>

Example

createSignatureForm

Type declaration

Parameters

Returns Promise<null | AnnotType>

Example

createTextFieldForm

Type declaration

Parameters

Returns Promise<null | AnnotType>

Example

destroy

doPrint

Type declaration

Returns Promise<void>

doPrintSilently

Type declaration

Returns Promise<void>

doSave

Type declaration

Parameters

OptionaldocPDFOptimizer?: boolean

OptionalpromptInfo?: boolean

OptionalsaveAsTempFile?: boolean

OptionalshowProgressBar?: boolean

Returns Promise<boolean>

doSaveAs

Type declaration

Returns Promise<void>

`Optional`docPDFOptimizer?: boolean

`Optional`promptInfo?: boolean

`Optional`saveAsTempFile?: boolean

`Optional`showProgressBar?: boolean