UriMapper.MapUri Method

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Converts a specified uniform resource identifier (URI) into a new URI based on the rules of a matching object in the UriMappings collection.

Namespace:  System.Windows.Navigation
Assembly:  System.Windows.Controls.Navigation (in System.Windows.Controls.Navigation.dll)

Syntax

'Declaration
Public Overrides Function MapUri ( _
    uri As Uri _
) As Uri
public override Uri MapUri(
    Uri uri
)

Parameters

  • uri
    Type: System.Uri
    Original URI value to be converted to a new URI.

Return Value

Type: System.Uri
A URI to use for handling the request instead of the value of the uri parameter. If no object in the UriMappings collection matches uri, the original value for uri is returned.

Exceptions

Exception Condition
InvalidOperationException

The UriMappings property is nulla null reference (Nothing in Visual Basic).

Remarks

The MapUri method returns the mapped URI value from the first object in the UriMappings collection that matches the uri value. If more than one object in the collection matches the uri value, only the mapped URI from the first instance in the collection is returned.

An object in the UriMappings collection matches the uri value if the MapUri for that instance of the UriMapping class returns a value.

Version Information

Silverlight

Supported in: 5, 4, 3

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.