Index Methods

The Index type exposes the following members.

Methods
  NameDescription
Public methodCode exampleAdd(String)
Performs indexing operation. Adds a file or folder by an absolute or relative path. Documents from all subfolders will be indexed.
Public methodCode exampleAdd(String)
Performs indexing operation. Adds files or folders by an absolute or relative path. Documents from all subfolders will be indexed.
Public methodCode exampleAdd(String, IndexingOptions)
Performs indexing operation. Adds a file or folder by an absolute or relative path. Documents from all subfolders will be indexed.
Public methodCode exampleAdd(String, IndexingOptions)
Performs indexing operation. Adds files or folders by an absolute or relative path. Documents from all subfolders will be indexed.
Public methodAdd(Document, IndexingOptions)
Performs indexing operation. Adds documents from file system, stream, or structure.
Public methodChangeAttributes
Applies the specified batch of attribute changes to indexed documents without reindexing during the update operation.
Public methodCode exampleDelete
Deletes indexed files or folders from the index. Then updates the index without deleted paths.
Public methodDispose
Releases all resources used by the Index.
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodGetAttributes
Gets all the attributes associated with the specified indexed document.
Public methodCode exampleGetDocumentText(DocumentInfo, OutputAdapter)
Generates HTML formatted text for indexed document and transfers it through the output adapter.
Public methodGetDocumentText(DocumentInfo, OutputAdapter, TextOptions)
Generates HTML formatted text for indexed document and transfers it through the output adapter.
Public methodGetHashCode (Inherited from Object.)
Public methodCode exampleGetIndexedDocumentItems
Gets an array of nested items of the specified document (for container documents such as ZIP, OST, PST).
Public methodCode exampleGetIndexedDocuments
Gets an array of all indexed documents.
Public methodGetIndexedPaths
Gets an array of indexed paths - documents or folders.
Public methodCode exampleGetIndexingReports
Gets the reports on indexing operations.
Public methodCode exampleGetSearchReports
Gets the reports on search operations.
Public methodGetType (Inherited from Object.)
Public methodCode exampleHighlight(FoundDocument, Highlighter)
Generates HTML formatted text with highlighted found terms.
Public methodCode exampleHighlight(FoundDocument, Highlighter, HighlightOptions)
Generates HTML formatted text with highlighted found terms.
Protected methodMemberwiseClone (Inherited from Object.)
Public methodCode exampleMerge(Index, MergeOptions)
Merges the specified index into the current index. Note that the other index will not be changed.
Public methodCode exampleMerge(IndexRepository, MergeOptions)
Merges indexes from the specified index repository into the current index. Note that indexes in the repository will not be changed.
Public methodNotify
Passes the specified notification object to the index to perform the notification.
Public methodCode exampleOptimize
Minimizes the number of index segments by merging them one with another. This operation improves search performance.
Public methodCode exampleOptimize(MergeOptions)
Minimizes the number of index segments by merging them one with another. This operation improves search performance.
Public methodCode exampleSearch(String)
Searches in index.
Public methodCode exampleSearch(SearchQuery)
Searches in index.
Public methodCode exampleSearch(String, SearchOptions)
Searches in index.
Public methodCode exampleSearch(SearchQuery, SearchOptions)
Searches in index.
Public methodCode exampleSearchNext(ChunkSearchToken)
Continues the chunk search started with method Search.
Public methodCode exampleSearchNext(ChunkSearchToken, Cancellation)
Continues the chunk search started with method Search.
Public methodToString (Inherited from Object.)
Public methodCode exampleUpdate
Re-indexes documents that have been changed or deleted since last update. Adds new files that have been added to the indexed folders.
Public methodCode exampleUpdate(UpdateOptions)
Re-indexes documents that have been changed or deleted since last update. Adds new files that have been added to the indexed folders.
See Also