Method 

Description 

clear 

Free memory allocated for objects such as SearchResults. 

clearSelections 

Select no items from the SearchResults list 

execute 

Generate the search report. 

getErrors 

A JobErrorInfo containing information about any errors that occurred during generation of the search report. 

getOutputString 

Result of the search report, if OutputToString was set to true 

selectAll 

Select all items in the SearchResults list 

selectItems 

Select a range of items from the SearchResults list 

setAfterHit 

Text to insert after each hit. 

setBeforeHit 

Text to insert before each hit. 

setContextFooter 

Text to appear after each block of context. 

setContextHeader 

Text to appear in front of each block of context. 

setContextSeparator 

Text to appear between each block of context. 

setDocBytes 

Use setDocBytes to provide a document in a memory buffer rather than as a disk file. The byte array input must contain exactly the same bytes as the representation of this document on disk. When a byte array is provided through setDocBytes, the filename is disregarded. setDocBytes can only be used when exactly one document is selected to be included in the report. 

setFileFooter 

Text to appear after each file in the search report. 

setFileHeader 

Text to appear in front of each file in the search report. 

setFlags 

SearchReportFlags specifying how the report should be generated 

setFooter 

Footer of the search report 

setHeader 

Header of the search report 

setMaxContextBlocks 

Number of blocks of context to include in the report. If zero, all hits in each document will be included. 

setMaxWordsToRead 

Number of words to scan in each document looking for blocks of context to include in the report. For example, if maxWordsToRead=5000, then the search report will only include hits that occur in the first 5000 words in each document. This setting can be used to generate faster (but not necessarily complete) reports by limiting the search report to hits near the beginning of each document. 

setOutputFile 

The name of the file to create. 

setOutputFormat 

The file format of the output. By default, the output format is HTML. To request an plain text report, set OutputFormat to it_Ansi. To request an RTF report, set OutputFormat to it_RTF. 

setOutputStringMaxSize 

When output is directed to an in-memory string, you may wish to limit the maximum amount of memory used. To do this, set OutputStringMaxSize to the maximum size you want to allow. Note: The dtSearch Engine will not preallocate this amount of memory. Instead, it will allocate a small amount of memory and grow the string as needed, either until the job is complete or the size limit is reached. 

setOutputToString 

If true, output will be stored in an in-memory string variable rather than a disk file. (OutputFile will be ignored.) After the execute method is done, the output will be in the OutputString property. 

setParagraphsOfContext 

Number of paragraphs of context to include around each hit. 

setResults 

The search results list that this SearchReportJob will use. The SearchResults will be attached automatically if you used its NewSearchReportJob method to create this job. 

setTimeoutSeconds 

Set to a non-zero value if you want the job to terminate automatically after a specified number of seconds. 

setWordsOfContext 

Number of words of context to include around each hit. Use setWordsOfContextExact to get exactly the requested number of words, and use setWordsOfContext to get whole paragraphs with at least the requested number of words 

setWordsOfContextExact 

Number of words of context to include around each hit. Use setWordsOfContextExact to get exactly the requested number of words, and use setWordsOfContext to get whole paragraphs with at least the requested number of words