SearchableFieldAttribute Class

  • Reference

Definition

Namespace:
Azure.Search.Documents.Indexes
Assembly:
Azure.Search.Documents.dll
Package:
Azure.Search.Documents v11.6.0
Package:
Azure.Search.Documents v11.7.0-beta.1
Source:
SearchableFieldAttribute.cs
Source:
SearchableFieldAttribute.cs

Attributes a simple field using a primitive type or a collection of a primitive type.

[System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Property, AllowMultiple=false, Inherited=true)]
public class SearchableFieldAttribute : Azure.Search.Documents.Indexes.SimpleFieldAttribute
[<System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Property, AllowMultiple=false, Inherited=true)>]
type SearchableFieldAttribute = class
    inherit SimpleFieldAttribute
Public Class SearchableFieldAttribute
Inherits SimpleFieldAttribute
Inheritance
Attribute
SimpleFieldAttribute
SearchableFieldAttribute
Attributes
AttributeUsageAttribute

Constructors

SearchableFieldAttribute()

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 SimpleFieldAttribute)
IsFilterable

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

(Inherited from SimpleFieldAttribute)
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 SimpleFieldAttribute)
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 SimpleFieldAttribute)
IsSortable

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

(Inherited from SimpleFieldAttribute)
NormalizerName

The name of the normalizer to use for the field. This option can be used only with fields with filterable, sortable, or facetable enabled. Once the normalizer is chosen, it cannot be changed for the field. Must be null for complex fields.

(Inherited from SimpleFieldAttribute)
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 or sets a list of names of synonym maps to associate with this field. Currently, only one synonym map per field is supported.

Applies to