HeaderDictionary Class¶

Inheritance Hierarchy¶

• System.Object
• Microsoft.AspNetCore.Http.HeaderDictionary

Syntax¶

public class HeaderDictionary : IHeaderDictionary, IDictionary<string, StringValues>, ICollection<KeyValuePair<string, StringValues>>, IEnumerable<KeyValuePair<string, StringValues>>, IEnumerable

class Microsoft.AspNetCore.Http.HeaderDictionary

Constructors¶

HeaderDictionary()¶

public HeaderDictionary()

HeaderDictionary(System.Collections.Generic.Dictionary<System.String, Microsoft.Extensions.Primitives.StringValues>)

public HeaderDictionary(Dictionary<string, StringValues> store)

HeaderDictionary(System.Int32)

public HeaderDictionary(int capacity)

Methods¶

Add(System.Collections.Generic.KeyValuePair<System.String, Microsoft.Extensions.Primitives.StringValues>)¶

Adds a new list of items to the collection.

Arguments:	item (System.Collections.Generic.KeyValuePair<System.String>) – The item to add.

public void Add(KeyValuePair<string, StringValues> item)

Add(System.String, Microsoft.Extensions.Primitives.StringValues)

Adds the given header and values to the collection.

Arguments:	key (System.String) – The header name. value (Microsoft.Extensions.Primitives.StringValues) – The header values.

public void Add(string key, StringValues value)

Clear()¶

Clears the entire list of objects.

public void Clear()

Contains(System.Collections.Generic.KeyValuePair<System.String, Microsoft.Extensions.Primitives.StringValues>)¶

Returns a value indicating whether the specified object occurs within this collection.

Arguments:	item (System.Collections.Generic.KeyValuePair<System.String>) – The item.
Return type:	System.Boolean
Returns:	true if the specified object occurs within this collection; otherwise, false.

public bool Contains(KeyValuePair<string, StringValues> item)

ContainsKey(System.String)¶

Determines whether the Microsoft.AspNetCore.Http.HeaderDictionary contains a specific key.

Arguments:	key (System.String) – The key.
Return type:	System.Boolean
Returns:	true if the Microsoft.AspNetCore.Http.HeaderDictionary contains a specific key; otherwise, false.

public bool ContainsKey(string key)

CopyTo(System.Collections.Generic.KeyValuePair<System.String, Microsoft.Extensions.Primitives.StringValues>[], System.Int32)¶

Copies the Microsoft.AspNetCore.Http.HeaderDictionary elements to a one-dimensional Array instance at the specified index.

Arguments:

array (System.Collections.Generic.KeyValuePair<System.Collections.Generic.KeyValuePair`2>{System.String<System.String>, Microsoft.Extensions.Primitives.StringValues<Microsoft.Extensions.Primitives.StringValues>}[]) – The one-dimensional Array that is the destination of the specified objects copied from the Microsoft.AspNetCore.Http.HeaderDictionary. arrayIndex (System.Int32) – The zero-based index in <em>array</em> at which copying begins.

public void CopyTo(KeyValuePair<string, StringValues>[] array, int arrayIndex)

GetEnumerator()¶

Returns an enumerator that iterates through a collection.

Return type:	Microsoft.AspNetCore.Http.HeaderDictionary.Enumerator
Returns:	An Microsoft.AspNetCore.Http.HeaderDictionary.Enumerator object that can be used to iterate through the collection.

public HeaderDictionary.Enumerator GetEnumerator()

Remove(System.Collections.Generic.KeyValuePair<System.String, Microsoft.Extensions.Primitives.StringValues>)¶

Removes the given item from the the collection.

Arguments:	item (System.Collections.Generic.KeyValuePair<System.String>) – The item.
Return type:	System.Boolean
Returns:	true if the specified object was removed from the collection; otherwise, false.

public bool Remove(KeyValuePair<string, StringValues> item)

Remove(System.String)

Removes the given header from the collection.

Arguments:	key (System.String) – The header name.
Return type:	System.Boolean
Returns:	true if the specified object was removed from the collection; otherwise, false.

public bool Remove(string key)

GetEnumerator()

Returns an enumerator that iterates through a collection.

Return type:	System.Collections.Generic.IEnumerator<System.Collections.Generic.KeyValuePair<System.String>>
Returns:	An System.Collections.IEnumerator object that can be used to iterate through the collection.

IEnumerator<KeyValuePair<string, StringValues>> IEnumerable<KeyValuePair<string, StringValues>>.GetEnumerator()

GetEnumerator()

Returns an enumerator that iterates through a collection.

Return type:	System.Collections.IEnumerator
Returns:	An System.Collections.IEnumerator object that can be used to iterate through the collection.

IEnumerator IEnumerable.GetEnumerator()

TryGetValue(System.String, out Microsoft.Extensions.Primitives.StringValues)¶

Retrieves a value from the dictionary.

Arguments:	key (System.String) – The header name. value (Microsoft.Extensions.Primitives.StringValues) – The value.
Return type:	System.Boolean
Returns:	true if the Microsoft.AspNetCore.Http.HeaderDictionary contains the key; otherwise, false.

public bool TryGetValue(string key, out StringValues value)

Properties¶

Microsoft.AspNetCore.Http.HeaderDictionary.Count¶

Gets the number of elements contained in the Microsoft.AspNetCore.Http.HeaderDictionary;.

Return type:	System.Int32
Returns:	The number of elements contained in the Microsoft.AspNetCore.Http.HeaderDictionary.

public int Count { get; }

Microsoft.AspNetCore.Http.HeaderDictionary.IsReadOnly¶

Gets a value that indicates whether the Microsoft.AspNetCore.Http.HeaderDictionary is in read-only mode.

Return type:	System.Boolean
Returns:	true if the Microsoft.AspNetCore.Http.HeaderDictionary is in read-only mode; otherwise, false.

public bool IsReadOnly { get; }

Microsoft.AspNetCore.Http.HeaderDictionary.Item[System.String]¶

Get or sets the associated value from the collection as a single string.

Arguments:	key (System.String) – The header name.
Return type:	Microsoft.Extensions.Primitives.StringValues
Returns:	the associated value from the collection as a StringValues or StringValues.Empty if the key is not present.

public StringValues this[string key] { get; set; }

Microsoft.AspNetCore.Http.HeaderDictionary.Keys¶

Return type:	System.Collections.Generic.ICollection<System.String>

public ICollection<string> Keys { get; }

Microsoft.AspNetCore.Http.HeaderDictionary.Item[System.String]

Throws KeyNotFoundException if the key is not present.

Arguments:	key (System.String) – The header name.
Return type:	Microsoft.Extensions.Primitives.StringValues

StringValues IDictionary<string, StringValues>.this[string key] { get; set; }

Microsoft.AspNetCore.Http.HeaderDictionary.Values¶

Return type:	System.Collections.Generic.ICollection<Microsoft.Extensions.Primitives.StringValues>

public ICollection<StringValues> Values { get; }