This documentation is archived and is not being maintained.

UriTemplateMatch Class

A class that represents the results of a match operation on a UriTemplate instance.


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

public class UriTemplateMatch

The UriTemplateMatch type exposes the following members.

Public methodUriTemplateMatchInitializes a new instance of the UriTemplateMatch class.

Public propertyBaseUriGets and sets the base URI for the template match.
Public propertyBoundVariablesGets the BoundVariables collection for the template match.
Public propertyDataGets and sets the object associated with the UriTemplateMatch instance.
Public propertyQueryParametersGets a collection of query string parameters and their values.
Public propertyRelativePathSegmentsGets a collection of relative path segments.
Public propertyRequestUriGets and sets the matched URI.
Public propertyTemplateGets and sets the UriTemplate instance associated with this UriTemplateMatch instance.
Public propertyWildcardPathSegmentsGets a collection of path segments that are matched by a wildcard in the URI template.

Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

The UriTemplateMatch class represents the results of calling the Match(Uri, Uri) method. This class is not thread safe.

The following code shows how to use the UriTemplateMatch class.

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);

    foreach (string variableName in results.BoundVariables.Keys)
        Console.WriteLine("    {0}: {1}", variableName, results.BoundVariables[variableName]);

    foreach (string queryName in results.QueryParameters.Keys)
        Console.WriteLine("    {0} : {1}", queryName, results.QueryParameters[queryName]);

    foreach (string segment in results.RelativePathSegments)
        Console.WriteLine("     {0}", segment);



    foreach (string segment in results.WildcardPathSegments)
        Console.WriteLine("     {0}", segment);

.NET Framework

Supported in: 4, 3.5

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

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.

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