TextOptions
Contents
[
Hide
]
TextOptions class
Provides options for retrieving document text from an index.
public class TextOptions : BaseOptions
Constructors
| Name | Description |
|---|---|
| TextOptions() | Initializes a new instance of the TextOptions class. |
Properties
| Name | Description |
|---|---|
| AdditionalFields { get; set; } | Gets or sets the additional document fields that was used for indexing. The default value is null. Note that this value is used only if document text was not saved into the index. |
| AutoDetectEncoding { get; set; } | Gets or sets a value indicating whether to detect encoding automatically or not. The default value is false. |
| Cancellation { get; set; } | Gets or sets the cancellation object. The default value is null. |
| CustomExtractor { get; set; } | Gets or sets the custom text extractor that was used for indexing. The default value is null. Note that this value is used only if document text was not saved into the index. |
| Encoding { get; set; } | Gets or sets the encoding used to extract text from text documents. The default value is null, which means that the default encoding UTF-8 is used. If AutoDetectEncoding is true then this value is used as the default encoding. |
| GenerateHead { get; set; } | Gets or sets a value indicating whether the Head tag is generated in the output HTML. The default value is true. |
| ImageIndexingOptions { get; } | Gets the image indexing options for reverse image search. |
| MetadataIndexingOptions { get; } | Gets the options for indexing metadata fields. |
| OcrIndexingOptions { get; } | Gets the options for OCR processing and indexing recognized text. |
| UseBackupPrivilege { get; set; } | Gets or sets a value indicating whether the process should use the SeBackupPrivilege and FILE_FLAG_BACKUP_SEMANTICS to access files and directories. The default value is false. |
| UseRawTextExtraction { get; set; } | Gets or sets a value indicating whether the raw mode is used for text extraction if possible. The default value is false. The raw mode can significantly increase the indexing speed, but normal mode improves the formatting of the extracted text. |
Remarks
Learn more
See Also
- class BaseOptions
- namespace GroupDocs.Search.Options
- assembly GroupDocs.Search
