WebHeaderCollection Class

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Contains protocol headers associated with a request or response.

Namespace:   System.Net
Assembly:  System (in System.dll)


[SerializableAttribute]
[ComVisibleAttribute(true)]
public ref class WebHeaderCollection : NameValueCollection, ISerializable

NameDescription
System_CAPS_pubmethodWebHeaderCollection()

Initializes a new instance of the WebHeaderCollection class.

System_CAPS_protmethodWebHeaderCollection(SerializationInfo^, StreamingContext)

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

NameDescription
System_CAPS_pubpropertyAllKeys

Gets all header names (keys) in the collection.(Overrides NameValueCollection::AllKeys.)

System_CAPS_pubpropertyCount

Gets the number of headers in the collection.(Overrides NameObjectCollectionBase::Count.)

System_CAPS_protpropertyIsReadOnly

Gets or sets a value indicating whether the NameObjectCollectionBase instance is read-only.(Inherited from NameObjectCollectionBase.)

System_CAPS_pubpropertyItem[HttpRequestHeader]

Gets or sets the specified request header.

System_CAPS_pubpropertyItem[HttpResponseHeader]

Gets or sets the specified response header.

System_CAPS_pubpropertyItem[Int32]

Gets the entry at the specified index of the NameValueCollection.(Inherited from NameValueCollection.)

System_CAPS_pubpropertyItem[String^]

Gets or sets the entry with the specified key in the NameValueCollection.(Inherited from NameValueCollection.)

System_CAPS_pubpropertyKeys

Gets the collection of header names (keys) in the collection.(Overrides NameObjectCollectionBase::Keys.)

NameDescription
System_CAPS_pubmethodAdd(HttpRequestHeader, String^)

Inserts the specified header with the specified value into the collection.

System_CAPS_pubmethodAdd(HttpResponseHeader, String^)

Inserts the specified header with the specified value into the collection.

System_CAPS_pubmethodAdd(NameValueCollection^)

Copies the entries in the specified NameValueCollection to the current NameValueCollection.(Inherited from NameValueCollection.)

System_CAPS_pubmethodAdd(String^)

Inserts the specified header into the collection.

System_CAPS_pubmethodAdd(String^, String^)

Inserts a header with the specified name and value into the collection.(Overrides NameValueCollection::Add(String^, String^).)

System_CAPS_protmethodAddWithoutValidate(String^, String^)

Inserts a header into the collection without checking whether the header is on the restricted header list.

System_CAPS_protmethodBaseAdd(String^, Object^)

Adds an entry with the specified key and value into the NameObjectCollectionBase instance.(Inherited from NameObjectCollectionBase.)

System_CAPS_protmethodBaseClear()

Removes all entries from the NameObjectCollectionBase instance.(Inherited from NameObjectCollectionBase.)

System_CAPS_protmethodBaseGet(Int32)

Gets the value of the entry at the specified index of the NameObjectCollectionBase instance.(Inherited from NameObjectCollectionBase.)

System_CAPS_protmethodBaseGet(String^)

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

System_CAPS_protmethodBaseGetAllKeys()

Returns a String array that contains all the keys in the NameObjectCollectionBase instance.(Inherited from NameObjectCollectionBase.)

System_CAPS_protmethodBaseGetAllValues()

Returns an Object array that contains all the values in the NameObjectCollectionBase instance.(Inherited from NameObjectCollectionBase.)

System_CAPS_protmethodBaseGetAllValues(Type^)

Returns an array of the specified type that contains all the values in the NameObjectCollectionBase instance.(Inherited from NameObjectCollectionBase.)

System_CAPS_protmethodBaseGetKey(Int32)

Gets the key of the entry at the specified index of the NameObjectCollectionBase instance.(Inherited from NameObjectCollectionBase.)

System_CAPS_protmethodBaseHasKeys()

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

System_CAPS_protmethodBaseRemove(String^)

Removes the entries with the specified key from the NameObjectCollectionBase instance.(Inherited from NameObjectCollectionBase.)

System_CAPS_protmethodBaseRemoveAt(Int32)

Removes the entry at the specified index of the NameObjectCollectionBase instance.(Inherited from NameObjectCollectionBase.)

System_CAPS_protmethodBaseSet(Int32, Object^)

Sets the value of the entry at the specified index of the NameObjectCollectionBase instance.(Inherited from NameObjectCollectionBase.)

System_CAPS_protmethodBaseSet(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.)

System_CAPS_pubmethodClear()

Removes all headers from the collection.(Overrides NameValueCollection::Clear().)

System_CAPS_pubmethodCopyTo(Array^, Int32)

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

System_CAPS_pubmethodEquals(Object^)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGet(Int32)

Gets the value of a particular header in the collection, specified by an index into the collection.(Overrides NameValueCollection::Get(Int32).)

System_CAPS_pubmethodGet(String^)

Gets the value of a particular header in the collection, specified by the name of the header.(Overrides NameValueCollection::Get(String^).)

System_CAPS_pubmethodGetEnumerator()

Returns an enumerator that can iterate through the WebHeaderCollection instance.(Overrides NameObjectCollectionBase::GetEnumerator().)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetKey(Int32)

Gets the header name at the specified position in the collection.(Overrides NameValueCollection::GetKey(Int32).)

System_CAPS_pubmethodGetObjectData(SerializationInfo^, StreamingContext)

This API supports the product infrastructure and is not intended to be used directly from your code. Populates a SerializationInfo with the data needed to serialize the target object.(Overrides NameObjectCollectionBase::GetObjectData(SerializationInfo^, StreamingContext).)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodGetValues(Int32)

Gets an array of header values stored in the index position of the header collection.(Overrides NameValueCollection::GetValues(Int32).)

System_CAPS_pubmethodGetValues(String^)

Gets an array of header values stored in a header.(Overrides NameValueCollection::GetValues(String^).)

System_CAPS_pubmethodHasKeys()

Gets a value indicating whether the NameValueCollection contains keys that are not null.(Inherited from NameValueCollection.)

System_CAPS_protmethodInvalidateCachedArrays()

Resets the cached arrays of the collection to null.(Inherited from NameValueCollection.)

System_CAPS_pubmethodSystem_CAPS_staticIsRestricted(String^)

Tests whether the specified HTTP header can be set for the request.

System_CAPS_pubmethodSystem_CAPS_staticIsRestricted(String^, Boolean)

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

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodOnDeserialization(Object^)

Implements the ISerializable interface and raises the deserialization event when the deserialization is complete.(Overrides NameObjectCollectionBase::OnDeserialization(Object^).)

System_CAPS_pubmethodRemove(HttpRequestHeader)

Removes the specified header from the collection.

System_CAPS_pubmethodRemove(HttpResponseHeader)

Removes the specified header from the collection.

System_CAPS_pubmethodRemove(String^)

Removes the specified header from the collection.(Overrides NameValueCollection::Remove(String^).)

System_CAPS_pubmethodSet(HttpRequestHeader, String^)

Sets the specified header to the specified value.

System_CAPS_pubmethodSet(HttpResponseHeader, String^)

Sets the specified header to the specified value.

System_CAPS_pubmethodSet(String^, String^)

Sets the specified header to the specified value.(Overrides NameValueCollection::Set(String^, String^).)

System_CAPS_pubmethodToByteArray()

This API supports the product infrastructure and is not intended to be used directly from your code. Converts the WebHeaderCollection to a byte array..

System_CAPS_pubmethodToString()

This API supports the product infrastructure and is not intended to be used directly from your code. This method is obsolete.(Overrides Object::ToString().)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodICollection::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.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodISerializable::GetObjectData(SerializationInfo^, StreamingContext)

This API supports the product infrastructure and is not intended to be used directly from your code. Serializes this instance into the specified SerializationInfo object.

System_CAPS_pubinterfaceSystem_CAPS_privpropertyICollection::IsSynchronized

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

System_CAPS_pubinterfaceSystem_CAPS_privpropertyICollection::SyncRoot

Gets an object that can be used to synchronize access to the NameObjectCollectionBase object.(Inherited from NameObjectCollectionBase.)

NameDescription
System_CAPS_pubmethodAsParallel()

Overloaded. Enables parallelization of a query.(Defined by ParallelEnumerable.)

System_CAPS_pubmethodAsQueryable()

Overloaded. Converts an IEnumerable to an IQueryable.(Defined by Queryable.)

System_CAPS_pubmethodCast<TResult>()

Casts the elements of an IEnumerable to the specified type.(Defined by Enumerable.)

System_CAPS_pubmethodOfType<TResult>()

Filters the elements of an IEnumerable based on a specified type.(Defined by Enumerable.)

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

  • Referrer

  • Transfer-Encoding

  • User-Agent

  • Proxy-Connection

Universal Windows Platform
Available since 8
.NET Framework
Available since 1.1
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: