DocTextFinder Class

classDocTextFinder : SystemIDisposable

Namespace:Datalogics::PDFL

Inherits from:: SystemIDisposable

Detailed Description

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

Referenced by

DocTextFinder

Uses types

DocTextFinder DocTextFinderConfig DocTextFinderMatch Document WordFinderConfig

Constructor & Destructor Documentation

DocTextFinder(DocTextFinderrhs, InternalConstructsignifier)

Parameters

rhs: DocTextFinder
signifier: InternalConstruct

DocTextFinder(Documentdoc, WordFinderConfigwbConfig)

Parameters

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

Create a DocTextFinder

DocTextFinder(Documentdoc, WordFinderConfigwbConfig, DocTextFinderConfigdtfConfig)

Parameters

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

Create a DocTextFinder with a DocTextFinderConfig

~DocTextFinder()

Member Function Documentation

static DocTextFinderConstructorRetrieve(System.IntPtrignored)

Parameters

ignored: System.IntPtr

Returns:

DocTextFinder

voidDispose()

Returns:

void

voidDisposeChildren()

Returns:

void

System.Collections.Generic.IList< DocTextFinderMatch >GetMatchList(intbeginPageNumber, intendPageNumber, stringregexstr)

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:

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.