SearchDocument Class

Reference

Definition

Namespace:: Azure.Search.Documents.Models

Assembly:: Azure.Search.Documents.dll

Package:: Azure.Search.Documents v11.3.0

Package:: Azure.Search.Documents v11.4.0-beta.1

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Represents an untyped document returned from a search or document lookup. It can be accessed as either a dynamic object or a dictionary.

[System.Text.Json.Serialization.JsonConverter(typeof(Azure.Search.Documents.Models.SearchDocumentConverter))]
public class SearchDocument : System.Collections.Generic.ICollection<System.Collections.Generic.KeyValuePair<string,object>>, System.Collections.Generic.IDictionary<string,object>, System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<string,object>>

[<System.Text.Json.Serialization.JsonConverter(typeof(Azure.Search.Documents.Models.SearchDocumentConverter))>]
type SearchDocument = class
    interface IDictionary<string, obj>
    interface ICollection<KeyValuePair<string, obj>>
    interface seq<KeyValuePair<string, obj>>
    interface IEnumerable

Public Class SearchDocument
Implements ICollection(Of KeyValuePair(Of String, Object)), IDictionary(Of String, Object), IEnumerable(Of KeyValuePair(Of String, Object))

Inheritance: System.Object
SearchDocument

Attributes: System.Text.Json.Serialization.JsonConverterAttribute

Implements: System.Collections.Generic.ICollection<System.Collections.Generic.KeyValuePair<System.String,System.Object>> System.Collections.Generic.ICollection<System.Collections.Generic.KeyValuePair<TKey,TValue>> System.Collections.Generic.IDictionary<System.String,System.Object> System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<System.String,System.Object>> System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<TKey,TValue>> System.Collections.Generic.IEnumerable<T> System.Collections.IEnumerable

Constructors

SearchDocument()	Initializes a new instance of the SearchDocument class.
SearchDocument(IDictionary<String,Object>)	Initializes a new instance of the SearchDocument class with initial values.

Properties

Count	Gets the number of elements contained in the System.Collections.Generic.ICollection`1.
Item[String]	Gets or sets the element with the specified key.
Keys	Gets an System.Collections.Generic.ICollection`1 containing the keys of the System.Collections.Generic.IDictionary`2.

Methods

Add(String, Object)	Adds an element with the provided key and value to the System.Collections.Generic.IDictionary`2.
Clear()	Removes all items from the System.Collections.Generic.ICollection`1.
ContainsKey(String)	Determines whether the System.Collections.Generic.IDictionary`2 contains an element with the specified key.
GetBoolean(String)	Get the value of a SearchDocument's System.Nullable`1 property called `key`.
GetBooleanCollection(String)	Get the value of a SearchDocument's System.Boolean collection property called `key`.
GetDateTimeOffset(String)	Get the value of a SearchDocument's System.Nullable`1 property called `key`.
GetDateTimeOffsetCollection(String)	Get the value of a SearchDocument's System.DateTimeOffset collection property called `key`.
GetDouble(String)	Get the value of a SearchDocument's System.Nullable`1 property called `key`.
GetDoubleCollection(String)	Get the value of a SearchDocument's System.Double collection property called `key`.
GetEnumerator()	Returns an enumerator that iterates through the collection.
GetInt32(String)	Get the value of a SearchDocument's System.Nullable`1 property called `key`.
GetInt32Collection(String)	Get the value of a SearchDocument's System.Int32 collection property called `key`.
GetInt64(String)	Get the value of a SearchDocument's System.Nullable`1 property called `key`.
GetInt64Collection(String)	Get the value of a SearchDocument's System.Int64 collection property called `key`.
GetObject(String)	Get the value of a SearchDocument's complex SearchDocument property called `key`.
GetObjectCollection(String)	Get the value of a SearchDocument's complex SearchDocument collection property called `key`.
GetPoint(String)	Get the value of a SearchDocument's GeoPoint property called `key`.
GetPointCollection(String)	Get the value of a SearchDocument's GeoPoint collection property called `key`.
GetString(String)	Get the value of a SearchDocument's System.String property called `key`.
GetStringCollection(String)	Get the value of a SearchDocument's System.String collection property called `key`.
Remove(String)	Removes the element with the specified key from the System.Collections.Generic.IDictionary`2.
ToString()	Returns a string that represents the current object.
TryGetValue(String, Object)	Gets the value associated with the specified key.

Explicit Interface Implementations

ICollection<KeyValuePair<String,Object>>.Add(KeyValuePair<String,Object>)	Adds an item to the System.Collections.Generic.ICollection`1.
ICollection<KeyValuePair<String,Object>>.Contains(KeyValuePair<String,Object>)	Determines whether the System.Collections.Generic.ICollection`1 contains a specific value.
ICollection<KeyValuePair<String,Object>>.CopyTo(KeyValuePair<String,Object>[], Int32)	Copies the elements of the System.Collections.Generic.ICollection`1 to an System.Array, starting at a particular System.Array index.
ICollection<KeyValuePair<String,Object>>.IsReadOnly	Gets a value indicating whether the System.Collections.Generic.ICollection`1 is read-only.
ICollection<KeyValuePair<String,Object>>.Remove(KeyValuePair<String,Object>)	Removes the first occurrence of a specific object from the System.Collections.Generic.ICollection`1.
IDictionary<String,Object>.Values	Gets an System.Collections.Generic.ICollection`1 containing the values in the System.Collections.Generic.IDictionary`2.
IEnumerable.GetEnumerator()	Returns an enumerator that iterates through a collection.

Extension Methods

GetValueOrAdd<TKey,TValue>(IDictionary<TKey,TValue>, TKey, Func<TKey,TValue>)	Gets or adds the value associated with specified key.
GetValueOrDefault<TKey,TValue>(IDictionary<TKey,TValue>, TKey, TValue)	Gets the value associated with specified key.
ToCommaSeparatedString<T>(IEnumerable<T>)	Converts the elements of a collection to strings and concatenates them into a comma-separated list, or returns null for null or empty collections.
AsFormattedString<TKey,TValue>(IDictionary<TKey,TValue>)

Applies to