UrlHelper Class

 

Contains methods to build URLs for ASP.NET MVC within an application.

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

Inheritance Hierarchy

System.Object
  System.Web.Mvc.UrlHelper

Syntax

public class UrlHelper

public ref class UrlHelper 

type UrlHelper = class end

Public Class UrlHelper

Constructors

	Name	Description
	UrlHelper()	Initializes a new instance of the UrlHelper class.
	UrlHelper(RequestContext)	Initializes a new instance of the UrlHelper class using the specified request context.
	UrlHelper(RequestContext, RouteCollection)	Initializes a new instance of the UrlHelper class using the specified request context and route collection.

Properties

	Name	Description
	RequestContext	Gets information about an HTTP request that matches a defined route.
	RouteCollection	Gets a collection that contains the routes that are registered for the application.

Methods

	Name	Description
	Action()	Generates a string to a fully qualified URL to an action method.
	Action(String)	Generates a fully qualified URL to an action method by using the specified action name.
	Action(String, Object)	Generates a fully qualified URL to an action method by using the specified action name and route values.
	Action(String, RouteValueDictionary)	Generates a fully qualified URL to an action method for the specified action name and route values.
	Action(String, String)	Generates a fully qualified URL to an action method by using the specified action name and controller name.
	Action(String, String, Object)	Generates a fully qualified URL to an action method by using the specified action name, controller name, and route values.
	Action(String, String, Object, String)	Generates a fully qualified URL to an action method by using the specified action name, controller name, route values, and protocol to use.
	Action(String, String, RouteValueDictionary)	Generates a fully qualified URL to an action method by using the specified action name, controller name, and route values.
	Action(String, String, RouteValueDictionary, String)	Generates a fully qualified URL for an action method by using the specified action name, controller name, route values, and protocol to use.
	Action(String, String, RouteValueDictionary, String, String)	Generates a fully qualified URL for an action method by using the specified action name, controller name, route values, protocol to use and host name.
	Content(String)	Converts a virtual (relative) path to an application absolute path.
	Encode(String)	Encodes special characters in a URL string into character-entity equivalents.
	Equals(Object)	(Inherited from Object.)
	Finalize()	(Inherited from Object.)
	GenerateContentUrl(String, HttpContextBase)	Returns a string that contains a content URL.
	GenerateUrl(String, String, String, RouteValueDictionary, RouteCollection, RequestContext, Boolean)	Returns a string that contains a URL.
	GenerateUrl(String, String, String, String, String, String, RouteValueDictionary, RouteCollection, RequestContext, Boolean)	Returns a string that contains a URL.
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	HttpRouteUrl(String, Object)	Generates a fully qualified URL for the specified route values.
	HttpRouteUrl(String, RouteValueDictionary)	Generates a fully qualified URL for the specified route values.
	IsLocalUrl(String)	Returns a value that indicates whether the URL is local.
	MemberwiseClone()	(Inherited from Object.)
	RouteUrl(Object)	Generates a fully qualified URL for the specified route values.
	RouteUrl(RouteValueDictionary)	Generates a fully qualified URL for the specified route values.
	RouteUrl(String)	Generates a fully qualified URL for the specified route name.
	RouteUrl(String, Object)	Generates a fully qualified URL for the specified route values by using a route name.
	RouteUrl(String, Object, String)	Generates a fully qualified URL for the specified route values by using a route name and the protocol to use.
	RouteUrl(String, RouteValueDictionary)	Generates a fully qualified URL for the specified route values by using a route name.
	RouteUrl(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.
	ToString()	(Inherited from Object.)

Remarks

The UrlHelper class provides the following methods to help you work with URLs:

• Action. This method generates a URL that maps to an action method.

• RouteUrl. This method generates a URL that maps to a route.

• Content. This method generates a URL path to a resource, based on the virtual (relative) path of the resource.

• Encode. This method encodes special characters in the specified URL into character-entity equivalents.

Thread Safety

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

See Also

System.Web.Mvc Namespace

Return to top