Share via


SearchDocument Class

Definition

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
SearchDocument
Attributes
Implements

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 ICollection<T>.

Item[String]

Gets or sets the element with the specified key.

Keys

Gets an ICollection<T> containing the keys of the IDictionary<TKey,TValue>.

Methods

Add(String, Object)

Adds an element with the provided key and value to the IDictionary<TKey,TValue>.

Clear()

Removes all items from the ICollection<T>.

ContainsKey(String)

Determines whether the IDictionary<TKey,TValue> contains an element with the specified key.

GetBoolean(String)

Get the value of a SearchDocument's Nullable<T> property called key.

GetBooleanCollection(String)

Get the value of a SearchDocument's Boolean collection property called key.

GetDateTimeOffset(String)

Get the value of a SearchDocument's Nullable<T> property called key.

GetDateTimeOffsetCollection(String)

Get the value of a SearchDocument's DateTimeOffset collection property called key.

GetDouble(String)

Get the value of a SearchDocument's Nullable<T> property called key.

GetDoubleCollection(String)

Get the value of a SearchDocument's Double collection property called key.

GetEnumerator()

Returns an enumerator that iterates through the collection.

GetInt32(String)

Get the value of a SearchDocument's Nullable<T> property called key.

GetInt32Collection(String)

Get the value of a SearchDocument's Int32 collection property called key.

GetInt64(String)

Get the value of a SearchDocument's Nullable<T> property called key.

GetInt64Collection(String)

Get the value of a SearchDocument's 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 String property called key.

GetStringCollection(String)

Get the value of a SearchDocument's String collection property called key.

Remove(String)

Removes the element with the specified key from the IDictionary<TKey,TValue>.

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 ICollection<T>.

ICollection<KeyValuePair<String,Object>>.Contains(KeyValuePair<String,Object>)

Determines whether the ICollection<T> contains a specific value.

ICollection<KeyValuePair<String,Object>>.CopyTo(KeyValuePair<String,Object>[], Int32)

Copies the elements of the ICollection<T> to an Array, starting at a particular Array index.

ICollection<KeyValuePair<String,Object>>.IsReadOnly

Gets a value indicating whether the ICollection<T> is read-only.

ICollection<KeyValuePair<String,Object>>.Remove(KeyValuePair<String,Object>)

Removes the first occurrence of a specific object from the ICollection<T>.

IDictionary<String,Object>.Values

Gets an ICollection<T> containing the values in the IDictionary<TKey,TValue>.

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.

AsFormattedString<TKey,TValue>(IDictionary<TKey,TValue>)

Applies to