Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
RouteUrlExpressionEditorSheet Class
Collapse the table of content
Expand the table of content

RouteUrlExpressionEditorSheet Class

.NET Framework 4.6 and 4.5

Represents a design-time editor sheet for the properties of a RouteUrl expression in the UI of a designer host at design time.


Namespace:  System.Web.UI.Design
Assembly:  System.Design (in System.Design.dll)

public class RouteUrlExpressionEditorSheet : ExpressionEditorSheet

The RouteUrlExpressionEditorSheet type exposes the following members.

Public methodRouteUrlExpressionEditorSheetInitializes a new instance of the RouteUrlExpressionEditorSheet class.

Public propertyIsValidGets a value that indicates whether the RouteUrl expression string is valid. (Overrides ExpressionEditorSheet.IsValid.)
Public propertyRouteNameGets or sets the name of the route that a URL is to be generated for.
Public propertyRouteValuesGets or sets the URL parameter names and values that are to be used to generate a URL from a route.
Public propertyServiceProviderGets the service provider implementation that is used by the expression editor sheet. (Inherited from ExpressionEditorSheet.)

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 methodGetExpressionReturns a RouteUrl expression that is formed by the expression editor sheet property values. (Overrides ExpressionEditorSheet.GetExpression().)
Public methodGetHashCodeServes as the default hash function. (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 visual designer uses the RouteUrlExpressionEditor class together with the RouteUrlExpressionEditorSheet class to select the individual properties of a RouteUrl expression, and to combine the selected expression property values into a RouteUrl expression.

The RouteUrlExpressionEditor.GetExpressionEditorSheet method returns a RouteUrlExpressionEditorSheet object. In the expressions dialog box, when you select a control property and bind it to a RouteUrl expression, the visual designer calls the GetExpressionEditorSheet method. The visual designer uses the returned RouteUrlExpressionEditorSheet object to prompt for the RouteValues and RouteName properties. Once the properties are selected, the visual designer calls the GetExpression method to combine the properties into a RouteUrl expression string.

The RouteValues property must be specified if the RouteName property is not specified. The RouteName property must be specified if the RouteValues is not specified. Both properties may be specified.

.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