Class SearchableField

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

Inheritance
System.Object
SearchFieldTemplate
SimpleField
SearchableField
Inherited Members
Namespace: System.Dynamic.ExpandoObject
Assembly: Azure.Search.Documents.dll
Syntax
public class SearchableField : Azure.Search.Documents.Indexes.Models.SimpleField

Constructors

SearchableField(String, Boolean)

Initializes a new instance of the SearchableField class.

Declaration
public SearchableField (string name, bool collection = false);
Parameters
System.String name

The name of the field, which must be unique within the index or parent field.
System.Boolean collection

Whether the field is a collection of strings.
Exceptions
System.ArgumentException

name is an empty string.
System.ArgumentNullException

name is null.

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.

Declaration
public Nullable<Azure.Search.Documents.Indexes.Models.LexicalAnalyzerName> AnalyzerName { get; set; }
Property Value
System.Nullable<LexicalAnalyzerName>

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.

Declaration
public Nullable<Azure.Search.Documents.Indexes.Models.LexicalAnalyzerName> IndexAnalyzerName { get; set; }
Property Value
System.Nullable<LexicalAnalyzerName>

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.

Declaration
public Nullable<Azure.Search.Documents.Indexes.Models.LexicalAnalyzerName> SearchAnalyzerName { get; set; }
Property Value
System.Nullable<LexicalAnalyzerName>

SynonymMapNames

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

Declaration
public System.Collections.Generic.IList<string> SynonymMapNames { get; }
Property Value
System.Collections.Generic.IList<System.String>

Remarks

Assigning a synonym map to a field ensures that query terms targeting that field are expanded at query-time using the rules in the synonym map.

This attribute can be changed on existing fields.