UrlHelper Class

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

Inheritance Hierarchy

System.Object
  System.Web.Mvc.UrlHelper

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

Syntax

'Declaration
Public Class UrlHelper
'Usage
Dim instance As UrlHelper
public class UrlHelper
public ref class UrlHelper
type UrlHelper =  class end
public class UrlHelper

The UrlHelper type exposes the following members.

Constructors

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

Top

Properties

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

Top

Methods

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

Top

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

Reference

System.Web.Mvc Namespace