dtSearch Text Retrieval Engine .NET interface

SearchReportJob Members

SearchReportJob overview

Public Instance Constructors

SearchReportJob Constructor Initializes a new instance of the SearchReportJob class.

Public Instance Properties

AfterHit Text to be inserted after each hit in the report.
BeforeHit Text to be inserted before each hit in the report to highlight hits.
ContextFooter Text to appear after each block of context in the report.
ContextHeader Text to appear at the start of each block of context in the report.
ContextSeparator Text to appear between blocks of context in the report (after one ContextFooter, before the next ContextHeader)
Errors Contains any errors that occurred during generation of the search report.
FileFooter Text to appear after each document in the report.
FileHeader Text to appear at the start of each document in the report.
Flags Flags controlling generation of the report.
Footer Text to appear after the end of the report.
Header Text to appear at the top of the report.
MaxContextBlocks Number of blocks of context to include in the report for each document.
MaxWordsToRead Number of words to scan in each document looking for blocks of context to include in the report.
OutputFile File to write search report to.
OutputFormat The file format of the output.
OutputString Result of the search report, if OutputToString was set to true
OutputStringMaxSize Maximum number of characters to generate in the OutputString, when OutputToString is true.
OutputToString Generate output to a string (OutputString), rather than to a file (OutputFile).
ParagraphsOfContext Number of paragraphs of context to include around each hit.
TimeoutSeconds Set to a non-zero value to make the job terminate automatically after a specified number of seconds.
WordsOfContext Approximate number of words of context to include around each hit.
WordsOfContextExact Number of words of context to include around each hit.

Public Instance Methods

ClearSelections Select no items in the SearchResults.
Dispose (inherited from dtSearch.Engine.DisposableObject) 
Execute Generate the report.
SelectAll Select all items in the SearchResults.
SelectItems Select a range of items in the SearchResults.
SetResults The search results list that this SearchReportJob will use.

See Also

SearchReportJob Class | dtSearch.Engine Namespace