Class PageTextSearch

constructor

• new PageTextSearch(options: Options): PageTextSearch

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

  Parameters

  • options: Options

    Create a PageTextSearch instance with the specified options.

  Returns PageTextSearch

  Example

  let doc = await app.getActiveDoc();
  let page = await doc.getPage(0);
  let textPage = await TextPage.create({
      page,
      flag: 0,
  });
  const pageTextSearch = await PageTextSearch.create({textPage: textPage});
  Copy

options

destroy

• destroy(): Promise<void>

  Destroy the current object.

  Returns Promise<void>

findFirst

• findFirst(text: string, flag: number, startPos: number): Promise<boolean>

  Find the first match of the text.

  Parameters

  • text: string

    The text to be found.
  • flag: number

    The search flag, default value is 0. If you need set specified falg, like:

    • DefineConst.FPD_TEXT_MATCHCASE
    • DefineConst.FPDTEXT_MATCHWHOLEWORD
    • DefineConst.FPDTEXT_CONSECUTIVE
    • DefineConst.FPDTEXT_MATCHKASHIDA
    • DefineConst.FPDTEXT_NOT_MATCHACCENTS
    • DefineConst.FPDTEXT_NOT_MATCHFULLWIDTH
    • DefineConst.FPDTEXT_MATCHALIAS
  • startPos: number

    The start position of the search.

  Returns Promise<boolean>

  Return true if the text is found, otherwise return false.

  Example

  let textPage = await page.getTextPage();
  let pageTextSearch = await textPage.createPageTextSearch();
  let bFind = await pageTextSearch.findFirst('search text', 0, 0);
  Copy

findNext

• findNext(): Promise<boolean>

  Find the next match of the text.

  Returns Promise<boolean>

  Return true if the text is found, otherwise return false.

  Example

  let textPage = await page.getTextPage();
  let pageTextSearch = await textPage.createPageTextSearch();
  let bFind = await pageTextSearch.findFirst('search text', 0, 0);
  while (bFind) {
       let rectArrayItem = await pageTextSearch.getRectArray();
       bFind = await pageTextSearch.findNext();
  }
  Copy

findPrev

• findPrev(): Promise<boolean>

  Find the previous match of the text.

  Returns Promise<boolean>

  Return true if the text is found, otherwise return false.

getRectArray

• getRectArray(): Promise<null | FloatRectArrayType>

  Get the rect array of the text.

  Returns Promise<null | FloatRectArrayType>

  Return the rect array of the text.

Staticcreate

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

  Create a PageTextSearch instance.

  Parameters

  • options: Options

    Create a PageTextSearch instance with the specified options.

  Returns Promise<PageTextSearchType>

  Return a PageTextSearch instance.

  Example

  let doc = await app.getActiveDoc();
  let page = await doc.getPage(0);
  let textPage = await TextPage.create({
      page,
      flag: 0,
  });
  const pageTextSearch = await PageTextSearch.create({textPage: textPage});
  Copy