dtsWordListBuilder Class

Generates a list of words matching an expression, or surrounding a word in the index.

class dtsWordListBuilder;

File

dts_wlb.h

Remarks

The Search dialog box in dtSearch Desktop displays a scrolling list of indexed words that updates continuously as the user enters a search request. This scrolling list provides instant feedback on whether or not a word is in the index and how many times it occurs. To add this feature in your application, use a dtsWordListBuilder object to create the list of words to display.

dtsWordListBuilder object wraps the API that provides this feature. It can also be used to list documents, words, or fields in an index.

Group

Classes

Methods

Method	Description
closeIndex	Close the currently-open index
dtsWordListBuilder	Create a dtsWordListBuilder
getCount	Returns the number of items in the list
getField	Get the name of the field a word occurs in.
getWord	This is the overview for the getWord method overload.
listFields	List all fields in the index
listMatchingWords	List all words matching an expression
listWords	List aRange words around cursorWord in the index.
openIndex	Open an index

Legend

Method

Links

Classes, Legend, Members, Methods, getWord Method