IWordListBuilder Interface

[ object, uuid(697DF02C-B24E-11D3-B57C-00105AA461D0), dual, helpstring("IWordListBuilder Interface"), pointer_default(unique) ]
interface IWordListBuilder : IDispatch;

File

dten600.idl

Description

Builds a scrolling list of indexed words that you can update as a user types in a search request.

Remarks

For an example of what this looks like, see the Search dialog box in dtSearch Desktop. For sample code, see the SearchRequest_Change method of the dtdemo.vbp sample application in the examples\vbasic directory.

Use the NewWordListBuilder method of the Server (IServer) object to create a new WordListBuilder object.

Group

Interfaces

Methods

Method	Description
CloseIndex	Close the index that was opened by OpenIndex.
GetNthWord	Get the text of a word in the word list.
GetNthWordCount	Get the number of times this word occurs in the index
GetNthWordDocCount	Get the number of documents in which this word occurs
GetNthWordField	If the dtsWlbListFields flag was set in ListMatchingWords, you can call GetNthWordField to get the field in which a word occurred
ListFields	List all fields in the index
ListMatchingWords	List all words in the index that match toMatch, using the specified searchFlags and fuzziness, up to nLimit words. Returns the number of words found
ListWords	Updates the word list with a new cursor word, which is the word in the middle of the list. Range is the number of words surrounding the cursor word
OpenIndex	Open the index at IndexPath and return 0 if the index was opened successfully, or non-zero if the index could not be opened.

Properties

Property	Description
Count	Number of words in the list

Legend

	Property
	read only
	Method

Links

dten600.idl, Interfaces, Legend, Members, Methods, Properties