DocTextFinder Class

class DocTextFinder : SystemIDisposable

Namespace:Datalogics::PDFL

Inherits from:: SystemIDisposable

Detailed Description

A class used to extract words from a document using a regular expression.

Uses types

DocTextFinderConfig DocTextFinderMatch Document WordFinderConfig

Constructor & Destructor Documentation

DocTextFinder(Document doc, WordFinderConfig wbConfig)

Parameters

doc: Document: document to search
wbConfig: WordFinderConfig: WordFinder configuration to use

Create a DocTextFinder

DocTextFinder(Document doc, WordFinderConfig wbConfig, DocTextFinderConfig dtfConfig)

Parameters

doc: Document: document to search
wbConfig: WordFinderConfig: WordFinder configuration to use
dtfConfig: DocTextFinderConfig: DocTextFinder configuration to use

Create a DocTextFinder with a DocTextFinderConfig

Member Function Documentation

void Dispose()

Returns:

void

System.Collections.Generic.IList< DocTextFinderMatch > GetMatchList(int beginPageNumber, int endPageNumber, string regexstr)

Parameters

beginPageNumber: int: the beginning page number included in the search.
endPageNumber: int: the ending page number included in the search.
regexstr: string: the regular expression to use for the search.

Returns:

System.Collections.Generic.IList< DocTextFinderMatch >

a structure containing matching phrases along with its quads.

Finds all matching strings for a given regular expression for the specified page range. It returns a vector containing words along with the page and matching phrase that was found.