HttpLanguageRangeWithQualityHeaderValueCollection Class

Reference

Definition

Namespace:: Windows.Web.Http.Headers

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

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

public ref class HttpLanguageRangeWithQualityHeaderValueCollection sealed : IIterable<HttpLanguageRangeWithQualityHeaderValue ^>, IVector<HttpLanguageRangeWithQualityHeaderValue ^>, IStringable

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class HttpLanguageRangeWithQualityHeaderValueCollection final : IIterable<HttpLanguageRangeWithQualityHeaderValue>, IVector<HttpLanguageRangeWithQualityHeaderValue>, IStringable

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class HttpLanguageRangeWithQualityHeaderValueCollection final : IIterable<HttpLanguageRangeWithQualityHeaderValue>, IVector<HttpLanguageRangeWithQualityHeaderValue>, IStringable

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class HttpLanguageRangeWithQualityHeaderValueCollection : IEnumerable<HttpLanguageRangeWithQualityHeaderValue>, IList<HttpLanguageRangeWithQualityHeaderValue>, IStringable

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class HttpLanguageRangeWithQualityHeaderValueCollection : IEnumerable<HttpLanguageRangeWithQualityHeaderValue>, IList<HttpLanguageRangeWithQualityHeaderValue>, IStringable

Public NotInheritable Class HttpLanguageRangeWithQualityHeaderValueCollection
Implements IEnumerable(Of HttpLanguageRangeWithQualityHeaderValue), IList(Of HttpLanguageRangeWithQualityHeaderValue), IStringable

Inheritance: Object Platform::Object IInspectable HttpLanguageRangeWithQualityHeaderValueCollection

Attributes: ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Implements: IIterable<T> IEnumerable<T> IIterable<HttpLanguageRangeWithQualityHeaderValue> IEnumerable<HttpLanguageRangeWithQualityHeaderValue> IVector<HttpLanguageRangeWithQualityHeaderValue> IList<HttpLanguageRangeWithQualityHeaderValue> IStringable

Windows requirements

Device family	Windows 10 (introduced in 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v1.0)

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

Size	Gets the number of HttpLanguageRangeWithQualityHeaderValue objects in the collection.

Methods

Append(HttpLanguageRangeWithQualityHeaderValue)	Adds a new HttpLanguageRangeWithQualityHeaderValue item to the end of the collection.
Clear()	Removes all objects from the collection.
First()	Retrieves an iterator to the first HttpLanguageRangeWithQualityHeaderValue item in the collection.
GetAt(UInt32)	Returns the HttpLanguageRangeWithQualityHeaderValue at the specified index in the collection.
GetMany(UInt32, HttpLanguageRangeWithQualityHeaderValue[])	Retrieves the HttpLanguageRangeWithQualityHeaderValue items that start at the specified index in the collection.
GetView()	Returns an immutable view of the HttpLanguageRangeWithQualityHeaderValueCollection.
IndexOf(HttpLanguageRangeWithQualityHeaderValue, UInt32)	Retrieves the index of an HttpLanguageRangeWithQualityHeaderValue in the collection.
InsertAt(UInt32, HttpLanguageRangeWithQualityHeaderValue)	Inserts an HttpLanguageRangeWithQualityHeaderValue into the collection at the specified index.
ParseAdd(String)	Parses and adds an entry to the HttpLanguageRangeWithQualityHeaderValueCollection.
RemoveAt(UInt32)	Removes the entry at the specified index from the HttpLanguageRangeWithQualityHeaderValueCollection.
RemoveAtEnd()	Removes the last HttpLanguageRangeWithQualityHeaderValue item from the collection.
ReplaceAll(HttpLanguageRangeWithQualityHeaderValue[])	Replaces all the HttpLanguageRangeWithQualityHeaderValue items in the collection with the specified HttpLanguageRangeWithQualityHeaderValue items.
SetAt(UInt32, HttpLanguageRangeWithQualityHeaderValue)	Sets the HttpLanguageRangeWithQualityHeaderValue at the specified index in the collection.
ToString()	Returns a string that represents the current HttpLanguageRangeWithQualityHeaderValueCollection object.
TryParseAdd(String)	Tries to parse and add the specified item to the HttpLanguageRangeWithQualityHeaderValueCollection.

Applies to