Skip to main content
HttpContentCodingWithQualityHeaderValueCollection class

Applies to Windows and Windows Phone

Represents the value of the Accept-Encoding HTTP header on an HTTP request.

Syntax


var httpContentCodingWithQualityHeaderValueCollection = acceptEncoding;

public sealed class HttpContentCodingWithQualityHeaderValueCollection : IList<HttpContentCodingWithQualityHeaderValue>,
    IEnumerable<HttpContentCodingWithQualityHeaderValue>,
    IStringable

Public NotInheritable Class HttpContentCodingWithQualityHeaderValueCollection
    Implements IList(Of HttpContentCodingWithQualityHeaderValue), _
    IEnumerable(Of HttpContentCodingWithQualityHeaderValue), _
    IStringable

public ref class HttpContentCodingWithQualityHeaderValueCollection sealed : IVector<HttpContentCodingWithQualityHeaderValue>,
    IIterable<HttpContentCodingWithQualityHeaderValue>,
    IStringable

Attributes

[ DualApiPartition()]
[ MarshalingBehavior(Agile)]
[ Threading(Both)]
[ Version(0x06030000)]

Members

The HttpContentCodingWithQualityHeaderValueCollection class has these types of members:

Methods

The HttpContentCodingWithQualityHeaderValueCollection class has these methods. With C#, Visual Basic, and C++, it also inherits methods from the Object class.

MethodDescription
Add [C#, VB]Adds a new item to the end of the collection.
Append [C++, JavaScript]Adds a new HttpContentCodingWithQualityHeaderValue item to the end of the collection.
Clear Removes all objects from the collection.
Contains [C#, VB]Determines whether an element is in the collection.
CopyTo [C#, VB]Copies the elements of the collection to an array, starting at a particular array index in the destination array.
First [C++, JavaScript]Retrieves an iterator to the first HttpContentCodingWithQualityHeaderValue item in the collection.
GetAt [C++, JavaScript]Returns the HttpContentCodingWithQualityHeaderValue at the specified index in the collection.
GetMany [C++, JavaScript]Retrieves the HttpContentCodingWithQualityHeaderValue items that start at the specified index in the collection.
GetView [C++, JavaScript]Returns an immutable view of the HttpContentCodingWithQualityHeaderValueCollection.
IndexOf [C++, JavaScript]Retrieves the index of an HttpContentCodingWithQualityHeaderValue in the collection.
IndexOf [C#, VB]Determines the index of a specific item in the collection.
Insert [C#, VB]Inserts an item into the collection at the specified index.
InsertAt [C++, JavaScript]Inserts an HttpContentCodingWithQualityHeaderValue into the collection at the specified index.
ParseAdd Parses and adds an entry to the HttpContentCodingWithQualityHeaderValueCollection.
Remove [C#, VB]Removes a specific object from the collection.
RemoveAt [C++, JavaScript]Removes the entry at the specified index from the HttpContentCodingWithQualityHeaderValueCollection.
RemoveAt [C#, VB]Removes the element at the specified index of the collection.
RemoveAtEnd [C++, JavaScript]Removes the last HttpContentCodingWithQualityHeaderValue item from the collection.
ReplaceAll [C++, JavaScript]Replaces all the HttpContentCodingWithQualityHeaderValue items in the collection with the specified HttpContentCodingWithQualityHeaderValue items.
SetAt [C++, JavaScript]Sets the HttpContentCodingWithQualityHeaderValue at the specified index in the collection.
ToString Returns a string that represents the current HttpContentCodingWithQualityHeaderValueCollection object.
TryParseAdd Tries to parse and add the specified item to the HttpContentCodingWithQualityHeaderValueCollection.

 

Properties

The HttpContentCodingWithQualityHeaderValueCollection class has these properties.

PropertyAccess typeDescription

Count [C#, VB]

Read-onlyGets the number of elements that are contained in the collection.

IsReadOnly [C#, VB]

Read-onlyGets a value indicating whether the collection is read-only.

Item [C#, VB]

Read/writeGets or sets the element at the specified index.

Size [C++, JavaScript]

Read-onlyGets the number of HttpContentCodingWithQualityHeaderValue objects in the collection.

 

Remarks

The HttpContentCodingWithQualityHeaderValueCollection class represents the value of the Accept-Encoding HTTP header on an HTTP request.

The HttpContentCodingWithQualityHeaderValueCollection provides a collection container for instances of the HttpContentCodingWithQualityHeaderValue class used for accept encoding information in the Accept-Encoding HTTP header.

The AcceptEncoding property on the HttpRequestHeaderCollection returns an HttpContentCodingWithQualityHeaderValueCollection object. This is the method used to construct an HttpContentCodingWithQualityHeaderValueCollection object.

Collection member lists

For JavaScript, HttpContentCodingWithQualityHeaderValueCollection has the members shown in the member lists. In addition, HttpContentCodingWithQualityHeaderValueCollection supports members of Array.prototype and using an index to access items.

Enumerating the collection in C# or Microsoft Visual Basic

You can iterate through an HttpContentCodingWithQualityHeaderValueCollection object in C# or Microsoft Visual Basic. In many cases, such as using foreach syntax, the compiler does this casting for you and you won't need to cast to IEnumerable<HttpContentCodingWithQualityHeaderValue> explicitly. If you do need to cast explicitly, for example if you want to call GetEnumerator, cast the collection object to IEnumerable<T> with an HttpContentCodingWithQualityHeaderValue constraint.

Examples

The following sample code shows a method to get and set the Accept-Encoding HTTP header on an HttpRequestMessage object using the properties and methods on the HttpContentCodingWithQualityHeaderValueCollection and HttpContentCodingWithQualityHeaderValue classes.


using Windows.Web.Http;
using Windows.Web.Http.Headers;

        public void DemonstrateHeaderRequestAcceptEncoding()
        {
            var request = new HttpRequestMessage();
            bool parsedOk = false;

            // Set the header with a string.
            parsedOk = request.Headers.AcceptEncoding.TryParseAdd("compress");
            parsedOk = request.Headers.AcceptEncoding.TryParseAdd("gzip;q=1.0");

            // Set the header with a strong type.
            request.Headers.AcceptEncoding.Add(new HttpContentCodingWithQualityHeaderValue("*", 0));

            // Get the strong type out
            foreach (var value in request.Headers.AcceptEncoding)
            {
                System.Diagnostics.Debug.WriteLine("One of the AcceptEncoding values: {0}={1}", value.ContentCoding, value.Quality);
            }

            // The ToString() is useful for diagnostics, too.
            System.Diagnostics.Debug.WriteLine("The AcceptEncoding ToString() results: {0}", request.Headers.AcceptEncoding.ToString());
        }

Requirements

Minimum supported client

Windows 8.1 [Windows Store apps, desktop apps]

Minimum supported server

Windows Server 2012 R2 [Windows Store apps, desktop apps]

Minimum supported phone

Windows Phone 8.1 [Windows Phone Silverlight 8.1 and Windows Runtime apps]

Namespace

Windows.Web.Http.Headers
Windows::Web::Http::Headers [C++]

Metadata

Windows.winmd

See also

AcceptEncoding
HttpContentCodingWithQualityHeaderValue
HttpRequestHeaderCollection
HttpRequestMessage
IIterable(HttpContentCodingWithQualityHeaderValue)
IStringable
IVector(HttpContentCodingWithQualityHeaderValue)
Object