WebHeaderCollection WebHeaderCollection WebHeaderCollection WebHeaderCollection Class

Definition

Namespace:
System.Net System.Net System.Net System.Net
Assemblies:
System.Net.WebHeaderCollection.dll, System.dll, netstandard.dll, System.Net.Requests.dll, System.Net.dll

Contains protocol headers associated with a request or response.

public ref class WebHeaderCollection : System::Collections::Specialized::NameValueCollection, System::Runtime::Serialization::ISerializable
[System.Runtime.InteropServices.ComVisible(true)]
[System.Serializable]
public class WebHeaderCollection : System.Collections.Specialized.NameValueCollection, System.Runtime.Serialization.ISerializable
type WebHeaderCollection = class
    inherit NameValueCollection
    interface ISerializable
Public Class WebHeaderCollection
Inherits NameValueCollection
Implements ISerializable
Inheritance
ObjectObjectObjectObject
NameObjectCollectionBaseNameObjectCollectionBaseNameObjectCollectionBaseNameObjectCollectionBase
NameValueCollectionNameValueCollectionNameValueCollectionNameValueCollection
WebHeaderCollectionWebHeaderCollectionWebHeaderCollectionWebHeaderCollection
Attributes
ComVisibleAttribute SerializableAttribute
Implements
ISerializableISerializableISerializableISerializable

Remarks

The WebHeaderCollection class is generally accessed through WebRequest.Headers or WebResponse.Headers. Some common headers are considered restricted and are either exposed directly by the API (such as Content-Type) or protected by the system and cannot be changed.

The restricted headers are:

  • Accept

  • Connection

  • Content-Length

  • Content-Type

  • Date

  • Expect

  • Host

  • If-Modified-Since

  • Range

  • Referer

  • Transfer-Encoding

  • User-Agent

  • Proxy-Connection

Constructors

WebHeaderCollection() WebHeaderCollection() WebHeaderCollection() WebHeaderCollection()

Initializes a new instance of the WebHeaderCollection class.
WebHeaderCollection(SerializationInfo, StreamingContext) WebHeaderCollection(SerializationInfo, StreamingContext) WebHeaderCollection(SerializationInfo, StreamingContext) WebHeaderCollection(SerializationInfo, StreamingContext)

Initializes a new instance of the WebHeaderCollection class from the specified instances of the SerializationInfo and StreamingContext classes.

Properties

AllKeys AllKeys AllKeys AllKeys

Gets all header names (keys) in the collection.
Count Count Count Count

Gets the number of headers in the collection.
ICollection.IsSynchronized ICollection.IsSynchronized ICollection.IsSynchronized ICollection.IsSynchronized

Gets a value indicating whether access to the NameObjectCollectionBase object is synchronized (thread safe).

(Inherited from NameObjectCollectionBase)
ICollection.SyncRoot ICollection.SyncRoot ICollection.SyncRoot ICollection.SyncRoot

Gets an object that can be used to synchronize access to the NameObjectCollectionBase object.

(Inherited from NameObjectCollectionBase)
IsReadOnly IsReadOnly IsReadOnly IsReadOnly

Gets or sets a value indicating whether the NameObjectCollectionBase instance is read-only.

(Inherited from NameObjectCollectionBase)
Item[HttpRequestHeader] Item[HttpRequestHeader] Item[HttpRequestHeader] Item[HttpRequestHeader]

Gets or sets the specified request header.
Item[HttpResponseHeader] Item[HttpResponseHeader] Item[HttpResponseHeader] Item[HttpResponseHeader]

Gets or sets the specified response header.
Item[Int32] Item[Int32] Item[Int32] Item[Int32]

Gets the entry at the specified index of the NameValueCollection.

(Inherited from NameValueCollection)
Item[String] Item[String] Item[String] Item[String]
Keys Keys Keys Keys

Gets the collection of header names (keys) in the collection.

Methods

Add(HttpRequestHeader, String) Add(HttpRequestHeader, String) Add(HttpRequestHeader, String) Add(HttpRequestHeader, String)

Inserts the specified header with the specified value into the collection.
Add(HttpResponseHeader, String) Add(HttpResponseHeader, String) Add(HttpResponseHeader, String) Add(HttpResponseHeader, String)

Inserts the specified header with the specified value into the collection.
Add(NameValueCollection) Add(NameValueCollection) Add(NameValueCollection) Add(NameValueCollection)

Copies the entries in the specified NameValueCollection to the current NameValueCollection.

(Inherited from NameValueCollection)
Add(String) Add(String) Add(String) Add(String)

Inserts the specified header into the collection.
Add(String, String) Add(String, String) Add(String, String) Add(String, String)

Inserts a header with the specified name and value into the collection.
AddWithoutValidate(String, String) AddWithoutValidate(String, String) AddWithoutValidate(String, String) AddWithoutValidate(String, String)

Inserts a header into the collection without checking whether the header is on the restricted header list.
BaseAdd(String, Object) BaseAdd(String, Object) BaseAdd(String, Object) BaseAdd(String, Object)

Adds an entry with the specified key and value into the NameObjectCollectionBase instance.

(Inherited from NameObjectCollectionBase)
BaseClear() BaseClear() BaseClear() BaseClear()

Removes all entries from the NameObjectCollectionBase instance.

(Inherited from NameObjectCollectionBase)
BaseGet(Int32) BaseGet(Int32) BaseGet(Int32) BaseGet(Int32)

Gets the value of the entry at the specified index of the NameObjectCollectionBase instance.

(Inherited from NameObjectCollectionBase)
BaseGet(String) BaseGet(String) BaseGet(String) BaseGet(String)

Gets the value of the first entry with the specified key from the NameObjectCollectionBase instance.

(Inherited from NameObjectCollectionBase)
BaseGetAllKeys() BaseGetAllKeys() BaseGetAllKeys() BaseGetAllKeys()

Returns a String array that contains all the keys in the NameObjectCollectionBase instance.

(Inherited from NameObjectCollectionBase)
BaseGetAllValues() BaseGetAllValues() BaseGetAllValues() BaseGetAllValues()

Returns an Object array that contains all the values in the NameObjectCollectionBase instance.

(Inherited from NameObjectCollectionBase)
BaseGetAllValues(Type) BaseGetAllValues(Type) BaseGetAllValues(Type) BaseGetAllValues(Type)

Returns an array of the specified type that contains all the values in the NameObjectCollectionBase instance.

(Inherited from NameObjectCollectionBase)
BaseGetKey(Int32) BaseGetKey(Int32) BaseGetKey(Int32) BaseGetKey(Int32)

Gets the key of the entry at the specified index of the NameObjectCollectionBase instance.

(Inherited from NameObjectCollectionBase)
BaseHasKeys() BaseHasKeys() BaseHasKeys() BaseHasKeys()

Gets a value indicating whether the NameObjectCollectionBase instance contains entries whose keys are not null.

(Inherited from NameObjectCollectionBase)
BaseRemove(String) BaseRemove(String) BaseRemove(String) BaseRemove(String)

Removes the entries with the specified key from the NameObjectCollectionBase instance.

(Inherited from NameObjectCollectionBase)
BaseRemoveAt(Int32) BaseRemoveAt(Int32) BaseRemoveAt(Int32) BaseRemoveAt(Int32)

Removes the entry at the specified index of the NameObjectCollectionBase instance.

(Inherited from NameObjectCollectionBase)
BaseSet(Int32, Object) BaseSet(Int32, Object) BaseSet(Int32, Object) BaseSet(Int32, Object)

Sets the value of the entry at the specified index of the NameObjectCollectionBase instance.

(Inherited from NameObjectCollectionBase)
BaseSet(String, Object) BaseSet(String, Object) BaseSet(String, Object) BaseSet(String, Object)

Sets the value of the first entry with the specified key in the NameObjectCollectionBase instance, if found; otherwise, adds an entry with the specified key and value into the NameObjectCollectionBase instance.

(Inherited from NameObjectCollectionBase)
Clear() Clear() Clear() Clear()

Removes all headers from the collection.
CopyTo(Array, Int32) CopyTo(Array, Int32) CopyTo(Array, Int32) CopyTo(Array, Int32)

Copies the entire NameValueCollection to a compatible one-dimensional Array, starting at the specified index of the target array.

(Inherited from NameValueCollection)
Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
Get(Int32) Get(Int32) Get(Int32) Get(Int32)

Gets the value of a particular header in the collection, specified by an index into the collection.
Get(String) Get(String) Get(String) Get(String)

Gets the value of a particular header in the collection, specified by the name of the header.
GetEnumerator() GetEnumerator() GetEnumerator() GetEnumerator()

Returns an enumerator that can iterate through the WebHeaderCollection instance.
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetKey(Int32) GetKey(Int32) GetKey(Int32) GetKey(Int32)

Gets the header name at the specified position in the collection.
GetObjectData(SerializationInfo, StreamingContext) GetObjectData(SerializationInfo, StreamingContext) GetObjectData(SerializationInfo, StreamingContext) GetObjectData(SerializationInfo, StreamingContext)

Populates a SerializationInfo with the data needed to serialize the target object.
GetType() GetType() GetType() GetType()

Gets the Type of the current instance.

(Inherited from Object)
GetValues(Int32) GetValues(Int32) GetValues(Int32) GetValues(Int32)

Gets an array of header values stored in the index position of the header collection.
GetValues(String) GetValues(String) GetValues(String) GetValues(String)

Gets an array of header values stored in a header.
HasKeys() HasKeys() HasKeys() HasKeys()

Gets a value indicating whether the NameValueCollection contains keys that are not null.

(Inherited from NameValueCollection)
InvalidateCachedArrays() InvalidateCachedArrays() InvalidateCachedArrays() InvalidateCachedArrays()

Resets the cached arrays of the collection to null.

(Inherited from NameValueCollection)
IsRestricted(String) IsRestricted(String) IsRestricted(String) IsRestricted(String)

Tests whether the specified HTTP header can be set for the request.
IsRestricted(String, Boolean) IsRestricted(String, Boolean) IsRestricted(String, Boolean) IsRestricted(String, Boolean)

Tests whether the specified HTTP header can be set for the request or the response.
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
OnDeserialization(Object) OnDeserialization(Object) OnDeserialization(Object) OnDeserialization(Object)

Implements the ISerializable interface and raises the deserialization event when the deserialization is complete.
Remove(HttpRequestHeader) Remove(HttpRequestHeader) Remove(HttpRequestHeader) Remove(HttpRequestHeader)

Removes the specified header from the collection.
Remove(HttpResponseHeader) Remove(HttpResponseHeader) Remove(HttpResponseHeader) Remove(HttpResponseHeader)

Removes the specified header from the collection.
Remove(String) Remove(String) Remove(String) Remove(String)

Removes the specified header from the collection.
Set(HttpRequestHeader, String) Set(HttpRequestHeader, String) Set(HttpRequestHeader, String) Set(HttpRequestHeader, String)

Sets the specified header to the specified value.
Set(HttpResponseHeader, String) Set(HttpResponseHeader, String) Set(HttpResponseHeader, String) Set(HttpResponseHeader, String)

Sets the specified header to the specified value.
Set(String, String) Set(String, String) Set(String, String) Set(String, String)

Sets the specified header to the specified value.
ToByteArray() ToByteArray() ToByteArray() ToByteArray()

Converts the WebHeaderCollection to a byte array.
ToString() ToString() ToString() ToString()

This method is obsolete.

Explicit Interface Implementations

ICollection.CopyTo(Array, Int32) ICollection.CopyTo(Array, Int32) ICollection.CopyTo(Array, Int32) ICollection.CopyTo(Array, Int32)

Copies the entire NameObjectCollectionBase to a compatible one-dimensional Array, starting at the specified index of the target array.

(Inherited from NameObjectCollectionBase)
IEnumerable.GetEnumerator() IEnumerable.GetEnumerator() IEnumerable.GetEnumerator() IEnumerable.GetEnumerator()
ISerializable.GetObjectData(SerializationInfo, StreamingContext) ISerializable.GetObjectData(SerializationInfo, StreamingContext) ISerializable.GetObjectData(SerializationInfo, StreamingContext) ISerializable.GetObjectData(SerializationInfo, StreamingContext)

Serializes this instance into the specified SerializationInfo object.

Extension Methods

Cast<TResult>(IEnumerable) Cast<TResult>(IEnumerable) Cast<TResult>(IEnumerable) Cast<TResult>(IEnumerable)

Casts the elements of an IEnumerable to the specified type.
OfType<TResult>(IEnumerable) OfType<TResult>(IEnumerable) OfType<TResult>(IEnumerable) OfType<TResult>(IEnumerable)

Filters the elements of an IEnumerable based on a specified type.
AsParallel(IEnumerable) AsParallel(IEnumerable) AsParallel(IEnumerable) AsParallel(IEnumerable)

Enables parallelization of a query.
AsQueryable(IEnumerable) AsQueryable(IEnumerable) AsQueryable(IEnumerable) AsQueryable(IEnumerable)

Converts an IEnumerable to an IQueryable.

Applies to