Implements

Constructors

  • 不再使用 'new' 来创建,而是使用 create

    Parameters

    • Optionaloptions: Options

      包含必要初始化信息的配置选项。

    Returns Doc

     const doc = await Doc.create();
    

Properties

options: Options

Methods

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

    Parameters

    • watermarkInfo: WatermarkElementInfoType

      用于设置 WatermarkElement 的信息

    Returns Promise<boolean>

    如果操作成功则返回 TRUE,否则返回 false。

  • 使所有修改失效。

    Returns Promise<void>

    • 如果操作成功则为TRUE,否则为 false。
  • 关闭文档对象。

    Parameters

    • options: CloseOptions = ...

      关闭参数,默认值:{'promptToSave': true, 'showCancel': true}

    Returns Promise<boolean>

    • 关闭操作的结果
  • 创建一个按钮表单字段。

    Parameters

    • __namedParameters: { name: string; pageIndex: number; rect: Rect; rotate?: number }

    Returns Promise<null | AnnotType>

    • 创建的按钮表单字段。
    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
  • 创建一个复选框表单字段。

    Parameters

    • __namedParameters: { name: string; pageIndex: number; rect: Rect; rotate?: number }

    Returns Promise<null | AnnotType>

    • 创建的复选框表单字段。
  • 创建一个下拉组合框表单域。

    Parameters

    • __namedParameters: { name: string; pageIndex: number; rect: Rect; rotate?: number }

    Returns Promise<null | AnnotType>

    • 创建的下拉组合框表单域。
    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
  • 创建一个列表框表单域。

    Parameters

    • __namedParameters: { name: string; pageIndex: number; rect: Rect; rotate?: number }

    Returns Promise<null | AnnotType>

    • 创建的列表框表单域。
    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
  • 创建一个单选按钮表单域。

    Parameters

    • __namedParameters: { name: string; pageIndex: number; rect: Rect; rotate?: number }

    Returns Promise<null | AnnotType>

    • 已创建的单选按钮表单域。
    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
  • 创建一个签名表单域。

    Parameters

    • __namedParameters: { name: string; pageIndex: number; rect: Rect; rotate?: number }

    Returns Promise<null | AnnotType>

    • 创建的签名表单域。
    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
  • 创建一个文本字段表单。

    Parameters

    • __namedParameters: { name: string; pageIndex: number; rect: Rect; rotate?: number }

    Returns Promise<null | AnnotType>

    • 创建的文本字段表单。
    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
  • 销毁文档对象。

    Returns Promise<void>

  • 打印当前文档。

    Returns Promise<void>

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

    Returns Promise<void>

  • Saves the document.

    Parameters

    • options: SaveDocOptionType

      The save options object.

      保存文档选项。

      • OptionaldocPDFOptimizer?: boolean

        指示是否启用文档 PDF 优化器。

      • OptionalpromptInfo?: boolean

        指示是否弹出提示信息。

      • OptionalsaveAsTempFile?: boolean

        指示是否将文档保存为临时文件。

      • OptionalshowProgressBar?: boolean

        指示是否显示进度条。

    Returns Promise<boolean>

  • 通过在保存前弹出文件对话框以指定保存路径,将文档另存为另一个文件。

    Returns Promise<void>

  • 从当前文档中提取页面。

    Parameters

    • extraPageArr: number[]

      要提取的页码数组。

    • savPath: string

      用于保存提取后页面的路径。

    Returns Promise<boolean>

    一个 Promise;如果提取操作成功则解析为 true,否则为 false。

    const doc = await app.getActiveDoc();
    const result = await doc.extractPages([0, 1, 2], 'D:\\test\\extract\\extract.pdf');
    console.log(result); // true
  • 获取文件名。

    Returns Promise<string>

    • 文件名。
  • 从指定文档中获取指定的 Page

    Parameters

    • index: number

      页面索引,从 0 开始。

    Returns Promise<null | PageType>

  • 获取文档中的页数。

    Returns Promise<number>

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

    Parameters

    Returns Promise<boolean>

    一个 Promise:插入成功时解析为 true,否则为 false

  • 检查文档是否已被修改。

    Returns Promise<boolean>

    • 如果文档已被修改则返回 TRUE,否则返回 false。
  • 从指定页范围打印文档

    Parameters

    • firstPage: number

      起始页索引(从 0 开始)

    • lastPage: number

      结束页索引(从 0 开始)

    Returns Promise<void>

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

    Returns Promise<void>

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

    Parameters

    • pageIndex: number

      指定的页面索引。

    • disableGoto: boolean = false

      是否阻止跳转到指定的页面视图。默认设置为 FALSE。

    Returns Promise<boolean>

    • 如果操作成功返回 TRUE,否则返回 FALSE。
  • 在不更新文档视图的情况下移除页眉和页脚。

    Parameters

    • specifyHeaderFooterDicValue: string

      指定的水印 DictValue

    Returns Promise<boolean>

    • 如果操作成功则返回 TRUE,否则返回 false。
  • 在不更新文档视图的情况下移除水印。

    Parameters

    • specifyWatermarkDicValue: string

      指定的水印字典值

    Returns Promise<boolean>

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

    Parameters

    Returns Promise<boolean>

    一个 Promise,如果替换操作成功则解析为 true,否则为 false。

  • 保存 PDF 文档的数据。

    Parameters

    • srcFileName: string

      输出文件名(例如:D:\123.pdf)

    • flag: number = DefineConst.FPD_SAVE_DEFAULT

      保存标志,默认值为 FPD_SAVE_DEFAULT(0)

    • enable: boolean = false

      是否启用数据压缩,默认值为 false

    Returns Promise<boolean>

    • 如果操作成功则返回 TRUE,否则返回 FALSE。
  • 设置修改标志。阅读器有一个内置标志用于指示文档是否已被修改, 如果该标志的值有效,文件工具栏上的保存按钮将启用,否则保存按钮将 禁用。

    Returns Promise<void>

  • 创建一个 PDF 文档。

    Parameters

    • Optionaloptions: Options

      包含必要初始化信息的配置选项。

    Returns Promise<DocType>

    • 一个 PDF 文档对象。
     const doc = await Doc.create();