Http​Language​Range​With​Quality​Header​Value​Collection Http​Language​Range​With​Quality​Header​Value​Collection Http​Language​Range​With​Quality​Header​Value​Collection Class

Definition

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

public : sealed class HttpLanguageRangeWithQualityHeaderValueCollection : IIterable, IVector, IStringable, IHttpLanguageRangeWithQualityHeaderValueCollectionpublic sealed class HttpLanguageRangeWithQualityHeaderValueCollection : IEnumerable, IList, IStringable, IHttpLanguageRangeWithQualityHeaderValueCollectionPublic NotInheritable Class HttpLanguageRangeWithQualityHeaderValueCollection Implements IEnumerable, IList, IStringable, IHttpLanguageRangeWithQualityHeaderValueCollection
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Examples

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

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

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

            // Set the header with a string.
            parsedOk = request.Headers.AcceptLanguage.TryParseAdd("da");
            parsedOk = request.Headers.AcceptLanguage.TryParseAdd("en-gb;q=0.8");

            // Set the header with a strong type.
            request.Headers.AcceptLanguage.Add(new HttpLanguageRangeWithQualityHeaderValue("en", .7));

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

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

Remarks

The HttpLanguageRangeWithQualityHeaderValueCollection class represents the value of the Accept-Language HTTP header on an HTTP request.

The HttpLanguageRangeWithQualityHeaderValueCollection provides a collection container for instances of the HttpLanguageRangeWithQualityHeaderValue class used for accept language information in the Accept-Language HTTP header.

The AcceptLanguage property on the HttpRequestHeaderCollection returns an HttpLanguageRangeWithQualityHeaderValueCollection object.

Properties

Item[Int32] Item[Int32] Item[Int32]

Gets or sets the element at the specified index.

This member is not implemented in C++T this[int index] { get; set; }Property Item(index As Integer) As T
Parameters
index

The zero-based index of the element to get or set.

Value
T T T

The element at the specified index.

Attributes
Exceptions

index is not a valid index in the System.Collections.Generic.IList`1.

The property is set and the System.Collections.Generic.IList`1 is read-only.

Size Size Size

Gets the number of HttpLanguageRangeWithQualityHeaderValue objects in the collection.

public : unsigned short Size { get; }This member is not implemented in C#This member is not implemented in VB.Net
Value
unsigned short uint uint

The number of HttpLanguageRangeWithQualityHeaderValue objects in the HttpLanguageRangeWithQualityHeaderValueCollection.

Attributes

Methods

Append(HttpLanguageRangeWithQualityHeaderValue) Append(HttpLanguageRangeWithQualityHeaderValue) Append(HttpLanguageRangeWithQualityHeaderValue)

Adds a new HttpLanguageRangeWithQualityHeaderValue item to the end of the collection.

public : void Append(HttpLanguageRangeWithQualityHeaderValue value)This member is not implemented in C#This member is not implemented in VB.Net
Parameters
Attributes

Clear() Clear() Clear()

Removes all objects from the collection.

public : void Clear()This member is not implemented in C#This member is not implemented in VB.Net
Attributes

First() First() First()

Retrieves an iterator to the first HttpLanguageRangeWithQualityHeaderValue item in the collection.

public : IIterator<HttpLanguageRangeWithQualityHeaderValue> First()This member is not implemented in C#This member is not implemented in VB.Net
Returns
Attributes

GetAt(UInt32) GetAt(UInt32) GetAt(UInt32)

Returns the HttpLanguageRangeWithQualityHeaderValue at the specified index in the collection.

public : HttpLanguageRangeWithQualityHeaderValue GetAt(unsigned int index)This member is not implemented in C#This member is not implemented in VB.Net
Parameters
index
unsigned int UInt32 UInt32

The zero-based index of a specified item in the collection.

Returns
Attributes

GetEnumerator() GetEnumerator() GetEnumerator()

Returns an enumerator that iterates through the collection.

This member is not implemented in C++IEnumerator<T> GetEnumerator()Function GetEnumerator As IEnumerator(Of T)
Returns

An enumerator that can be used to iterate through the collection.

Attributes

GetMany(UInt32, HttpLanguageRangeWithQualityHeaderValue[]) GetMany(UInt32, HttpLanguageRangeWithQualityHeaderValue[]) GetMany(UInt32, HttpLanguageRangeWithQualityHeaderValue[])

Retrieves the HttpLanguageRangeWithQualityHeaderValue items that start at the specified index in the collection.

public : unsigned short GetMany(unsigned int startIndex, HttpLanguageRangeWithQualityHeaderValue[] items)This member is not implemented in C#This member is not implemented in VB.Net
Parameters
startIndex
unsigned int UInt32 UInt32

The zero-based index of the start of the HttpLanguageRangeWithQualityHeaderValue items in the HttpLanguageRangeWithQualityHeaderValueCollection.

items
HttpLanguageRangeWithQualityHeaderValue[] HttpLanguageRangeWithQualityHeaderValue[] HttpLanguageRangeWithQualityHeaderValue[]

An array of HttpLanguageRangeWithQualityHeaderValue items that start at startIndex in the HttpLanguageRangeWithQualityHeaderValueCollection.

Returns
unsigned short uint uint

The number of items retrieved.

Attributes

GetView() GetView() GetView()

Returns an immutable view of the HttpLanguageRangeWithQualityHeaderValueCollection.

public : IVectorView<HttpLanguageRangeWithQualityHeaderValue> GetView()This member is not implemented in C#This member is not implemented in VB.Net
Returns
IVectorView<HttpLanguageRangeWithQualityHeaderValue> IReadOnlyList<HttpLanguageRangeWithQualityHeaderValue> IReadOnlyList<HttpLanguageRangeWithQualityHeaderValue>

The view of the HttpLanguageRangeWithQualityHeaderValueCollection.

Attributes

IndexOf(T) IndexOf(T) IndexOf(T)

Determines the index of a specific item in the System.Collections.Generic.IList`1.

This member is not implemented in C++int IndexOf(T item)Function IndexOf(item As T) As Integer
Parameters
item
T T T

The object to locate in the System.Collections.Generic.IList`1.

Returns

The index of item if found in the list; otherwise, -1.

Attributes

IndexOf(HttpLanguageRangeWithQualityHeaderValue, UInt32) IndexOf(HttpLanguageRangeWithQualityHeaderValue, UInt32) IndexOf(HttpLanguageRangeWithQualityHeaderValue, UInt32)

Retrieves the index of an HttpLanguageRangeWithQualityHeaderValue in the collection.

public : PlatForm::Boolean IndexOf(HttpLanguageRangeWithQualityHeaderValue value, unsigned int index)This member is not implemented in C#This member is not implemented in VB.Net
Parameters
index
unsigned int UInt32 UInt32

The index of the HttpLanguageRangeWithQualityHeaderValue in the HttpLanguageRangeWithQualityHeaderValueCollection.

If the item is found, this is the zero-based index of the item; otherwise, this parameter is 0.

Returns
PlatForm::Boolean bool bool

Indicates whether the item is found.

true if the HttpLanguageRangeWithQualityHeaderValue item is found; otherwise, false.

Attributes

Insert(Int32, T) Insert(Int32, T) Insert(Int32, T)

Inserts an item to the System.Collections.Generic.IList`1 at the specified index.

This member is not implemented in C++void Insert(int index, T item)Sub Insert(index As Integer, item As T)
Parameters
index

The zero-based index at which item should be inserted.

item
T T T

The object to insert into the System.Collections.Generic.IList`1.

Attributes
Exceptions

index is not a valid index in the System.Collections.Generic.IList`1.

The System.Collections.Generic.IList`1 is read-only.

InsertAt(UInt32, HttpLanguageRangeWithQualityHeaderValue) InsertAt(UInt32, HttpLanguageRangeWithQualityHeaderValue) InsertAt(UInt32, HttpLanguageRangeWithQualityHeaderValue)

Inserts an HttpLanguageRangeWithQualityHeaderValue into the collection at the specified index.

public : void InsertAt(unsigned int index, HttpLanguageRangeWithQualityHeaderValue value)This member is not implemented in C#This member is not implemented in VB.Net
Parameters
index
unsigned int UInt32 UInt32

The zero-based index at which value should be inserted.

Attributes

ParseAdd(String) ParseAdd(String) ParseAdd(String)

Parses and adds an entry to the HttpLanguageRangeWithQualityHeaderValueCollection.

public : void ParseAdd(PlatForm::String input)public void ParseAdd(String input)Public Function ParseAdd(input As String) As void
Parameters
input
PlatForm::String String String

The entry to add.

Attributes

Remarks

Below are the exceptions that this function throws.

E_INVALIDARG

The input parameter is null (Nothing in Visual Basic).

The input parameter is not a valid value for the Accept-Language HTTP header.

RemoveAt(Int32) RemoveAt(Int32) RemoveAt(Int32)

Removes the System.Collections.Generic.IList`1 item at the specified index.

This member is not implemented in C++void RemoveAt(int index)Sub RemoveAt(index As Integer)
Parameters
index

The zero-based index of the item to remove.

Attributes
Exceptions

index is not a valid index in the System.Collections.Generic.IList`1.

The System.Collections.Generic.IList`1 is read-only.

RemoveAt(UInt32) RemoveAt(UInt32) RemoveAt(UInt32)

Removes the entry at the specified index from the HttpLanguageRangeWithQualityHeaderValueCollection.

public : void RemoveAt(unsigned int index)This member is not implemented in C#This member is not implemented in VB.Net
Parameters
index
unsigned int UInt32 UInt32

The index of the entry to remove.

Attributes

RemoveAtEnd() RemoveAtEnd() RemoveAtEnd()

Removes the last HttpLanguageRangeWithQualityHeaderValue item from the collection.

public : void RemoveAtEnd()This member is not implemented in C#This member is not implemented in VB.Net
Attributes

ReplaceAll(HttpLanguageRangeWithQualityHeaderValue[]) ReplaceAll(HttpLanguageRangeWithQualityHeaderValue[]) ReplaceAll(HttpLanguageRangeWithQualityHeaderValue[])

Replaces all the HttpLanguageRangeWithQualityHeaderValue items in the collection with the specified HttpLanguageRangeWithQualityHeaderValue items.

public : void ReplaceAll(HttpLanguageRangeWithQualityHeaderValue[] items)This member is not implemented in C#This member is not implemented in VB.Net
Parameters
items
HttpLanguageRangeWithQualityHeaderValue[] HttpLanguageRangeWithQualityHeaderValue[] HttpLanguageRangeWithQualityHeaderValue[]

The HttpLanguageRangeWithQualityHeaderValue items to add to the collection.

Attributes

SetAt(UInt32, HttpLanguageRangeWithQualityHeaderValue) SetAt(UInt32, HttpLanguageRangeWithQualityHeaderValue) SetAt(UInt32, HttpLanguageRangeWithQualityHeaderValue)

Sets the HttpLanguageRangeWithQualityHeaderValue at the specified index in the collection.

public : void SetAt(unsigned int index, HttpLanguageRangeWithQualityHeaderValue value)This member is not implemented in C#This member is not implemented in VB.Net
Parameters
index
unsigned int UInt32 UInt32

The zero-based index at which to set the HttpLanguageRangeWithQualityHeaderValue.

Attributes

ToString() ToString() ToString()

Returns a string that represents the current HttpLanguageRangeWithQualityHeaderValueCollection object.

public : PlatForm::String ToString()public string ToString()Public Function ToString() As string
Returns
PlatForm::String string string

A string that represents the current object.

Attributes

TryParseAdd(String) TryParseAdd(String) TryParseAdd(String)

Tries to parse and add the specified item to the HttpLanguageRangeWithQualityHeaderValueCollection.

public : PlatForm::Boolean TryParseAdd(PlatForm::String input)public bool TryParseAdd(String input)Public Function TryParseAdd(input As String) As bool
Parameters
input
PlatForm::String String String

The item to parse and add.

Returns
PlatForm::Boolean bool bool

true if the item successfully parsed and was added; otherwise false.

Attributes

See Also