Defines a field in the index, including its name, type, and the source of its data. The IndexFieldType indicates which of the options will be present. It is invalid to specify options for a type other than the IndexFieldType .
Declaration Syntax| C# |
public class IndexField
Members| All Members | Constructors | Methods | Properties | ||
| Icon | Member | Description |
|---|---|---|
 | IndexField()()()() | Initializes a new instance of the IndexField class |
| 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.) |
 | IndexFieldName |
The name of a field in the search index. Field names must begin with a letter and can contain the following characters: a-z (lowercase),
0-9, and _ (underscore). Uppercase letters and hyphens are not allowed. The names "body", "docid", and "text_relevance" are reserved and
cannot be specified as field or rank expression names.
Constraints: |
| IndexFieldType |
The type of field. Based on this type, exactly one of the UIntOptions, LiteralOptions or TextOptions must be present.
Constraints: |
| LiteralOptions |
Options for literal field. Present if IndexFieldType specifies the field is of type literal.
|
| SourceAttributes |
An optional list of source attributes that provide data for this index field. If not specified, the data is pulled from a source attribute
with the same name as this IndexField. When one or more source attributes are specified, an optional data transformation can be
applied to the source data when populating the index field. You can configure a maximum of 20 sources for an IndexField.
|
| TextOptions |
Options for text field. Present if IndexFieldType specifies the field is of type text.
|
| ToString()()()() | Returns a string that represents the current object. (Inherited from Object.) |
| UIntOptions |
Options for an unsigned integer field. Present if IndexFieldType specifies the field is of type unsigned integer.
|
| WithIndexFieldName(String) | Obsolete.
Sets the IndexFieldName property
|
| WithIndexFieldType(String) | Obsolete.
Sets the IndexFieldType property
|
| WithLiteralOptions(LiteralOptions) | Obsolete.
Sets the LiteralOptions property
|
| WithSourceAttributes(array<SourceAttribute>[]()[][]) | Obsolete.
Adds elements to the SourceAttributes collection
|
| WithSourceAttributes(IEnumerable<(Of <<'(SourceAttribute>)>>)) | Obsolete.
Adds elements to the SourceAttributes collection
|
| WithTextOptions(TextOptions) | Obsolete.
Sets the TextOptions property
|
| WithUIntOptions(UIntOptions) | Obsolete.
Sets the UIntOptions property
|
Inheritance Hierarchy| Object | |
 | IndexField |