Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
RouteUrlExpressionBuilder Class

RouteUrlExpressionBuilder Class

.NET Framework 4.6 and 4.5

Creates a URL that corresponds to specified URL parameter values.


Namespace:  System.Web.Compilation
Assembly:  System.Web (in System.Web.dll)

public class RouteUrlExpressionBuilder : ExpressionBuilder

The RouteUrlExpressionBuilder type exposes the following members.

Public methodRouteUrlExpressionBuilderInitializes a new instance of the RouteUrlExpressionBuilder class.

Public propertySupportsEvaluateGets a value that indicates whether an expression can be evaluated in a page that is not compiled. (Overrides ExpressionBuilder.SupportsEvaluate.)

Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodEvaluateExpressionCreates a URL that corresponds to specified URL parameter values and to a route URL format. (Overrides ExpressionBuilder.EvaluateExpression(Object, BoundPropertyEntry, Object, ExpressionBuilderContext).)
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 methodGetCodeExpressionReturns a code expression that is used to perform the property assignment in the generated page class. (Overrides ExpressionBuilder.GetCodeExpression(BoundPropertyEntry, Object, ExpressionBuilderContext).)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodStatic memberGetRouteUrlCreates a URL that corresponds to specified route keys for a route URL format.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodParseExpressionWhen overridden in a derived class, returns an object that represents the parsed expression. (Inherited from ExpressionBuilder.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodStatic memberTryParseRouteExpressionParses an expression into a collection of route keys and values, and optionally into a route name.

The RouteUrlExpressionBuilder class makes it possible to set the property of a server control to the URL of a route by providing a list of URL parameter values.

The following example shows how to create markup that generates a hyperlink with a URL that is formatted for a route. The route is defined by using http://www.contoso.com/search/{searchterm} as the URL pattern.

<asp:HyperLink ID="HyperLink1" runat="server"
               NavigateUrl="<%$ RouteUrl:searchterm=Bicycles %>">
  Search for Bicycles

The URL generated for this hyperlink would be http://www.contoso.com/search/Bicycles.

If the URL parameters provided to the RouteUrl expression are not sufficient to uniquely identify a route, you must include the route name. For example, if a Web application has two routes with searchterm as the sole URL parameter, the routes would have to be defined by using route names, and the hyperlink markup would resemble the following example:

<asp:HyperLink ID="HyperLink1" runat="server"
               NavigateUrl="<%$ RouteUrl:searchterm=Bicycles,
               routename=BasicSearchRoute %>">
  Search for Bicycles

.NET Framework

Supported in: 4.6, 4.5, 4

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