Skip to content

Commit b1363e7

Browse files
Update file(s) "/." from "groupdocs-search/Groupdocs.Search-References"
1 parent 03ebb6c commit b1363e7

118 files changed

Lines changed: 253 additions & 585 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

content/sites/groupdocs/search/english/net/groupdocs.search.common/documentsourcekind/_index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ public enum DocumentSourceKind
2222
| Stream | `1` | The stream document source. |
2323
| Structure | `2` | The structure document source. |
2424
| ExtractedData | `3` | The document source of previously extracted data. |
25+
| TempFile | `4` | The temp file document source. |
2526

2627
### See Also
2728

content/sites/groupdocs/search/english/net/groupdocs.search.options/_index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ The namespace provides classes to specify additional options of various operatio
1212

1313
| Class | Description |
1414
| --- | --- |
15+
| [BaseOptions](./baseoptions) | Provides base options for index operations. |
1516
| [ChangeAttributesOptions](./changeattributesoptions) | Provides options for the change attributes operation. |
1617
| [Color](./color) | Represents an ARGB (alpha, red, green, blue) color. |
1718
| [CommonFieldNames](./commonfieldnames) | Represents a list of field names for the faceted search. |
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
title: BaseOptions
3+
second_title: GroupDocs.Search for .NET API Reference
4+
description: Provides base options for index operations.
5+
type: docs
6+
weight: 760
7+
url: /net/groupdocs.search.options/baseoptions/
8+
---
9+
## BaseOptions class
10+
11+
Provides base options for index operations.
12+
13+
```csharp
14+
public abstract class BaseOptions
15+
```
16+
17+
## Constructors
18+
19+
| Name | Description |
20+
| --- | --- |
21+
| [BaseOptions](baseoptions)() | Initializes a new instance of the [`BaseOptions`](../baseoptions) class. |
22+
23+
## Properties
24+
25+
| Name | Description |
26+
| --- | --- |
27+
| [AutoDetectEncoding](../../groupdocs.search.options/baseoptions/autodetectencoding) { get; set; } | Gets or sets a value indicating whether to detect encoding automatically or not. The default value is `false`. |
28+
| [Encoding](../../groupdocs.search.options/baseoptions/encoding) { getset; } | 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. |
29+
| [ImageIndexingOptions](../../groupdocs.search.options/baseoptions/imageindexingoptions) { get; } | Gets the image indexing options for reverse image search. |
30+
| [MetadataIndexingOptions](../../groupdocs.search.options/baseoptions/metadataindexingoptions) { get; } | Gets the options for indexing metadata fields. |
31+
| [OcrIndexingOptions](../../groupdocs.search.options/baseoptions/ocrindexingoptions) { get; } | Gets the options for OCR processing and indexing recognized text. |
32+
| [UseBackupPrivilege](../../groupdocs.search.options/baseoptions/usebackupprivilege) { getset; } | 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`. |
33+
| [UseRawTextExtraction](../../groupdocs.search.options/baseoptions/userawtextextraction) { getset; } | 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. |
34+
35+
### See Also
36+
37+
* namespace [GroupDocs.Search.Options](../../groupdocs.search.options)
38+
* assembly [GroupDocs.Search](../../)
39+
40+
<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.search.dll -->

content/sites/groupdocs/search/english/net/groupdocs.search.options/updateoptions/autodetectencoding/_index.md renamed to content/sites/groupdocs/search/english/net/groupdocs.search.options/baseoptions/autodetectencoding/_index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ second_title: GroupDocs.Search for .NET API Reference
44
description: Gets or sets a value indicating whether to detect encoding automatically or not. The default value is false.
55
type: docs
66
weight: 20
7-
url: /net/groupdocs.search.options/updateoptions/autodetectencoding/
7+
url: /net/groupdocs.search.options/baseoptions/autodetectencoding/
88
---
9-
## UpdateOptions.AutoDetectEncoding property
9+
## BaseOptions.AutoDetectEncoding property
1010

1111
Gets or sets a value indicating whether to detect encoding automatically or not. The default value is `false`.
1212

@@ -20,7 +20,7 @@ A value indicating whether to detect encoding automatically or not.
2020

2121
### See Also
2222

23-
* class [UpdateOptions](../../updateoptions)
23+
* class [BaseOptions](../../baseoptions)
2424
* namespace [GroupDocs.Search.Options](../../../groupdocs.search.options)
2525
* assembly [GroupDocs.Search](../../../)
2626

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
title: BaseOptions
3+
second_title: GroupDocs.Search for .NET API Reference
4+
description: Initializes a new instance of the BaseOptionsgroupdocs.search.options/baseoptions class.
5+
type: docs
6+
weight: 10
7+
url: /net/groupdocs.search.options/baseoptions/baseoptions/
8+
---
9+
## BaseOptions constructor
10+
11+
Initializes a new instance of the [`BaseOptions`](../../baseoptions) class.
12+
13+
```csharp
14+
public BaseOptions()
15+
```
16+
17+
### See Also
18+
19+
* class [BaseOptions](../../baseoptions)
20+
* namespace [GroupDocs.Search.Options](../../../groupdocs.search.options)
21+
* assembly [GroupDocs.Search](../../../)
22+
23+
<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.search.dll -->

content/sites/groupdocs/search/english/net/groupdocs.search.options/updateoptions/encoding/_index.md renamed to content/sites/groupdocs/search/english/net/groupdocs.search.options/baseoptions/encoding/_index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@ title: Encoding
33
second_title: GroupDocs.Search for .NET API Reference
44
description: Gets or sets the encoding used to extract text from text documents. The default value is null which means that the default encoding UTF8 is used. If AutoDetectEncoding is true then this value is used as the default encoding.
55
type: docs
6-
weight: 40
7-
url: /net/groupdocs.search.options/updateoptions/encoding/
6+
weight: 30
7+
url: /net/groupdocs.search.options/baseoptions/encoding/
88
---
9-
## UpdateOptions.Encoding property
9+
## BaseOptions.Encoding property
1010

1111
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.
1212

@@ -20,7 +20,7 @@ The encoding used to extract text from text documents.
2020

2121
### See Also
2222

23-
* class [UpdateOptions](../../updateoptions)
23+
* class [BaseOptions](../../baseoptions)
2424
* namespace [GroupDocs.Search.Options](../../../groupdocs.search.options)
2525
* assembly [GroupDocs.Search](../../../)
2626

content/sites/groupdocs/search/english/net/groupdocs.search.options/textoptions/imageindexingoptions/_index.md renamed to content/sites/groupdocs/search/english/net/groupdocs.search.options/baseoptions/imageindexingoptions/_index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@ title: ImageIndexingOptions
33
second_title: GroupDocs.Search for .NET API Reference
44
description: Gets the image indexing options for reverse image search.
55
type: docs
6-
weight: 60
7-
url: /net/groupdocs.search.options/textoptions/imageindexingoptions/
6+
weight: 40
7+
url: /net/groupdocs.search.options/baseoptions/imageindexingoptions/
88
---
9-
## TextOptions.ImageIndexingOptions property
9+
## BaseOptions.ImageIndexingOptions property
1010

1111
Gets the image indexing options for reverse image search.
1212

@@ -21,7 +21,7 @@ The image indexing options for reverse image search.
2121
### See Also
2222

2323
* class [ImageIndexingOptions](../../imageindexingoptions)
24-
* class [TextOptions](../../textoptions)
24+
* class [BaseOptions](../../baseoptions)
2525
* namespace [GroupDocs.Search.Options](../../../groupdocs.search.options)
2626
* assembly [GroupDocs.Search](../../../)
2727

content/sites/groupdocs/search/english/net/groupdocs.search.options/textoptions/metadataindexingoptions/_index.md renamed to content/sites/groupdocs/search/english/net/groupdocs.search.options/baseoptions/metadataindexingoptions/_index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@ title: MetadataIndexingOptions
33
second_title: GroupDocs.Search for .NET API Reference
44
description: Gets the options for indexing metadata fields.
55
type: docs
6-
weight: 70
7-
url: /net/groupdocs.search.options/textoptions/metadataindexingoptions/
6+
weight: 50
7+
url: /net/groupdocs.search.options/baseoptions/metadataindexingoptions/
88
---
9-
## TextOptions.MetadataIndexingOptions property
9+
## BaseOptions.MetadataIndexingOptions property
1010

1111
Gets the options for indexing metadata fields.
1212

@@ -21,7 +21,7 @@ The options for indexing metadata fields.
2121
### See Also
2222

2323
* class [MetadataIndexingOptions](../../metadataindexingoptions)
24-
* class [TextOptions](../../textoptions)
24+
* class [BaseOptions](../../baseoptions)
2525
* namespace [GroupDocs.Search.Options](../../../groupdocs.search.options)
2626
* assembly [GroupDocs.Search](../../../)
2727

content/sites/groupdocs/search/english/net/groupdocs.search.options/textoptions/ocrindexingoptions/_index.md renamed to content/sites/groupdocs/search/english/net/groupdocs.search.options/baseoptions/ocrindexingoptions/_index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@ title: OcrIndexingOptions
33
second_title: GroupDocs.Search for .NET API Reference
44
description: Gets the options for OCR processing and indexing recognized text.
55
type: docs
6-
weight: 80
7-
url: /net/groupdocs.search.options/textoptions/ocrindexingoptions/
6+
weight: 60
7+
url: /net/groupdocs.search.options/baseoptions/ocrindexingoptions/
88
---
9-
## TextOptions.OcrIndexingOptions property
9+
## BaseOptions.OcrIndexingOptions property
1010

1111
Gets the options for OCR processing and indexing recognized text.
1212

@@ -21,7 +21,7 @@ The options for OCR processing and indexing recognized text.
2121
### See Also
2222

2323
* class [OcrIndexingOptions](../../ocrindexingoptions)
24-
* class [TextOptions](../../textoptions)
24+
* class [BaseOptions](../../baseoptions)
2525
* namespace [GroupDocs.Search.Options](../../../groupdocs.search.options)
2626
* assembly [GroupDocs.Search](../../../)
2727

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
title: UseBackupPrivilege
3+
second_title: GroupDocs.Search for .NET API Reference
4+
description: 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.
5+
type: docs
6+
weight: 70
7+
url: /net/groupdocs.search.options/baseoptions/usebackupprivilege/
8+
---
9+
## BaseOptions.UseBackupPrivilege property
10+
11+
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`.
12+
13+
```csharp
14+
public bool UseBackupPrivilege { get; set; }
15+
```
16+
17+
### Property Value
18+
19+
`true` to enable privileged access using SeBackupPrivilege and FILE_FLAG_BACKUP_SEMANTICS; otherwise, `false`.
20+
21+
### Remarks
22+
23+
When enabled, this allows the process to bypass file and directory security checks, permitting access to protected resources typically restricted by ACLs — as long as the process has the proper privileges. This feature is only supported on Windows operating systems. On non-Windows platforms, enabling this property has no effect. Note that this requires the process to be running with administrative rights. Use with caution, as it may allow access to sensitive system files and user data.
24+
25+
### See Also
26+
27+
* class [BaseOptions](../../baseoptions)
28+
* namespace [GroupDocs.Search.Options](../../../groupdocs.search.options)
29+
* assembly [GroupDocs.Search](../../../)
30+
31+
<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.search.dll -->

0 commit comments

Comments
 (0)