IndexSettings Class
Represents the index settings that allow to customize the indexing operations.
Inheritance Hierarchy
SystemObject
  GroupDocs.SearchIndexSettings

Namespace: GroupDocs.Search
Assembly: GroupDocs.Search (in GroupDocs.Search.dll) Version: 20.6
Syntax
[SerializableAttribute]
public class IndexSettings

The IndexSettings type exposes the following members.

Constructors
  NameDescription
Public methodIndexSettings
Initializes a new instance of the IndexSettings class.
Properties
  NameDescription
Public propertyAutoDetectEncoding
Gets or sets a value indicating whether to detect encoding automatically or not. The default value is false.
Public propertyCustomExtractors
Gets the custom extractor collection.
Public propertyCode exampleDocumentFilter
Gets or sets a document filter. The DocumentFilter works on the inclusion logic. Use the DocumentFilter class for creation of a document filter instances. The default value is null, which means that all added documents are indexed.
Public propertyIndexType
Gets or sets the index type. The default value is NormalIndex.
Public propertyInMemoryIndex
Gets a value indicating whether the index is stored in memory or on disk.
Public propertyLogger
Gets or sets a logger that is used for logging events and errors in the index. Note that the logger is not saved and must be created and assigned each time the index is created or loaded.
Public propertyMaxIndexingReportCount
Gets or sets the maximum number of indexing reports. The default value is 5.
Public propertyMaxSearchReportCount
Gets or sets the maximum number of search reports. The default value is 10.
Public propertySearchThreads
Gets or sets the number of threads used for the search. The default value is Default, which means that the search will be performed using the number of threads equal to the number of processor cores.
Public propertyCode exampleTextStorageSettings
Gets or sets the text storage settings. The default value is null, which means that document texts are not stored.
Public propertyUseCharacterReplacements
Gets or sets a value indicating whether to use character replacements or not. The default value is false.
Public propertyUseRawTextExtraction
Gets or sets a value indicating whether the raw mode is used for text extraction if possible. The default value is true. The raw mode can significantly increase the indexing speed, but normal mode improves the formatting of the extracted text.
Public propertyUseStopWords
Gets or sets a value indicating whether to use stop words or not. The default value is true.
Methods
  NameDescription
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodToString (Inherited from Object.)
Remarks
Examples
The example demonstrates a typical usage of the class.
C#
string indexFolder = @"c:\MyIndex\";
IndexSettings settings = new IndexSettings();
settings.IndexType = IndexType.CompactIndex; // Setting the index type

Index index = new Index(indexFolder, settings); // Creating an index
See Also