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
System_CAPS_pubmethod UrlHelper()

Initializes a new instance of the UrlHelper class.

System_CAPS_pubmethod UrlHelper(RequestContext)

Initializes a new instance of the UrlHelper class using the specified request context.

System_CAPS_pubmethod UrlHelper(RequestContext, RouteCollection)

Initializes a new instance of the UrlHelper class using the specified request context and route collection.

Properties

Name Description
System_CAPS_pubproperty RequestContext

Gets information about an HTTP request that matches a defined route.

System_CAPS_pubproperty RouteCollection

Gets a collection that contains the routes that are registered for the application.

Methods

Name Description
System_CAPS_pubmethod Action()

Generates a string to a fully qualified URL to an action method.

System_CAPS_pubmethod Action(String)

Generates a fully qualified URL to an action method by using the specified action name.

System_CAPS_pubmethod Action(String, Object)

Generates a fully qualified URL to an action method by using the specified action name and route values.

System_CAPS_pubmethod Action(String, RouteValueDictionary)

Generates a fully qualified URL to an action method for the specified action name and route values.

System_CAPS_pubmethod Action(String, String)

Generates a fully qualified URL to an action method by using the specified action name and controller name.

System_CAPS_pubmethod Action(String, String, Object)

Generates a fully qualified URL to an action method by using the specified action name, controller name, and route values.

System_CAPS_pubmethod 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.

System_CAPS_pubmethod Action(String, String, RouteValueDictionary)

Generates a fully qualified URL to an action method by using the specified action name, controller name, and route values.

System_CAPS_pubmethod 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.

System_CAPS_pubmethod 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.

System_CAPS_pubmethod Content(String)

Converts a virtual (relative) path to an application absolute path.

System_CAPS_pubmethod Encode(String)

Encodes special characters in a URL string into character-entity equivalents.

System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_protmethod Finalize()

(Inherited from Object.)

System_CAPS_pubmethodSystem_CAPS_static GenerateContentUrl(String, HttpContextBase)

Returns a string that contains a content URL.

System_CAPS_pubmethodSystem_CAPS_static GenerateUrl(String, String, String, RouteValueDictionary, RouteCollection, RequestContext, Boolean)

Returns a string that contains a URL.

System_CAPS_pubmethodSystem_CAPS_static GenerateUrl(String, String, String, String, String, String, RouteValueDictionary, RouteCollection, RequestContext, Boolean)

Returns a string that contains a URL.

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_pubmethod HttpRouteUrl(String, Object)

Generates a fully qualified URL for the specified route values.

System_CAPS_pubmethod HttpRouteUrl(String, RouteValueDictionary)

Generates a fully qualified URL for the specified route values.

System_CAPS_pubmethod IsLocalUrl(String)

Returns a value that indicates whether the URL is local.

System_CAPS_protmethod MemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethod RouteUrl(Object)

Generates a fully qualified URL for the specified route values.

System_CAPS_pubmethod RouteUrl(RouteValueDictionary)

Generates a fully qualified URL for the specified route values.

System_CAPS_pubmethod RouteUrl(String)

Generates a fully qualified URL for the specified route name.

System_CAPS_pubmethod RouteUrl(String, Object)

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

System_CAPS_pubmethod RouteUrl(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_pubmethod RouteUrl(String, RouteValueDictionary)

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

System_CAPS_pubmethod 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.

System_CAPS_pubmethod 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