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

UrlHelper.RouteUrl Method

 

Generates a fully qualified URL.

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

NameDescription
System_CAPS_pubmethodRouteUrl(Object)

Generates a fully qualified URL for the specified route values.

System_CAPS_pubmethodRouteUrl(RouteValueDictionary)

Generates a fully qualified URL for the specified route values.

System_CAPS_pubmethodRouteUrl(String)

Generates a fully qualified URL for the specified route name.

System_CAPS_pubmethodRouteUrl(String, Object)

Generates a fully qualified URL for the specified route values by using a route name.

System_CAPS_pubmethodRouteUrl(String, Object, String)

Generates a fully qualified URL for the specified route values by using a route name and the protocol to use.

System_CAPS_pubmethodRouteUrl(String, RouteValueDictionary)

Generates a fully qualified URL for the specified route values by using a route name.

System_CAPS_pubmethodRouteUrl(String, RouteValueDictionary, String, String)

Generates a fully qualified URL for the specified route values by using the specified route name, protocol to use, and host name.

The URL that is returned by this method has a format like the following:

/Home/About

If special characters in the URL must be encoded, use the Encode method. For the previous example, the Encode method returns the following URL:

%2fHome%2fAbout

Return to top

UrlHelper.RouteUrl Method (Object)

Generates a fully qualified URL for the specified route values.

public virtual string RouteUrl(
	object routeValues
)

Parameters

routeValues
Type: System.Object

An object that contains the parameters for a route. The parameters are retrieved through reflection by examining the properties of the object. The object is typically created by using object initializer syntax.

Return Value

Type: System.String

The fully qualified URL.

The URL that is returned by this method has a format like the following:

/Home/About

If special characters in the URL must be encoded, use the Encode method. For the previous example, the Encode method returns the following URL:

%2fHome%2fAbout

Return to top

UrlHelper.RouteUrl Method (RouteValueDictionary)

Generates a fully qualified URL for the specified route values.

public virtual string RouteUrl(
	RouteValueDictionary routeValues
)

Parameters

routeValues
Type: System.Web.Routing.RouteValueDictionary

An object that contains the parameters for a route.

Return Value

Type: System.String

The fully qualified URL.

The URL that is returned by this method has a format like the following:

/Home/About

If special characters in the URL must be encoded, use the Encode method. For the previous example, the Encode method returns the following URL:

%2fHome%2fAbout

Return to top

UrlHelper.RouteUrl Method (String)

Generates a fully qualified URL for the specified route name.

public virtual string RouteUrl(
	string routeName
)

Parameters

routeName
Type: System.String

The name of the route that is used to generate URL.

Return Value

Type: System.String

The fully qualified URL.

The URL that is returned by this method has a format like the following:

/Home/About

If special characters in the URL must be encoded, use the Encode method. For the previous example, the Encode method returns the following URL:

%2fHome%2fAbout

Return to top

UrlHelper.RouteUrl Method (String, Object)

Generates a fully qualified URL for the specified route values by using a route name.

public virtual string RouteUrl(
	string routeName,
	object routeValues
)

Parameters

routeName
Type: System.String

The name of the route that is used to generate URL.

routeValues
Type: System.Object

An object that contains the parameters for a route. The parameters are retrieved through reflection by examining the properties of the object. The object is typically created by using object initializer syntax.

Return Value

Type: System.String

The fully qualified URL.

The URL that is returned by this method has a format like the following:

/Home/About

If special characters in the URL must be encoded, use the Encode method. For the previous example, the Encode method returns the following URL:

%2fHome%2fAbout

Return to top

UrlHelper.RouteUrl Method (String, Object, String)

Generates a fully qualified URL for the specified route values by using a route name and the protocol to use.

public virtual string RouteUrl(
	string routeName,
	object routeValues,
	string protocol
)

Parameters

routeName
Type: System.String

The name of the route that is used to generate the URL.

routeValues
Type: System.Object

An object that contains the parameters for a route. The parameters are retrieved through reflection by examining the properties of the object. The object is typically created by using object initializer syntax.

protocol
Type: System.String

The protocol for the URL, such as "http" or "https".

Return Value

Type: System.String

The fully qualified URL.

The URL that is returned by this method has a format like the following:

/Home/About

If special characters in the URL must be encoded, use the Encode method. For the previous example, the Encode method returns the following URL:

%2fHome%2fAbout

Return to top

UrlHelper.RouteUrl Method (String, RouteValueDictionary)

Generates a fully qualified URL for the specified route values by using a route name.

public virtual string RouteUrl(
	string routeName,
	RouteValueDictionary routeValues
)

Parameters

routeName
Type: System.String

The name of the route that is used to generate URL.

routeValues
Type: System.Web.Routing.RouteValueDictionary

An object that contains the parameters for a route.

Return Value

Type: System.String

The fully qualified URL.

The URL that is returned by this method has a format like the following:

/Home/About

If special characters in the URL must be encoded, use the Encode method. For the previous example, the Encode method returns the following URL:

%2fHome%2fAbout

Return to top

UrlHelper.RouteUrl Method (String, RouteValueDictionary, String, String)

Generates a fully qualified URL for the specified route values by using the specified route name, protocol to use, and host name.

public virtual string RouteUrl(
	string routeName,
	RouteValueDictionary routeValues,
	string protocol,
	string hostName
)

Parameters

routeName
Type: System.String

The name of the route that is used to generate URL.

routeValues
Type: System.Web.Routing.RouteValueDictionary

An object that contains the parameters for a route.

protocol
Type: System.String

The protocol for the URL, such as "http" or "https".

hostName
Type: System.String

The host name for the URL.

Return Value

Type: System.String

The fully qualified URL.

The URL that is returned by this method has a format like the following:

/Home/About

If special characters in the URL must be encoded, use the Encode method. For the previous example, the Encode method returns the following URL:

%2fHome%2fAbout

Return to top
Show:
© 2015 Microsoft