UrlHelper Class

Definition

Namespace:

Microsoft.AspNetCore.Mvc.Routing

Assembly:

Microsoft.AspNetCore.Mvc.Core.dll

Package:

Microsoft.AspNetCore.App.Ref v8.0.0

Source:

UrlHelper.cs

An implementation of IUrlHelper that contains methods to build URLs for ASP.NET MVC within an application.

public class UrlHelper : Microsoft.AspNetCore.Mvc.Routing.UrlHelperBase

type UrlHelper = class
    inherit UrlHelperBase

Public Class UrlHelper
Inherits UrlHelperBase

Inheritance

Object

UrlHelperBase

UrlHelper

Constructors

UrlHelper(ActionContext)

Initializes a new instance of the UrlHelper class using the specified actionContext.

Properties

ActionContext	Gets the ActionContext for the current request. (Inherited from UrlHelperBase)
AmbientValues	Gets the RouteValueDictionary associated with the current request. (Inherited from UrlHelperBase)
HttpContext	Gets the HttpContext associated with the current request.
Router	Gets the top-level IRouter associated with the current request. Generally an IRouteCollection implementation.

Methods

Action(UrlActionContext)	Generates a URL with an absolute path for an action method, which contains the action name, controller name, route values, protocol to use, host name, and fragment specified by UrlActionContext. Generates an absolute URL if Protocol and Host are non-null. See the remarks section for important security information.
Content(String)	Converts a virtual (relative, starting with ~/) path to an application absolute path. (Inherited from UrlHelperBase)
GenerateUrl(String, String, String, String)	Generate a url using the specified values. (Inherited from UrlHelperBase)
GenerateUrl(String, String, String)	Generates a URI from the provided components. (Inherited from UrlHelperBase)
GenerateUrl(String, String, VirtualPathData, String)	Generates the URL using the specified components.
GetValuesDictionary(Object)	Gets a RouteValueDictionary using the specified values. (Inherited from UrlHelperBase)
GetVirtualPathData(String, RouteValueDictionary)	Gets the VirtualPathData for the specified routeName and route values.
IsLocalUrl(String)	Returns a value that indicates whether the URL is local. A URL is considered local if it does not have a host / authority part and it has an absolute path. URLs using virtual paths ('~/') are also local. (Inherited from UrlHelperBase)
Link(String, Object)	Generates an absolute URL for the specified routeName and route values, which contains the protocol (such as "http" or "https") and host name from the current request. See the remarks section for important security information. (Inherited from UrlHelperBase)
RouteUrl(UrlRouteContext)	Generates a URL with an absolute path, which contains the route name, route values, protocol to use, host name, and fragment specified by UrlRouteContext. Generates an absolute URL if Protocol and Host are non-null. See the remarks section for important security information.

Extension Methods

Action(IUrlHelper, String, Object)	Generates a URL with a path for an action method, which contains the specified action name and route values.
Action(IUrlHelper, String, String, Object, String, String, String)	Generates a URL with a path for an action method, which contains the specified action name, controller name, route values, protocol to use, host name, and fragment. Generates an absolute URL if the protocol and host are non-null. See the remarks section for important security information.
Action(IUrlHelper, String, String, Object, String, String)	Generates a URL with a path for an action method, which contains the specified action name, controller name, route values, protocol to use, and host name. Generates an absolute URL if the protocol and host are non-null. See the remarks section for important security information.
Action(IUrlHelper, String, String, Object, String)	Generates a URL with a path for an action method, which contains the specified action name, controller name, route values, and protocol to use. See the remarks section for important security information.
Action(IUrlHelper, String, String, Object)	Generates a URL with a path for an action method, which contains the specified action name, controller name, and route values.
Action(IUrlHelper, String, String)	Generates a URL with a path for an action method, which contains the specified action and controller names.
Action(IUrlHelper, String)	Generates a URL with a path for an action method, which contains the specified action name.
Action(IUrlHelper)	Generates a URL with a path for an action method.
ActionLink(IUrlHelper, String, String, Object, String, String, String)	Generates an absolute URL for an action method, which contains the specified action name, controller name, route values, protocol to use, host name, and fragment. Generates an absolute URL if the protocol and host are non-null. See the remarks section for important security information.
Page(IUrlHelper, String, Object)	Generates a URL with a relative path for the specified pageName.
Page(IUrlHelper, String, String, Object, String, String, String)	Generates a URL with an absolute path for the specified pageName. See the remarks section for important security information.
Page(IUrlHelper, String, String, Object, String, String)	Generates a URL with an absolute path for the specified pageName. See the remarks section for important security information.
Page(IUrlHelper, String, String, Object, String)	Generates a URL with an absolute path for the specified pageName. See the remarks section for important security information.
Page(IUrlHelper, String, String, Object)	Generates a URL with a relative path for the specified pageName.
Page(IUrlHelper, String, String)	Generates a URL with a relative path for the specified pageName.
Page(IUrlHelper, String)	Generates a URL with a relative path for the specified pageName.
PageLink(IUrlHelper, String, String, Object, String, String, String)	Generates an absolute URL for a page, which contains the specified pageName, pageHandler, route values, protocol to use, host name, and fragment. Generates an absolute URL if the protocol and host are non-null. See the remarks section for important security information.
RouteUrl(IUrlHelper, Object)	Generates a URL with an absolute path for the specified route values.
RouteUrl(IUrlHelper, String, Object, String, String, String)	Generates a URL with an absolute path for the specified route routeName and route values, which contains the specified protocol to use, host name and fragment. Generates an absolute URL if Protocol and Host are non-null. See the remarks section for important security information.
RouteUrl(IUrlHelper, String, Object, String, String)	Generates a URL with an absolute path for the specified route routeName and route values, which contains the specified protocol to use and host name. Generates an absolute URL if Protocol and Host are non-null. See the remarks section for important security information.
RouteUrl(IUrlHelper, String, Object, String)	Generates a URL with an absolute path for the specified route routeName and route values, which contains the specified protocol to use. See the remarks section for important security information.
RouteUrl(IUrlHelper, String, Object)	Generates a URL with an absolute path for the specified routeName and route values.
RouteUrl(IUrlHelper, String)	Generates a URL with an absolute path for the specified routeName.