Index Class
Index class is designed for storage of documents data for search through them.
Inheritance Hierarchy
SystemObject
  GroupDocs.SearchIndex

Namespace: GroupDocs.Search
Assembly: GroupDocs.Search (in GroupDocs.Search.dll) Version: 19.5.1
Syntax
public class Index

The Index type exposes the following members.

Constructors
  NameDescription
Public methodCode exampleIndex
Initializes a new instance of the Index class in memory.
Public methodCode exampleIndex(String)
Initializes a new instance of the Index class. Creates or opens existing index on disk.
Public methodCode exampleIndex(IndexingSettings)
Initializes a new instance of the Index class in memory with selected indexing settings.
Public methodCode exampleIndex(String, IndexingSettings)
Initializes a new instance of the Index class. Creates index on disk with selected indexing settings. Index will be rewritten if it already exists in selected folder. Selected index settings will be ignored if overwriteIfExists is false and index exists in indexFolder.
Public methodCode exampleIndex(String, Boolean)
Initializes a new instance of the Index class. Creates index on disk or loads existing index from disk. Index will be rewritten if it already exists in selected folder and overwriteIfExists is true.
Public methodCode exampleIndex(String, Boolean, IndexingSettings)
Initializes a new instance of the Index class. Creates index on disk or loads existing index from disk with the selected indexing settings. Index will be rewritten if it already exists in selected folder and overwriteIfExists is true. Selected index settings will be ignored if overwriteIfExists is false and index exists in indexFolder.
Properties
  NameDescription
Public propertyCustomExtractors
Gets custom extractors collection.
Public propertyDictionaries
Gets dictionary collection.
Public propertyIndexFolder
Gets full folder name where index is stored.
Public propertyIndexId
Gets index GUID.
Public propertyIndexingSettings
Gets indexing setting.
Public propertyIndexStatus
Gets index status.
Public propertyLogSettings
Gets log setting.
Public propertyRepository
Gets index repository if index has it.
Public propertyVersion
Gets index version.
Methods
  NameDescription
Public methodCode exampleAddToIndex(String)
Adds files to index and starts indexing. Files from all subfolders will be added to index.
Public methodCode exampleAddToIndex(String)
Adds files to index and starts indexing. Files from all subfolders will be added to index.
Public methodCode exampleAddToIndex(String, Cancellation)
Adds files to index and starts indexing. Files from all subfolders will be added to index.
Public methodCode exampleAddToIndex(String, Boolean)
Adds files to index and starts indexing. Files from all subfolders will be added to index.
Public methodCode exampleAddToIndex(String, Int32)
Adds files to index and starts multithreaded indexing. Files from all subfolders will be added to index.
Public methodCode exampleAddToIndex(String, Cancellation)
Adds files to index and starts indexing. Files from all subfolders will be added to index.
Public methodCode exampleAddToIndex(String, Boolean)
Adds files to index and starts indexing. Files from all subfolders will be added to index.
Public methodCode exampleAddToIndex(String, Int32)
Adds files to index and starts multithreaded indexing . Files from all subfolders will be added to index.
Public methodCode exampleAddToIndex(String, Int32, Boolean)
Adds files to index and starts multithreaded indexing. Files from all subfolders will be added to index.
Public methodCode exampleAddToIndex(String, Boolean, Cancellation)
Adds files to index and starts indexing. Files from all subfolders will be added to index.
Public methodCode exampleAddToIndex(String, Int32, Cancellation)
Adds files to index and starts multithreaded indexing . Files from all subfolders will be added to index.
Public methodCode exampleAddToIndex(String, Int32, Boolean)
Adds files to index and starts multithreaded indexing. Files from all subfolders will be added to index.
Public methodCode exampleAddToIndex(String, Int32, Boolean, Cancellation)
Adds files to index and starts multithreaded indexing. Files from all subfolders will be added to index.
Public methodCode exampleAddToIndex(String, Int32, Boolean, Cancellation)
Adds files to index and starts multithreaded indexing. Files from all subfolders will be added to index.
Public methodCode exampleAddToIndexAsync(String)
Asynchronously adds files to index and starts indexing. Files from all subfolders will be added to index.
Public methodAddToIndexAsync(String)
Asynchronously adds files to index and starts indexing. Files from all subfolders will be added to index.
Public methodCode exampleAddToIndexAsync(String, Cancellation)
Asynchronously adds files to index and starts indexing. Files from all subfolders will be added to index.
Public methodCode exampleAddToIndexAsync(String, Boolean)
Asynchronously adds files to index and starts indexing. Files from all subfolders will be added to index.
Public methodCode exampleAddToIndexAsync(String, Int32)
Asynchronously adds files to index and starts multithreaded indexing Files from all subfolders will be added to index.
Public methodAddToIndexAsync(String, Cancellation)
Asynchronously adds files to index and starts indexing. Files from all subfolders will be added to index.
Public methodCode exampleAddToIndexAsync(String, Boolean)
Asynchronously adds files to index and starts indexing. Files from all subfolders will be added to index.
Public methodCode exampleAddToIndexAsync(String, Int32)
Asynchronously adds files to index and starts multithreaded indexing Files from all subfolders will be added to index.
Public methodCode exampleAddToIndexAsync(String, Boolean, Cancellation)
Asynchronously adds files to index and starts indexing. Files from all subfolders will be added to index.
Public methodCode exampleAddToIndexAsync(String, Int32, Cancellation)
Asynchronously adds files to index and starts multithreaded indexing Files from all subfolders will be added to index.
Public methodCode exampleAddToIndexAsync(String, Int32, Boolean)
Asynchronously adds files to index and starts multithreaded indexing. Files from all subfolders will be added to index.
Public methodCode exampleAddToIndexAsync(String, Boolean, Cancellation)
Asynchronously adds files to index and starts indexing. Files from all subfolders will be added to index.
Public methodCode exampleAddToIndexAsync(String, Int32, Cancellation)
Asynchronously adds files to index and starts multithreaded indexing Files from all subfolders will be added to index.
Public methodCode exampleAddToIndexAsync(String, Int32, Boolean)
Asynchronously adds files to index and starts multithreaded indexing. Files from all subfolders will be added to index.
Public methodCode exampleAddToIndexAsync(String, Int32, Boolean, Cancellation)
Asynchronously adds files to index and starts multithreaded indexing. Files from all subfolders will be added to index.
Public methodCode exampleAddToIndexAsync(String, Int32, Boolean, Cancellation)
Asynchronously adds files to index and starts multithreaded indexing. Files from all subfolders will be added to index.
Public methodCode exampleBreak
Break current asynchronous operation.
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodExtractDocumentText(DocumentInfo, IFieldExtractor)
Generates HTML formatted text for indexed document.
Public methodExtractDocumentText(String, DocumentInfo, IFieldExtractor)
Generates HTML formatted text for indexed document and saves it to a file.
Public methodExtractDocumentText(DocumentInfo, IFieldExtractor, FieldInfo)
Generates HTML formatted text for indexed document.
Public methodExtractDocumentText(String, DocumentInfo, IFieldExtractor, FieldInfo)
Generates HTML formatted text for indexed document and saves it to a file.
Protected methodFinalize (Overrides ObjectFinalize.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetIndexedDocumentItems
Gets an array of a document items.
Public methodGetIndexedDocuments
Gets an array of all indexed documents.
Public methodCode exampleGetIndexingReport
Gets report about all indexing operations.
Public methodCode exampleGetSearchingReport
Gets the report about all searching operations.
Public methodGetType
Gets the type of the current instance.
(Inherited from Object.)
Public methodHighlightInText(DocumentResultInfo)
Generates HTML formatted text with highlighted found terms.
Public methodHighlightInText(String, DocumentResultInfo)
Generates HTML formatted text with highlighted found terms and saves it to a file.
Public methodHighlightInText(DocumentResultInfo, IFieldExtractor, String)
Generates HTML formatted text with highlighted found terms.
Public methodHighlightInText(String, DocumentResultInfo, IFieldExtractor, String)
Generates HTML formatted text with highlighted found terms and saves it to a file.
Public methodHighlightInText(DocumentResultInfo, IFieldExtractor, String, FieldInfo)
Generates HTML formatted text with highlighted found terms.
Public methodHighlightInText(String, DocumentResultInfo, IFieldExtractor, String, FieldInfo)
Generates HTML formatted text with highlighted found terms and saves it to a file.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodCode exampleMerge
Merge all delta indexes to one index file. If index has delta indexes, merging can improve search performance.
Public methodCode exampleMerge(Boolean)
Merge all delta indexes to one index file. If index has delta indexes, merging can improve search performance.
Public methodCode exampleMerge(Cancellation)
Merge all delta indexes to one index file. If index has delta indexes, merging can improve search performance.
Public methodCode exampleMerge(Index)
Merge two indexes to one index.
Public methodCode exampleMerge(IndexRepository)
Merge indexes with indexes from index repository.
Public methodCode exampleMerge(Boolean, Cancellation)
Merge all delta indexes to one index file. If index has delta indexes, merging can improve search performance.
Public methodCode exampleMerge(Index, Boolean)
Merge two indexes to one index.
Public methodCode exampleMerge(IndexRepository, Boolean)
Merge indexes with indexes from index repository.
Public methodCode exampleMerge(Index, Boolean, Cancellation)
Merge two indexes to one index.
Public methodCode exampleMerge(IndexRepository, Boolean, Cancellation)
Merge indexes with indexes from index repository.
Public methodCode exampleMergeAsync
Merge all delta indexes to one index file asynchronously. If index has delta indexes, merging can improve search performance.
Public methodCode exampleMergeAsync(Boolean)
Merge all delta indexes to one index file asynchronously. If index has delta indexes, merging can improve search performance.
Public methodCode exampleMergeAsync(Index)
Merge two indexes to one index.
Public methodCode exampleMergeAsync(IndexRepository)
Merge indexes with indexes from index repository asynchronously.
Public methodCode exampleMergeAsync(Boolean, Cancellation)
Merge all delta indexes to one index file asynchronously. If index has delta indexes, merging can improve search performance.
Public methodCode exampleMergeAsync(Index, Boolean)
Merge two indexes to one index.
Public methodCode exampleMergeAsync(IndexRepository, Boolean)
Merge indexes with indexes from index repository asynchronously.
Public methodCode exampleMergeAsync(Index, Boolean, Cancellation)
Merge two indexes to one index.
Public methodCode exampleMergeAsync(IndexRepository, Boolean, Cancellation)
Merge indexes with indexes from index repository asynchronously.
Public methodCode exampleSearch(String)
Searches in index.
Public methodSearch(ChunkSearchToken)
Searches in index.
Public methodCode exampleSearch(String, SearchParameters)
Searches in index.
Public methodSearch(ChunkSearchToken, Cancellation)
Searches in index.
Public methodSearch(SearchQuery, SearchParameters)
Searches in index.
Public methodSearch(String, SearchParameters, Cancellation)
Searches in index.
Public methodSearch(SearchQuery, SearchParameters, Cancellation)
Searches in index.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodCode exampleUpdate
Updates information about indexed files and folders. Changed files will be re-indexed. Deleted files will be marked as deleted and will not be added to search results. New files in indexed folders will be added to index.
Public methodCode exampleUpdate(Cancellation)
Updates information about indexed files and folders. Changed files will be re-indexed. Deleted files will be marked as deleted and will not be added to search results. New files in indexed folders will be added to index.
Public methodCode exampleUpdateAsync
Updates information about indexed files and folders asynchronously. Changes files will be re-indexed. Deleted files will be marked as deleted and will not be added to search results. New files in indexed folders will be added to index.
Public methodCode exampleUpdateAsync(Cancellation)
Updates information about indexed files and folders asynchronously. Changes files will be re-indexed. Deleted files will be marked as deleted and will not be added to search results. New files in indexed folders will be added to index.
Events
  NameDescription
Public eventErrorHappened
Occurs when some error during index operation is happened. Error examples than can be happened: - Exception during extraction text from document. - Library can't access to the document. - Library can't update index files.
Public eventFileIndexing
Occurs before document indexing for selecting an indexing strategy.
Public eventOperationFinished
Occurs when any index operation is finished. List of operations that call this event: - Adding documents to index is finished. - Updating index is finished.
Public eventOperationProgressChanged
Occurs when progress for indexing or updating operation changed.
Public eventPasswordRequired
Occurs when document requires password for opening.
Public eventSearchPhaseCompleted
Occurs when search phase is completed.
Public eventStatusChanged
Occurs when index status changed.
See Also