Options for text field. Present if IndexFieldType specifies the field is of type text . A text field is always searchable. All options are enabled by default.
Declaration Syntax| C# |
public class TextOptions
Members| All Members | Constructors | Methods | Properties | ||
| Icon | Member | Description |
|---|---|---|
 | TextOptions()()()() | Initializes a new instance of the TextOptions class |
 | AnalysisScheme |
The name of an analysis scheme for a text field.
Constraints: |
| DefaultValue |
A value to use for the field if the field isn't specified for a document.
Constraints: |
| Equals(Object) | (Inherited from Object.) |
| GetHashCode()()()() | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetType()()()() | Gets the type of the current instance. (Inherited from Object.) |
| HighlightEnabled |
Whether highlights can be returned for the field.
|
| ReturnEnabled |
Whether the contents of the field can be returned in the search results.
|
| SortEnabled |
Whether the field can be used to sort the search results.
|
| SourceField |
A string that represents the name of an index field. Field names begin with a letter and can contain the following characters: a-z
(lowercase), 0-9, and _ (underscore). The name "score" is reserved and cannot be used as a field name. To reference a document's ID, you can
use the name _id.
Constraints: |
| ToString()()()() | Returns a string that represents the current object. (Inherited from Object.) |
| WithAnalysisScheme(String) | Obsolete.
Sets the AnalysisScheme property
|
| WithDefaultValue(String) | Obsolete.
Sets the DefaultValue property
|
| WithHighlightEnabled(Boolean) | Obsolete.
Sets the HighlightEnabled property
|
| WithReturnEnabled(Boolean) | Obsolete.
Sets the ReturnEnabled property
|
| WithSortEnabled(Boolean) | Obsolete.
Sets the SortEnabled property
|
| WithSourceField(String) | Obsolete.
Sets the SourceField property
|
Inheritance Hierarchy| Object | |
 | TextOptions |