HeaderDictionary Class

Article
10/29/2013

Represents a wrapper for owin.RequestHeaders and owin.ResponseHeaders.

Inheritance Hierarchy

System.Object
Microsoft.Owin.HeaderDictionary

Namespace: Microsoft.Owin
Assembly: Microsoft.Owin (in Microsoft.Owin.dll)

Syntax

'Declaration
Public Class HeaderDictionary _
    Implements IHeaderDictionary, IReadableStringCollection, IDictionary(Of String, String()),  _
    ICollection(Of KeyValuePair(Of String, String())),  _
    IEnumerable(Of KeyValuePair(Of String, String())),  _
    IEnumerable
'Usage
Dim instance As HeaderDictionary

public class HeaderDictionary : IHeaderDictionary, 
    IReadableStringCollection, IDictionary<string, string[]>, ICollection<KeyValuePair<string, string[]>>, 
    IEnumerable<KeyValuePair<string, string[]>>, IEnumerable

public ref class HeaderDictionary : IHeaderDictionary, 
    IReadableStringCollection, IDictionary<String^, array<String^>^>, 
    ICollection<KeyValuePair<String^, array<String^>^>>, 
    IEnumerable<KeyValuePair<String^, array<String^>^>>, 
    IEnumerable

type HeaderDictionary =  
    class 
        interface IHeaderDictionary 
        interface IReadableStringCollection 
        interface IDictionary<string, string[]>
        interface ICollection<KeyValuePair<string, string[]>>
        interface IEnumerable<KeyValuePair<string, string[]>>
        interface IEnumerable 
    end

public class HeaderDictionary implements IHeaderDictionary, IReadableStringCollection, IDictionary<String, String[]>, ICollection<KeyValuePair<String, String[]>>, IEnumerable<KeyValuePair<String, String[]>>, IEnumerable

The HeaderDictionary type exposes the following members.

Constructors

	Name	Description
	HeaderDictionary	Initializes a new instance of the HeaderDictionary class.

Top

Properties

	Name	Description
	Count	Gets the number of elements contained in the HeaderDictionary.
	IsReadOnly	Gets a value that indicates whether the HeaderDictionary is in read-only mode.
	Item	Get or set the associated header value in the collection. Multiple values will be merged. Returns null if the key is not present.
	Keys	Gets an ICollection that contains the keys in the HeaderDictionary.
	Values	Gets the attribute value.

Top

Methods

	Name	Description
	Add(KeyValuePair<String, array<String[]>)	Adds a new list of items in the collection.
	Add(String, array<String[])	Adds a new list of items in the collection.
	Append	Adds a new value. Appends to the header if already present.
	AppendCommaSeparatedValues	Quotes any values containing comas, and then coma joins all of the values with any existing values.
	AppendValues	Adds new values. Each item remains a separate array entry.
	Clear	Clears the entire list of objects.
	Contains	Returns a value indicating whether the specified object occurs within this collection.
	ContainsKey	Determines whether the HeaderDictionary contains a specific key.
	CopyTo	Copies the HeaderDictionary elements to a one-dimensional Array instance at the specified index.
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	Get	Gets the associated value from the collection.
	GetCommaSeparatedValues	Parses out comma separated headers into individual values.
	GetEnumerator	Returns an enumerator that iterates through a collection.
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	GetValues	Gets the associated values from the collection in their original format. Returns null if the key is not present.
	MemberwiseClone	(Inherited from Object.)
	Remove(KeyValuePair<String, array<String[]>)	Indicates whether the specified object can be removed in the collection.
	Remove(String)	Indicates whether the specified object can be removed in the collection.
	Set	Sets a specific header value.
	SetCommaSeparatedValues	Quotes any values containing comas, and then coma joins all of the values.
	SetValues	Sets the specified header values without modification.
	ToString	(Inherited from Object.)
	TryGetValue	Indicates whether the HeaderDictionary tries to get the value.

Top

Explicit Interface Implementations

	Name	Description
	IEnumerable.GetEnumerator	Returns an enumerator that iterates through a collection.
	IDictionary<String, array<String[]>.Item	Gets or sets an ICollection that contains the keys in the HeaderDictionary.