Class TextSelectTool

constructor

• new TextSelectTool(options: Options): TextSelectTool

  Create an instance of TextSelectTool. Instead of creating an instance in new mode, use create to create an instance.

  Parameters

  • options: Options

    Create a TextSelectTool instance with the specified options.

  Returns TextSelectTool

  Example

  let doc = await app.getActiveDoc();
  let textSelectTool = await TextSelectTool.create({doc});
  Copy

options

addSelect

• addSelect(pageView: PageViewType, formRects: FloatRectArrayType): Promise<void>

  Add a selection to the specified page view.

  Parameters

  • pageView: PageViewType

    The page view object.
  • formRects: FloatRectArrayType

    The selected rectangle array.

  Returns Promise<void>

  Example

  let doc = await app.getActiveDoc();
  let docView = await doc.getCurrentDocView();
  let pageView = await docView.getCurrentPageView();
  let textSelectTool = await TextSelectTool.create({ doc });
  await textSelectTool.addSelect(pageView, rectArray);
  Copy

clearSelection

• clearSelection(): Promise<void>

  Clear the selection.

  Returns Promise<void>

destroy

• destroy(): Promise<void>

  Destroy the TextSelectTool object.

  Returns Promise<void>

getSelectedText

• getSelectedText(): Promise<string>

  Get the selected text.

  Returns Promise<string>

  Returns the selected text.

getSelectedText2

• getSelectedText2(lineBreakBetweenPages: boolean): Promise<string>

  Get the selected text.

  Parameters

  • lineBreakBetweenPages: boolean

    If true, add line breaks between pages.

  Returns Promise<string>

  Return the selected text.

Staticcreate

• create(options: Options): Promise<TextSelectToolType>

  Create a TextSelectTool instance with the specified options.

  Parameters

  • options: Options

    The options to create a TextSelectTool instance.

  Returns Promise<TextSelectToolType>

  Returns a TextSelectTool instance.