Interface AppType

interface AppType {
    close: (options?: CloseOptions) => Promise<boolean>;
    createBlankDoc: (width: number, height: number) => Promise<null | DocType>;
    getActiveDoc: () => Promise<null | DocType>;
    getActiveTool: () => Promise<null | ToolType>;
    getAppDataPath: () => Promise<string>;
    getAppTitle: () => Promise<string>;
    getDoc: (index: number) => Promise<null | DocType>;
    getDocsCount: () => Promise<number>;
    getName: () => Promise<string>;
    getRibbonBar: (parentWnd: LPVOIDType) => Promise<null | RibbonBarType>;
    getToolByName: (toolName: string) => Promise<null | ToolType>;
    getVersion: () => Promise<string>;
    isTaskPanelShow: () => Promise<boolean>;
    loadGraphicObjectAddon: () => Promise<boolean>;
    openFileFromUrl: (
        __namedParameters: {
            fileTransferCallbacks: FileTransferCallbacksType;
            headers?: Options;
            password?: string;
            url: string;
        },
    ) => Promise<void>;
    openFromFile: (options: OpenFromFileOptions) => Promise<null | DocType>;
    options: AppOptions;
    pluginInfo: PluginInfoType;
    registerDocHandlerOfPDDoc: (
        docEventCallbacks: DocEventCallbacksType,
    ) => Promise<boolean>;
    registerForContextMenuAddition: (
        name: string,
        menus: MenusType,
    ) => Promise<boolean>;
    registerPageObjectSelectionHandler: (
        callbacks: PageObjectSelectionCallbacksType,
    ) => Promise<null | LPVOIDType>;
    registerRectangleHandler: (
        callbacks: ToolJsCallbacksType,
    ) => Promise<null | LPVOIDType>;
    registerSelectionHandler: (
        callbacks: SelectionJsCallbacksType,
    ) => Promise<null | LPVOIDType>;
    selectOpenFile: (filter: string, multi: boolean) => Promise<string[]>;
    setActiveDoc: (doc: DocType) => Promise<boolean>;
    setActiveDocByIndex: (index: number) => Promise<boolean>;
    setActiveTool: (tool: ToolType, persistent: boolean) => Promise<boolean>;
    showTaskPanel: (show: boolean) => Promise<void>;
    unRegisterPageObjectSelectionHandler: (
        selectionHandler: LPVOIDType,
    ) => Promise<boolean>;
    unRegisterRectangleHandler: (toolHandler: LPVOIDType) => Promise<boolean>;
    unRegisterSelectionHandler: (
        selectionHandler: LPVOIDType,
    ) => Promise<boolean>;
}

Implemented by

PluginApp

Properties

close

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

Close the current active document.

Type declaration

- (options?: CloseOptions): Promise<boolean>
- Parameters
  - Optionaloptions: CloseOptions
    Close options, the defalut value is {promptToSave: true, showCancel: true}
  Returns Promise<boolean>
  If close the document successfully, return true, otherwise return false.

createBlankDoc

createBlankDoc: (width: number, height: number) => Promise<null | DocType>

Creates a blank document.

Type declaration

- (width: number, height: number): Promise<null | DocType>
- Parameters
  - width: number
    The width of the page in the blank document.
  - height: number
    The height of the page in the blank document.
  Returns Promise<null | DocType>
  The blank document.

getActiveDoc

getActiveDoc: () => Promise<null | DocType>

Gets the top-most document which for displaying PDF file type.

Type declaration

- (): Promise<null | DocType>
- Returns Promise<null | DocType>
  Returns the document that is currently active.

getActiveTool

getActiveTool: () => Promise<null | ToolType>

Get the active tool.

Type declaration

- (): Promise<null | ToolType>
- Returns Promise<null | ToolType>
  Returns the active tool instance.

getAppDataPath

getAppDataPath: () => Promise<string>

Get the path of the current application.

Type declaration

- (): Promise<string>
- Returns Promise<string>
  The path of the current application.

getAppTitle

getAppTitle: () => Promise<string>

Get the title of the current application.

Type declaration

- (): Promise<string>
- Returns Promise<string>
  The title of the current application.

getDoc

getDoc: (index: number) => Promise<null | DocType>

Gets the document by specified index.

Type declaration

- (index: number): Promise<null | DocType>
- Parameters
  - index: number
    The index of the document. This value can be iterated through from getDocsCount.
  Returns Promise<null | DocType>
  Get the document by specified index.

getDocsCount

getDocsCount: () => Promise<number>

The number of documents currently open.

Type declaration

- (): Promise<number>
- Returns Promise<number>
  Returns the currently open document number.

getName

getName: () => Promise<string>

Get the name of the current application.

Type declaration

- (): Promise<string>
- Returns Promise<string>
  Get the name of the application. It will be "Foxit PhantomPDF" or "Foxit Reader".

getRibbonBar

getRibbonBar: (parentWnd: LPVOIDType) => Promise<null | RibbonBarType>

Get the ribbon bar of the application.

Type declaration

- (parentWnd: LPVOIDType): Promise<null | RibbonBarType>
- Parameters
  - parentWnd: LPVOIDType
    The parent window of the ribbon bar.
  Returns Promise<null | RibbonBarType>
  Returns the ribbon bar of the application.

getToolByName

getToolByName: (toolName: string) => Promise<null | ToolType>

Get a tool by name.

Type declaration

- (toolName: string): Promise<null | ToolType>
- Parameters
  - toolName: string
    The name of the tool.
  Returns Promise<null | ToolType>
  Returns the tool instance.

getVersion

getVersion: () => Promise<string>

Get the version of the current application.

Type declaration

- (): Promise<string>
- Returns Promise<string>
  Get the version of the application.

isTaskPanelShow

isTaskPanelShow: () => Promise<boolean>

Get the task pane show status.

Type declaration

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

loadGraphicObjectAddon

loadGraphicObjectAddon: () => Promise<boolean>

Load the graphic object addon.

Type declaration

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

openFileFromUrl

openFileFromUrl: (
    __namedParameters: {
        fileTransferCallbacks: FileTransferCallbacksType;
        headers?: Options;
        password?: string;
        url: string;
    },
) => Promise<void>

Open a PDF document from a URL.

Type declaration

- (
      __namedParameters: {
          fileTransferCallbacks: FileTransferCallbacksType;
          headers?: Options;
          password?: string;
          url: string;
      },
  ): Promise<void>
- Parameters
  - __namedParameters: {
        fileTransferCallbacks: FileTransferCallbacksType;
        headers?: Options;
        password?: string;
        url: string;
    }
  Returns Promise<void>

Example

await app.openFileFromUrl({
    url: 'https://www.example.com/test.pdf',
    password: '123456',
    headers: {
        'Authorization': 'Bearer 1234567890',
        'cookie': 'name=value; name2=value2'
    },
    fileTransferCallbacks: {
        onProgress: (clientData, progress) => {
            console.log(`onProgress: ${progress}`);
       },
       onResult: (clientData, result, message) => {
           console.log(`onResult: ${result}, ${message}`);
      }
   }
});

openFromFile

openFromFile: (options: OpenFromFileOptions) => Promise<null | DocType>

Open a PDF document by OpenFromFileOptions.

Type declaration

- (options: OpenFromFileOptions): Promise<null | DocType>
- Parameters
  - options: OpenFromFileOptions
    The options of opening a PDF document.
  Returns Promise<null | DocType>

Example

await app.openFromFile({
     'fileSrc': './InsertText.pdf',
     'password': '',
     'makeVisible': true,
     'addToMRU': true,
})

options

options: AppOptions

pluginInfo

pluginInfo: PluginInfoType

registerDocHandlerOfPDDoc

registerDocHandlerOfPDDoc: (
docEventCallbacks: DocEventCallbacksType,
) => Promise<boolean>

Registers a user-supplied event handler to document window.

Type declaration

- (docEventCallbacks: DocEventCallbacksType): Promise<boolean>
- Parameters
  - docEventCallbacks: DocEventCallbacksType
    The callback set. Reader will call a corresponding callback when the doc event occurs
  Returns Promise<boolean>
  TRUE means successful, otherwise not.

registerForContextMenuAddition

registerForContextMenuAddition: (
name: string,
menus: MenusType,
) => Promise<boolean>

Type declaration

- (name: string, menus: MenusType): Promise<boolean>
- Parameters
  - name: string
    Appends the type name of the right-click menu. Like: "Page","Annot","Select"
  - menus: MenusType
    The menu items of the context menu.
  Returns Promise<boolean>
  If register the context menu successfully, return true, otherwise return false.

Example

const contextMenuAdditionJs = {
   menuItems:  [
      {
        index: 0,
        icon: '',
        title: 'menu1',
        name: 'menu1',
        tooltip: 'menu1',
        describeText: 'menu1',
        isSeparator: false,
        executeProc: () => {
            console.log('Execute proc');
        },
        isEnable: true
      }
  ]}
await app.registerForContextMenuAddition('Page', contextMenuAdditionJs);

registerPageObjectSelectionHandler

registerPageObjectSelectionHandler: (
callbacks: PageObjectSelectionCallbacksType,
) => Promise<null | LPVOIDType>

Type declaration

- (callbacks: PageObjectSelectionCallbacksType): Promise<null | LPVOIDType>
- Parameters
  - callbacks: PageObjectSelectionCallbacksType
    The callback set. Reader will call a corresponding callback when the page object selection is made.
  Returns Promise<null | LPVOIDType>
  Returns the page object selection handler object, which can be used to unregister the page object selection handler.

Example

const callbacks = {
 onPageObjectSelectionKeyDown: (clientData, doc, curSelectData, keyinfoData) => {
    console.log('onPageObjectSelectionKeyDown', clientData, doc, curSelectData, keyinfoData);
 }
};
const pageObjectSelectionHandler = await app.registerPageObjectSelectionHandlerJs(callbacks);

registerRectangleHandler

registerRectangleHandler: (
callbacks: ToolJsCallbacksType,
) => Promise<null | LPVOIDType>

Type declaration

- (callbacks: ToolJsCallbacksType): Promise<null | LPVOIDType>
- Parameters
  - callbacks: ToolJsCallbacksType
    The callback set. Reader will call a corresponding callback when the rectangle is drawn.
  Returns Promise<null | LPVOIDType>
  Returns the rectangle handler object, which can be used to unregister the rectangle handler.

Example

const callbacks = {
  onToolLButtonDown: (clientData, pageview, flags, point) => {
     console.log('onToolLButtonDown', clientData, pageview, flags, point);
  },
  onToolLButtonUp: (clientData, pageview, flags, point) => {
    console.log('onToolLButtonUp', clientData, pageview, flags, point);
  }
};
const toolHandler = await app.registerRectangleHandler(callbacks);

registerSelectionHandler

registerSelectionHandler: (
callbacks: SelectionJsCallbacksType,
) => Promise<null | LPVOIDType>

Type declaration

- (callbacks: SelectionJsCallbacksType): Promise<null | LPVOIDType>
- Parameters
  - callbacks: SelectionJsCallbacksType
    The callback set. Reader will call a corresponding callback when the selection is made.
  Returns Promise<null | LPVOIDType>
  Returns the selection handler object, which can be used to unregister the selection handler.

Example

const callbacks = {
  onToolLButtonDown: (clientData, pageview, flags, point) => {
     console.log('onToolLButtonDown', clientData, pageview, flags, point);
  },
  onToolLButtonUp: (clientData, pageview, flags, point) => {
    console.log('onToolLButtonUp', clientData, pageview, flags, point);
  }
};
const toolHandler = await app.registerSelectionHandler(callbacks);

selectOpenFile

selectOpenFile: (filter: string, multi: boolean) => Promise<string[]>

The selectOpenFile method is used to open a file selection dialog, allowing the user to select one or more files.

Type declaration

- (filter: string, multi: boolean): Promise<string[]>
- Parameters
  - filter: string
    A file filter string used to specify the visible file types.
  - multi: boolean
    Indicates whether multiple file selection is allowed.
  Returns Promise<string[]>
  Returns a promise that resolves to an array of strings, indicating the paths of the selected files.

setActiveDoc

setActiveDoc: (doc: DocType) => Promise<boolean>

Set the active document.It will be showed top-most.

Type declaration

- (doc: DocType): Promise<boolean>
- Parameters
  - doc: DocType
    The document that you want to set active.
  Returns Promise<boolean>
  If set the document active successfully, return true, otherwise return false.

setActiveDocByIndex

setActiveDocByIndex: (index: number) => Promise<boolean>

Set the active document by index.

Type declaration

- (index: number): Promise<boolean>
- Parameters
  - index: number
    The index of the document. This value can be iterated through from getDocsCount.
  Returns Promise<boolean>
  If set the document active successfully, return true, otherwise return false.

setActiveTool

setActiveTool: (tool: ToolType, persistent: boolean) => Promise<boolean>

Set the active tool.

Type declaration

- (tool: ToolType, persistent: boolean): Promise<boolean>
- Parameters
  - tool: ToolType
    The tool to be set as active.
  - persistent: boolean
    Whether to persist the tool. Default is false.
  Returns Promise<boolean>
  Returns true if the tool is set successfully, otherwise returns false.

showTaskPanel

showTaskPanel: (show: boolean) => Promise<void>

Show or hide the task pane.

Type declaration

- (show: boolean): Promise<void>
- Parameters
  - show: boolean
    Whether to show the task pane. Default is true.
  Returns Promise<void>

unRegisterPageObjectSelectionHandler

unRegisterPageObjectSelectionHandler: (
selectionHandler: LPVOIDType,
) => Promise<boolean>

Unregister the page object selection event handler

Type declaration

- (selectionHandler: LPVOIDType): Promise<boolean>
- Parameters
  - selectionHandler: LPVOIDType
    The page object selection event handler, usually the object returned by registerPageObjectSelectionHandler
  Returns Promise<boolean>
  Returns the unregistration result

unRegisterRectangleHandler

unRegisterRectangleHandler: (toolHandler: LPVOIDType) => Promise<boolean>

Unregister the rectangle handler.

Type declaration

- (toolHandler: LPVOIDType): Promise<boolean>
- Parameters
  - toolHandler: LPVOIDType
    The rectangle handler to be unregistered, generally the object returned by registerRectangleHandler.
  Returns Promise<boolean>
  Returns true if the rectangle handler is unregistered successfully, otherwise returns false.

unRegisterSelectionHandler

unRegisterSelectionHandler: (selectionHandler: LPVOIDType) => Promise<boolean>

Unregister the selection event handler

Type declaration

- (selectionHandler: LPVOIDType): Promise<boolean>
- Parameters
  - selectionHandler: LPVOIDType
    The selection event handler, usually the object returned by registerSelectionHandlerJs
  Returns Promise<boolean>
  Returns the unregistration result

Interface AppType

Implemented by

Index

Properties

Properties

close

Type declaration

Parameters

Returns Promise<boolean>

createBlankDoc

Type declaration

Parameters

Returns Promise<null | DocType>

getActiveDoc

Type declaration

Returns Promise<null | DocType>

getActiveTool

Type declaration

Returns Promise<null | ToolType>

getAppDataPath

Type declaration

Returns Promise<string>

getAppTitle

Type declaration

Returns Promise<string>

getDoc

Type declaration

Parameters

Returns Promise<null | DocType>

getDocsCount

Type declaration

Returns Promise<number>

getName

Type declaration

Returns Promise<string>

getRibbonBar

Type declaration

Parameters

Returns Promise<null | RibbonBarType>

getToolByName

Type declaration

Parameters

Returns Promise<null | ToolType>

getVersion

Type declaration

Returns Promise<string>

isTaskPanelShow

Type declaration

Returns Promise<boolean>

loadGraphicObjectAddon

Type declaration

Returns Promise<boolean>

openFileFromUrl

Type declaration

Parameters

Returns Promise<void>

Example

openFromFile

Type declaration

Parameters

Returns Promise<null | DocType>

Example

options

pluginInfo

registerDocHandlerOfPDDoc

Type declaration

Parameters

Returns Promise<boolean>

registerForContextMenuAddition

Type declaration

Parameters

Returns Promise<boolean>

Example

registerPageObjectSelectionHandler

Type declaration

Parameters

Returns Promise<null | LPVOIDType>

Example

registerRectangleHandler

Type declaration