Share via

SearchField.IsHidden Property

  • Reference

Definition

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

Gets or sets a value indicating whether the field will be returned in a search result. The default is null. This property must be true for key fields, and must be null for complex fields.

public bool? IsHidden { get; set; }
member this.IsHidden : Nullable<bool> with get, set
Public Property IsHidden As Nullable(Of Boolean)

Property Value

Nullable<Boolean>

Remarks

You can hide a field from search results if you want to use it only as a filter, for sorting, or for scoring. This property can also be changed on existing fields and enabling it does not cause an increase in index storage requirements.

This field must be set according to constraints described in the summary, or the server may respond with an error. Instead, consider using the SimpleField, SearchableField, VectorSearchField and ComplexField classes to help you more easily create a SearchIndex.

Applies to