WordFinder Class Documentation
class WordFinder : SystemIDisposableNamespace:Datalogics::PDFL
- Inherits from:
SystemIDisposable
Detailed Description
A class used to extract words from a document.
Referenced by
Constructor & Destructor Documentation
WordFinder
WordFinder(Document doc, WordFinderVersion algVersion, WordFinderConfig wbConfig)Parameters
doc: Documentdocument in which to find words
algVersion: WordFinderVersionalgorithm version to use
wbConfig: WordFinderConfigconfiguration for this word finder
Create a word finder
Member Function Documentation
Dispose
void Dispose()Returns:
voidEnumWords
bool EnumWords(int pageNum, WordProc wordProc)Parameters
pageNum: intThe page number from which to extract words. Pass AllPages to sequentially process all pages in the document.
wordProc: WordProcA user-supplied callback to call once for each word found. Enumeration halts if wordProc returns false.
Returns:
booltrue if enumeration was successfully completed, false if enumeration was terminated because wordProc returned false.
Extracts words, one at a time, from the specified page or the entire document. It calls a user-supplied procedure once for each word found.
Only words within or partially within the page's crop box (see Page.CropBox) are enumerated. Words outside the crop box are skipped.
Word objects passed to wordProc become invalid once the call to EnumWords returns, or if the page number changes between calls to the WordProc.
Exceptions
- genErrBadParm —
is raised if wordProc is NULL, or pageNum is less than zero or greater than the total number of pages in the document.
- pdErrOpNotPermitted
GetVisibleWordList
System.Collections.Generic.IList< Word > GetVisibleWordList(int pageNum)Parameters
pageNum: intthe page number for which to get the list of words.
Returns:
System.Collections.Generic.IList< Word >a list of x, y sorted words on the specified page.
Finds all Visible words on the specified page and returns a list containing the words. The words are sorted by their x- and y-coordinates on the page.
GetWordList
System.Collections.Generic.IList< Word > GetWordList(int pageNum)Parameters
pageNum: intthe page number for which to get the list of words.
Returns:
System.Collections.Generic.IList< Word >a list of x, y sorted words on the specified page.
Finds all words on the specified page and returns a list containing the words. The words are sorted by their x- and y-coordinates on the page.