AttributeRouting
Helper for configuring areas when initializing AttributeRouting framework.
Helper for configuring areas when initializing AttributeRouting framework.
Set the subdomain this area is mapped to.
The name fo the subdomain
Configuration options to use when generating AttributeRoutes.
Creates and initializes a new configuration object.
Appends the routes from all controllers in the specified assembly to the route collection.
The assembly.
Appends the routes from all controllers in the specified assembly to the route collection.
The type denoting the assembly.
Appends the routes from the specified controller type to the end of route collection.
The controller type.
Appends the routes from the controller to the promoted controller type list,
optionally removing an already added type in order to add it to the end of the list.
The controller type.
Whether to remove and re-add already added controller types.
Appends the routes from all controllers that derive from the specified controller type to the route collection.
The base controller type.
Add a provider for translating components of routes.
Add a provider for translating components of routes.
Use for a default implementation.
Returns a utility for configuring areas when initializing AttributeRouting framework.
The name of the area to configure
Scans the specified assembly for routes to register.
The assembly.
Scans the assembly of the specified controller for routes to register.
The type used to specify the assembly.
When true, the generated routes will have a trailing slash on the path of outbound URLs.
The default is false.
Factory for generating routes used by AttributeRouting.
When true, the generated routes will have auto-generated route names in the form controller_action.
The default is false.
Constrains translated routes by the thread's current UI culture.
The default is false.
Specify the default subdomain for this application.
The default is www.
Type of the framework controller (IController, IHttpController).
Collection of available inline route constraint definitions.
When true, the generated routes will include actions defined on base controllers.
The default is false.
Note: Base Controllers should be declared as abstract to avoid routes being generated for them
List of all the subdomains mapped via AttributeRouting.
Factory for generating optional route parameters.
When true, the generated routes will not lowercase URL parameter values.
The default is false.
Factory for generating route constraints.
Given a route specification, this delegate returns the route name
to use when is true;
Given the requested hostname, this delegate parses the subdomain.
The default yields everything before the domain name;
eg: www.example.com yields www, and example.com yields null.
Translation providers.
When true, the generated routes will produce lowercase URLs.
The default is false.
Constrains a url parameter to contain only letters from the alphabet.
Constraints a url parameter by a regular expression.
Abstraction allowing shared matching logic in constraint base implementations.
Due to
System.Web.Routing.IRouteConstraint (used in web-hosted scenarios) and
System.Web.Http.Routing.IHttpRouteConstraint (used in self-hosted scenarios).
The pattern to match.
The compiled reg-ex expression.
Regex options for matching.
Constrains a url parameter by the values in the given enum type.
Abstraction used by
when handling compound inline route constraints.
Due to
System.Web.Routing.IRouteConstraint (used in web-hosted scenarios) and
System.Web.Http.Routing.IHttpRouteConstraint (used in self-hosted scenarios).
Constraints to logically and when matching the route parameter.
Constrains a url parameter by the names in the given enum type.
Abstraction used by
when handling inline route constraints contained in query strings.
Due to
System.Web.Routing.IRouteConstraint (used in web-hosted scenarios) and
System.Web.Http.Routing.IHttpRouteConstraint (used in self-hosted scenarios).
The constraint used in the query string.
Abstraction used by
when applying inbound http method constraints.
Due to
System.Web.Routing.HttpMethodConstraint (used in web-hosted scenarios) and
System.Web.Http.Routing.HttpMethodConstraint (used in self-hosted scenarios).
The allowed HTTP methods.
Constraints a url parameter to be a long with a maximum value.
Maximum value of the parameter.
Constraints a url parameter to be a long with a minimum value.
Minimum value of the parameter.
Constraints a url parameter to be a string of a given length
or within a given range of lengths if two params are given.
Constraints a url parameter to be a string of a given length.
The length of the string
Constraints a url parameter to be within a given range of lengths.
The minimum length constraint
The maximum length constraint
Length of the string.
Minimum length of the string.
Minimum length of the string.
Constraints a url parameter to be a string with a maximum length.
Minimum length of the string.
Abstraction used by
when handling optional route parameters with inline constraints.
Due to
System.Web.Routing.IRouteConstraint (used in web-hosted scenarios) and
System.Web.Http.Routing.IHttpRouteConstraint (used in self-hosted scenarios).
Constraint to consider optional.
Constraints a url parameter to be a long within a given range of values.
Minimum value.
Minimum valut.
Constraints a url parameter to be a string with a maximum length.
Maximum length of the string.
Constraints a url parameter to be parsable as the given type.
Visitor-ish used to extend implementations of .
Due to different route implementations in
System.Web.Routing (used for MVC controller routes) and
System.Web.Http.Routing (used for Web API controller routes).
Creates a new visitor extending implementations of IAttributeRoute with common logic.
The route
The route's configuration
Adds querystring default values to route values collection if they aren't already present.
The route values.
Performs lowercasing and appends trailing slash if this route is so configured.
The current virtual path, after translation
The final virtual path
Gets the translated virtual path for this route.
The type of virtual path data to be returned.
This varies based on whether the route is a
System.Web.Routing.Route or System.Web.Http.Routing.HttpRoute.
A delegate that can get the TVirtualPathData from a translated route
Returns null if no translation is available.
Tests whether the route matches the current UI culture.
The name of the UI culture to test to test.
Optimizes route matching by comparing the static left part of a route's URL with the requested path.
The path of the requested URL.
True if the requested URL path starts with the static left part of the route's URL.
Thanks: http://samsaffron.com/archive/2011/10/13/optimising-asp-net-mvc3-routing
Tests whether the configured subdomain (if any) matches the current host.
The subdomain part of the host from the current request
True if the subdomain for this route matches the current request host.
Processes query constraints separately from route constraints.
Delegate used to process the query constraints according to the underlying route framework.
Accepts a constraint and parameter name and returns true if the constraint passes.
True if all query string constraints pass or if there are none to test.
Need to separate path and query constraints because methods in the web stack
will not add query params to generated urls if there is a constraint for the param name
that is not present in the url template. See logic in:
- System.Web.Http.Routing.HttpParsedRoute.Bind(...)
- System.Web.Routing.ParsedRoute.Bind(...)
Abstraction used by when generating an .
Due to different route implementations in
System.Web.Routing (used for mvc controller routes) and
System.Web.Http.Routing (used for web api controllers).
Create attribute routes from the given metadata.
Abstraction used by when generating a route constraint.
Due to
System.Web.Routing.IRouteConstraint (used in web-hosted scenarios) and
System.Web.Http.Routing.IHttpRouteConstraint (used in self-hosted scenarios).
Creates a new regex route constraint.
Creates a new inbound http method constraint.
Creates an inline constraint of a specific type with the given parameters.
The short name of the inline constraint
The paramters with which to construct the constraint
Creates a compound route constraint wrapper to allow anding of individual inline constraints.
The constraints to apply together
Creates an optional route constraint wrapper to allow inline constraints to be optional.
The constraint
Creates an query string route constraint wrapper to allow constraints in the query string.
The constraint
Abstraction used by when generating a url parameter.
Due to
UrlParameter.Optional (used in web-hosted scenarios) and
RouteParameter.Optional (used in self-hosted scenarios).
Generates an optional parameter of the correct type.
Strategy that generates routes in the form "Area_Controller_Action".
In case of duplicates, the duplicate route is not named, and the builder will return null.
Strategy for building route names from a route specification.
Abstraction used by to generate routes with custom functionality.
Due to different route implementations in
System.Web.Routing (used for MVC controller routes) and
System.Web.Http.Routing (used for Web API controllers).
If true, will override
set via global configuration and the generated route will have a trailing slash on the path of outbound URLs.
Constraints dictionary
The culture name associated with this route.
DataTokens dictionary
Defaults dictionary
If true, will override
set via global configuration and the generated route will not lowercase URL parameter values.
Constraints dictionary for querystring constraints.
Defaults dictionary for querystring defaults.
The name of this route, for supporting named routes.
The source-language route if this route is a translated route.
The subdomain this route is to be applied against.
The translations available for this route.
If true, will override
set via global configuration and the generated route will have a lowercase URL.
Route URL
Strategy for parsing subdomains from a host.
Fluent helper for adding translations for the route components of a controller in a strongly typed manner.
The type of controler for which to add translations
Fluent helper for adding translations for the route components of a controller.
The translation builder that will add translations to the
Add translations for the area url applied on this controller.
Dictionary using cultureName as a key and a translation as the value
Add translations for the route prefix url applied on this controller.
Dictionary using cultureName as a key and a translation as the value
Add translations for the route url for an action in this controller.
Expression pointing to an action method on the controller
Dictionary using cultureName as a key and a translation as the value
Strategy that will parse all but the last two sections from a given host.
Strategy ensuring that every route has a unique name.
Preferably, it generates routes names like "Area_Controller_Action".
In case of duplicates, it will append the HTTP method (if not a GET route) and/or a unique index to the route.
So the most heinous possible form is "Area_Controller_Action_Method_Index".
Returns true if the object is null or it's string representation is null or empty.
Will attempt to get the value returned from the delegate.
If a NullReferenceException is thrown, the default for the leaf type will be returned.
Will attempt to get the value returned from the delegate.
If a NullReferenceException is thrown, the given default will be returned.
Get controllers in given assembly, depending on target framework (MVC, WebAPI)
Fluent helper for adding translations for route components.
Fluent helper for adding translations for route components.
Adds translations to the
based on the key of the route component to translate;
see
Returns a
for adding translations of route components in a strongly typed manner.
The type of the controller with routes to translate
Default implementation of
allowing the addition of translations for route components in a fluent style.
Provider for generating translations of route components.
Gets the translation for the given route component key and culture.
The key of the route component to translate; see
The culture name for the translation
List of culture names that have translations available via this provider.
Default implementation of
allowing the addition of translations for route components in a fluent style.
Returns a for adding translations in a fluent style.
Dictionary containing the translations of route components.
Generates conventional keys for use with the translation provder.
Generates the conventional key for the url of the specified area.
The name of the area
Generates the conventional key for the url of the specified route prefix.
The name of the area, if applicable
The name of the controller
Generates the conventional key for the url of the specified route.
The name of the area, if applicable
The name of the controller
The name of the action method
Generates the conventional key for the url of the area on the specified controller.
The type of the controller
Generates the conventional key for the url of the route prefix on the specified controller.
The type of the controller
Generates the conventional key for the url of the route on the specified action method.
The type of the controller
Expression pointing to the the action method
Dictionary of keys and dictionaries of culture name and translation pairs.
var translations = new TranslationsDictionary();
...
var translation = translations[key][cultureName];
Creates objects according to the
options set in implementations of .
Yields all the routes to register in the route table.
Implementors MUST disambiguate among routes based on the HttpMethods allowed for this route.
In System.Web.Mvc, that means deriving from ActionMethodSelectorAttribute.
In System.Web.Http, that means deriving from IActionHttpMethodProvider.
The url for this action.
The HttpMethods this route is constrained against.
The order of this route among all the routes defined against this action.
Zero and Positive integers denote top routes: 1 is first, 2 is second, etc....
Negative integers denote bottom routes: -1 is last, -2 is second to last, etc....
The order of this route among all the routes defined against this action.
Positive integers (including zero) denote top routes: 1 is first, 2 is second, etc....
Negative integers denote bottom routes: -1 is last, -2 is second to last, etc....
The order of this route among all the routes defined against this controller.
Positive integers (including zero) denote top routes: 1 is first, 2 is second, etc....
Negative integers denote bottom routes: -1 is last, -2 is second to last, etc....
The order of this route among all the routes defined against this controller.
The order of this route among all the routes in the site.
Positive integers (including zero) denote top routes: 1 is first, 2 is second, etc....
Negative integers denote bottom routes: -1 is last, -2 is second to last, etc....
The name this route will be registered with in the RouteTable.
If true, the generated route url will be applied from the root, skipping any relevant area name or route prefix.
Key used by translation provider to lookup the translation for the .
If set, will override
set via global configuration for this route.
Gets the tri-state value for UseLowercaseRoutes.
If set, will override
set via global configuration for this route.
Gets the tri-state value for PreserveCaseForUrlParameters.
If true, will override
set via global configuration for this route.
Gets the tri-state value for AppendTrailingSlash.
If true, will ignore any route prefix specified via the
when building up the route URL.
If true, will ignore any area URL prefix specified via the
when building up the route URL.
Base class that implementors can use to define a custom controller-level route convention.
Gets the RouteAttributes to be applied to the given action method.
The action method.
A collection of routes for the action.
Gets the default route prefix to use if no RoutePrefix is applied on the controller.
The action method.
A default prefix to use for the actions in the controller.
Gets a to apply to the controller
if no explicit route prefix is specified.
The controller type.
A .
Gets a to apply to the controller
if no explicit route area is specified.
The controller type.
A .
Strategies for generating conventional route names.
A bit awkward currently due to initial impl not being formalized into separate strategy classes.
Will refactor use via configuration API for v4.0.
This builder ensures that every route has a unique name.
Preferably, it generates routes names like "Area_Controller_Action".
In case of duplicates, it will append the HTTP method (if not a GET route) and/or a unique index to the route.
So the most heinous possible form is "Area_Controller_Action_Method_Index".
This builder generates routes in the form "Area_Controller_Action".
In case of duplicates, the duplicate route is not named, and the builder will return null.
Defines a prefix shared by all the routes defined in this controller.
Defines a prefix shared by all the routes defined in this controller.
The url prefix will be the name of the controller without the "Controller" suffix.
Defines a prefix shared by all the routes defined in this controller.
The url prefix to apply to the routes
The url prefix to apply to the routes.
The order of the routes using the given prefix
among all the routes generated with prefixes for this controller.
Positive integers (including zero) denote top routes: 1 is first, 2 is second, etc....
Negative integers denote bottom routes: -1 is last, -2 is second to last, etc....
Key used by translation provider to lookup the translation for the .
Defines an area shared by all the routes defined in this controller.
Defines an area shared by all the routes defined in this controller.
The area name will be the most immediate section of the namespace for the controller.
Defines an area shared by all the routes defined in this controller.
The name of the containing area
The area name that is registered for the routes in the controller.
The url prefix to apply to the routes.
Key used by translation provider to lookup the translation for the .
The subdomain that this area is mapped to. By default, areas apply to all subdomains.
Contains all the information needs to create a route.
Creates objects according to the
options set in implementations of .
Yields all the information needed by to build routes.
Gets the sortable order for the given value.
An integer sort order, where positive N is Nth, and negative N is Nth from last.
The sortable order corresponding to the given value.
Strategies for parsing the subdomain from host names.
A bit awkward currently due to initial impl not being formalized into separate strategy classes.
Will refactor use via configuration API for v4.0.
Will parse all but the last two sections from a given host.