SearchableField Class

Definition

A String or "Collection(String)" field that can be searched.

public class SearchableField : Azure.Search.Documents.Indexes.Models.SimpleField
type SearchableField = class
    inherit SimpleField
Public Class SearchableField
Inherits SimpleField
Inheritance

Constructors

SearchableField(String, Boolean)

Initializes a new instance of the SearchableField class.

Properties

AnalyzerName

Gets or sets the name of the language analyzer. This property cannot be set when either SearchAnalyzerName or IndexAnalyzerName are set. Once the analyzer is chosen, it cannot be changed for the field in the index.

IndexAnalyzerName

Gets or sets the name of the language analyzer for indexing. This property must be set together with SearchAnalyzerName, and cannot be set when AnalyzerName is set. This property cannot be set to the name of a language analyzer; use the AnalyzerName property instead if you need a language analyzer. Once the analyzer is chosen, it cannot be changed for the field in the index.

IsFacetable

Gets or sets a value indicating whether the field can be retrieved in facet queries. The default is false.

(Inherited from SimpleField)
IsFilterable

Gets or sets a value indicating whether the field can be referenced in $filter queries. The default is false.

(Inherited from SimpleField)
IsHidden

Gets or sets whether the field is returned in search results. The default is false. A key field where IsKey is true must have this property set to false.

(Inherited from SimpleField)
IsKey

Gets or sets whether the field is the key field. The default is false. A SearchIndex must have exactly one key field of type String.

(Inherited from SimpleField)
IsSortable

Gets or sets a value indicating whether to enable the field can be referenced in $orderby expressions. The default is false.

(Inherited from SimpleField)
Name

Gets the name of the field.

(Inherited from SearchFieldTemplate)
SearchAnalyzerName

Gets or sets the name of the language analyzer for searching. This property must be set together with IndexAnalyzerName, and cannot be set when AnalyzerName is set. This property cannot be set to the name of a language analyzer; use the AnalyzerName property instead if you need a language analyzer. Once the analyzer is chosen, it cannot be changed for the field in the index.

SynonymMapNames

Gets a list of names of synonym maps to associate with this field. Currently, only one synonym map per field is supported.

Type

Gets the data type of the field.

(Inherited from SearchFieldTemplate)

Applies to