Class Doc

constructor

• new Doc(options?: Options): Doc

  No longer use 'new' to create, but use create instead.

  Parameters

  • Optionaloptions: Options

    Configuration options containing necessary initialization information.

  Returns Doc

  Example

   const doc = await Doc.create();
  Copy

options

addHeaderFooter

• addHeaderFooter(headerFooterInfo: HeaderFooterElementInfoType): Promise<boolean>

  Add header and footer without updating document view.

  Parameters

  • headerFooterInfo: HeaderFooterElementInfoType

    Information for setting headers and footers

  Returns Promise<boolean>

  • TRUE if the operation is successful, otherwise not.

addStandardFont

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

  Add standard font to document.

  Parameters

  • font: string

    The name of the font.
  • Optionalencoding: FontEncodingType

    The font encoding.

  Returns Promise<null | PDFFontType>

  Returns a new PDFFont instance.

addWatermark

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

  Add watermark without updating document view.

  Parameters

  • watermarkInfo: WatermarkElementInfoType

    Information for setting the WatermarkElement

  Returns Promise<boolean>

  TRUE if the operation is successful, otherwise not.

  See

clearChangeMark

• clearChangeMark(): Promise<void>

  Invalidates all modification.

  Returns Promise<void>

  • TRUE if the operation is successful, otherwise not.

close

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

  Closes the doc object.

  Parameters

  • options: CloseOptions = ...

    Close parameters, default values: {'promptToSave': true, 'showCancel': true}

  Returns Promise<boolean>

  • Result of the close operation

createButtonForm

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

  Creates a button form field.

  Parameters

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

  Returns Promise<null | AnnotType>

  • The created button form field.

  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
  Copy

createCheckboxForm

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

  Creates a checkbox form field.

  Parameters

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

  Returns Promise<null | AnnotType>

  • The created checkbox form field.

createComboxForm

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

  Creates a combobox form field.

  Parameters

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

  Returns Promise<null | AnnotType>

  • The created combobox form field.

  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
  Copy

createListboxForm

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

  Creates a listbox form field.

  Parameters

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

  Returns Promise<null | AnnotType>

  • The created listbox form field.

  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
  Copy

createPdfNewPageDict

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

  Create a new page.

  Parameters

  • pageIndex: number

    The index position of the new page.

  Returns Promise<null | PDFDictionaryType>

  • The new page Dictionary.

createRadioButtonForm

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

  Creates a radio button form field.

  Parameters

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

  Returns Promise<null | AnnotType>

  • The created radio button form field.

  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
  Copy

createSignatureForm

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

  Creates a signature form field.

  Parameters

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

  Returns Promise<null | AnnotType>

  • The created signature form field.

  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
  Copy

createTextFieldForm

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

  Creates a text field form.

  Parameters

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

  Returns Promise<null | AnnotType>

  • The created text field form.

  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
  Copy

destroy

• destroy(): Promise<void>

  Destroys the document object.

  Returns Promise<void>

doPrint

• doPrint(): Promise<void>

  print the current document.

  Returns Promise<void>

doPrintSilently

• doPrintSilently(): Promise<void>

  Performs the print operation, not including user dialog box.

  Returns Promise<void>

doSave

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

  Saves the document.

  Parameters

  • options: SaveDocOptionType

    The save options object.

    Save document options.

    • OptionaldocPDFOptimizer?: boolean

      Indicates whether to enable the document PDF optimizer.

    • OptionalpromptInfo?: boolean

      Indicates whether to prompt information.

    • OptionalsaveAsTempFile?: boolean

      Indicates whether to save the document as a temporary file.

    • OptionalshowProgressBar?: boolean

      Indicates whether to display the progress bar.

  Returns Promise<boolean>

doSaveAs

• doSaveAs(): Promise<void>

  Saves the document as another file by prompting a file dialog box to specify the saving path before saving.

  Returns Promise<void>

extractPages

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

  Extracts pages from the current document.

  Parameters

  • extraPageArr: number[]

    An array of page numbers to extract.
  • savPath: string

    The path to save the extracted pages.

  Returns Promise<boolean>

  A Promise that resolves to true if the extraction operation is successful, otherwise false.

  Example

  const doc = await app.getActiveDoc();
  const result = await doc.extractPages([0, 1, 2], 'D:\\test\\extract\\extract.pdf');
  console.log(result); // true
  Copy

getCurrentDocView

• getCurrentDocView(): Promise<null | DocViewType>

  Get current document view

  Returns Promise<null | DocViewType>

  • The current DocView.

getCurrentPageIndex

• getCurrentPageIndex(): Promise<number>

  Get the current page index

  Returns Promise<number>

getDocView

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

  Gets the specified DocView for specified document.

  Parameters

  • viewIndex: number

    The index of the DocView to get.

  Returns Promise<null | DocViewType>

  • The specified DocView.

getDocViewCount

• getDocViewCount(): Promise<number>

  Gets the number of DocView for specified document.

  Returns Promise<number>

  • The number of DocView.

getFileName

• getFileName(): Promise<string>

  Gets the filename.

  Returns Promise<string>

  • The filename.

getInterForm

• getInterForm(): Promise<null | InterFormType>

  Gets the interactive form of the document.

  Returns Promise<null | InterFormType>

  • The interactive form of the document.

getPage

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

  Gets the specified Page from specified document.

  Parameters

  • index: number

    The page index, starting from 0.

  Returns Promise<null | PageType>

  • The specified Page.

getPageCount

• getPageCount(): Promise<number>

  Get the number of pages in the document.

  Returns Promise<number>

  • The number of pages in the document.

getPermissions

• getPermissions(): Promise<number>

  Gets permissions of a document.

  Returns Promise<number>

  The document permissions. Result like

  • DefineConst.FPD_PERM_PRINT
  • DefineConst.FPD_PERM_MODIFY
  • DefineConst.FPD_PERM_EXTRACT
  • DefineConst.FPD_PERM_ANNOT_FORM
  • DefineConst.FPD_PERM_FILL_FORM

getRoot

• getRoot(): Promise<null | PDFObjectType>

  Gets the root object of the document.

  Returns Promise<null | PDFObjectType>

  • The root PDFObject of the document.

getRootBookmark

• getRootBookmark(): Promise<null | BookmarkType>

  Get root bookmark

  Returns Promise<null | BookmarkType>

  • The root bookmark.

getTextSelectTool

• getTextSelectTool(): Promise<null | TextSelectToolType>

  Gets the text select tool for the document.

  Returns Promise<null | TextSelectToolType>

insertPages

• insertPages(__namedParameters: InsertPagesType): Promise<boolean>

  Insert pages from one document into another at a specified position.

  Parameters

  • __namedParameters: InsertPagesType

  Returns Promise<boolean>

  A promise that resolves to true if the insertion was successful, otherwise false.

isDocModify

• isDocModify(): Promise<boolean>

  Checks whether the document is modified.

  Returns Promise<boolean>

  • TRUE if the document is modified, otherwise not.

printPages

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

  Print document from specific page range

  Parameters

  • firstPage: number

    Starting page index (0-based)
  • lastPage: number

    Ending page index (0-based)

  Returns Promise<void>

printSetup

• printSetup(): Promise<void>

  Open the print dialog for the current document.

  Returns Promise<void>

reloadPage

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

  Reloads the specified page, used to refresh page view.

  Parameters

  • pageIndex: number

    The specified page index.
  • disableGoto: boolean = false

    Whether to prevent going to the specified page view. Sets it FALSE as default.

  Returns Promise<boolean>

  • TRUE if the operation is successful, otherwise not.

removeHeaderFooter

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

  Remove header and footer without updating document view.

  Parameters

  • specifyHeaderFooterDicValue: string

    Specified watermark DictValue

  Returns Promise<boolean>

  • TRUE if the operation is successful, otherwise not.

removeWatermark

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

  Remove watermark without updating document view.

  Parameters

  • specifyWatermarkDicValue: string

    Specified watermark Dictionary Value

  Returns Promise<boolean>

replacePages

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

  Asynchronously replaces pages in the current PDF document.

  Parameters

  • __namedParameters: ReplacePagesType

  Returns Promise<boolean>

  A Promise that resolves to true if the replacement operation is successful, otherwise false.

resizePage

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

  Resize page.

  Parameters

  • options: ResizePageOptions

    Options for resizing the page

  Returns Promise<boolean>

  Indicates whether the resize operation was successful

savePdf

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

  Save the data of a PDF document.

  Parameters

  • srcFileName: string

    Output file name (e.g., D:\123.pdf)
  • flag: number = DefineConst.FPD_SAVE_DEFAULT

    Save flag, default is FPD_SAVE_DEFAULT (0)
  • enable: boolean = false

    Whether to enable data compression, default is false

  Returns Promise<boolean>

  • TRUE if the operation is successful, otherwise not.

setChangeMark

• setChangeMark(): Promise<void>

  Sets the modify flag. Reader has a built-in flag that indicate whether a document has been modified, if the value of the flag is valid, the Save button on File toolbar is enable, otherwise the Save button is disable.

  Returns Promise<void>

setPermissions

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

  Set document permissions

  Parameters

  • permission: number

    Permission value :

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

Staticcreate

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

  Creates a PDF document.

  Parameters

  • Optionaloptions: Options

    Configuration options containing necessary initialization information.

  Returns Promise<DocType>

  • A PDF document object.

  Example

   const doc = await Doc.create();
  Copy