This topic has not yet been rated - Rate this topic

UriTemplateMatch.BoundVariables Property

.NET Framework 4

Other Versions

Gets the BoundVariables collection for the template match.

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

Syntax

C++

Copy

public NameValueCollection BoundVariables { get; }

Property Value

Type: System.Collections.Specialized.NameValueCollection
A NameValueCollection instance that contains template variable values extracted from the URI during the match.

Remarks

Each template variable name appears as a name in this collection, and the value bound to that variable is stored under the corresponding name. The values in this collection have had all escape sequences translated into actual characters. This name value collection uses a case insensitive search when matching variable names.

Examples

The following code shows how to access the BoundVariables property.

Copy


UriTemplate template = new UriTemplate("weather/{state}/{city}?forecast=today");
Uri baseAddress = new Uri("http://localhost");
Uri fullUri = new Uri("http://localhost/weather/WA/Seattle?forecast=today");

Console.WriteLine("Matching {0} to {1}", template.ToString(), fullUri.ToString());

// Match a URI to a template
UriTemplateMatch results = template.Match(baseAddress, fullUri);
if (results != null)
{
    // BaseUri
    Console.WriteLine("BaseUri: {0}", results.BaseUri);

    Console.WriteLine("BoundVariables:");
    foreach (string variableName in results.BoundVariables.Keys)
    {
        Console.WriteLine("    {0}: {1}", variableName, results.BoundVariables[variableName]);
    }
}
// Code output:
// BaseUri: http://localhost/
// BoundVariables:
//  state: wa
//  city: seattleConsole.WriteLine("BaseUri: {0}", results.BaseUri);

Version Information

.NET Framework

Supported in: 4, 3.5

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Reference

UriTemplateMatch Class

System Namespace

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Community Content Add

FAQ

Concerning multiple instances of a query parameter

If you run the following code snippet:

UriTemplate template = new UriTemplate("?id={id}");
UriTemplateMatch match = template.Match(new Uri("http://localhost"), new Uri("http://localhost?id=1&id=2&id=,,,&id=4"));
Console.WriteLine(match.BoundVariables["id"]);

You'll get the following output:

1,2,,,,,4

It appears to be combining multiple occurrences of a parameter into a CSV list, but it would be nice if the documentation specified the behaviour of this class in this case.

History

7/12/2010
SheepNine