Options for literal field. Present if IndexFieldType specifies the field is of type literal . All options are enabled by default.
| C# |
public class LiteralOptions
| All Members | Constructors | Methods | Properties | ||
| Icon | Member | Description |
|---|---|---|
| LiteralOptions()()()() | Initializes a new instance of the LiteralOptions class | |
| DefaultValue |
A value to use for the field if the field isn't specified for a document.
Constraints: | |
| Equals(Object) | (Inherited from Object.) | |
| FacetEnabled |
Whether facet information can be returned for the field.
| |
| GetHashCode()()()() | Serves as a hash function for a particular type. (Inherited from Object.) | |
| GetType()()()() | Gets the type of the current instance. (Inherited from Object.) | |
| ReturnEnabled |
Whether the contents of the field can be returned in the search results.
| |
| SearchEnabled |
Whether the contents of the field are searchable.
| |
| 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.) | |
| WithDefaultValue(String) | Obsolete.
Sets the DefaultValue property
| |
| WithFacetEnabled(Boolean) | Obsolete.
Sets the FacetEnabled property
| |
| WithReturnEnabled(Boolean) | Obsolete.
Sets the ReturnEnabled property
| |
| WithSearchEnabled(Boolean) | Obsolete.
Sets the SearchEnabled property
| |
| WithSortEnabled(Boolean) | Obsolete.
Sets the SortEnabled property
| |
| WithSourceField(String) | Obsolete.
Sets the SourceField property
|
| Object | |
| LiteralOptions | |