LinkExtensions.RouteLink Method

Definition

Namespace:

System.Web.Mvc.Html

Assembly:

System.Web.Mvc.dll

Package:

Microsoft.AspNet.Mvc v5.2.6

Overloads

RouteLink(HtmlHelper, String, String, RouteValueDictionary, IDictionary<String,Object>)	Returns an anchor element (a element) that contains the virtual path of the specified action.
RouteLink(HtmlHelper, String, String, Object, Object)	Returns an anchor element (a element) that contains the virtual path of the specified action.
RouteLink(HtmlHelper, String, RouteValueDictionary, IDictionary<String,Object>)	Returns an anchor element (a element) that contains the virtual path of the specified action.
RouteLink(HtmlHelper, String, String, RouteValueDictionary)	Returns an anchor element (a element) that contains the virtual path of the specified action.
RouteLink(HtmlHelper, String, Object)	Returns an anchor element (a element) that contains the virtual path of the specified action.
RouteLink(HtmlHelper, String, Object, Object)	Returns an anchor element (a element) that contains the virtual path of the specified action.
RouteLink(HtmlHelper, String, RouteValueDictionary)	Returns an anchor element (a element) that contains the virtual path of the specified action.
RouteLink(HtmlHelper, String, String)	Returns an anchor element (a element) that contains the virtual path of the specified action.
RouteLink(HtmlHelper, String, String, String, String, String, Object, Object)	Returns an anchor element (a element) that contains the virtual path of the specified action.
RouteLink(HtmlHelper, String, String, Object)	Returns an anchor element (a element) that contains the virtual path of the specified action.
RouteLink(HtmlHelper, String, String, String, String, String, RouteValueDictionary, IDictionary<String,Object>)	Returns an anchor element (a element) that contains the virtual path of the specified action.

RouteLink(HtmlHelper, String, String, RouteValueDictionary, IDictionary<String,Object>)

Returns an anchor element (a element) that contains the virtual path of the specified action.

public static System.Web.Mvc.MvcHtmlString RouteLink (this System.Web.Mvc.HtmlHelper htmlHelper, string linkText, string routeName, System.Web.Routing.RouteValueDictionary routeValues, System.Collections.Generic.IDictionary<string,object> htmlAttributes);

static member RouteLink : System.Web.Mvc.HtmlHelper * string * string * System.Web.Routing.RouteValueDictionary * System.Collections.Generic.IDictionary<string, obj> -> System.Web.Mvc.MvcHtmlString

<Extension()>
Public Function RouteLink (htmlHelper As HtmlHelper, linkText As String, routeName As String, routeValues As RouteValueDictionary, htmlAttributes As IDictionary(Of String, Object)) As MvcHtmlString

Parameters

htmlHelper

HtmlHelper

The HTML helper instance that this method extends.

linkText

String

The inner text of the anchor element.

routeName

String

The name of the route that is used to return a virtual path.

routeValues

RouteValueDictionary

An object that contains the parameters for a route.

htmlAttributes

IDictionary<String,Object>

An object that contains the HTML attributes to set for the element.

Returns

MvcHtmlString

An anchor element (a element).

Exceptions

ArgumentException

The linkText parameter is null or empty.

RouteLink(HtmlHelper, String, String, Object, Object)

Returns an anchor element (a element) that contains the virtual path of the specified action.

public static System.Web.Mvc.MvcHtmlString RouteLink (this System.Web.Mvc.HtmlHelper htmlHelper, string linkText, string routeName, object routeValues, object htmlAttributes);

static member RouteLink : System.Web.Mvc.HtmlHelper * string * string * obj * obj -> System.Web.Mvc.MvcHtmlString

<Extension()>
Public Function RouteLink (htmlHelper As HtmlHelper, linkText As String, routeName As String, routeValues As Object, htmlAttributes As Object) As MvcHtmlString

Parameters

htmlHelper

HtmlHelper

The HTML helper instance that this method extends.

linkText

String

The inner text of the anchor element.

routeName

String

The name of the route that is used to return a virtual path.

routeValues

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.

htmlAttributes

Object

An object that contains the HTML attributes to set for the element.

Returns

MvcHtmlString

An anchor element (a element).

Exceptions

ArgumentException

The linkText parameter is null or empty.

RouteLink(HtmlHelper, String, RouteValueDictionary, IDictionary<String,Object>)

Returns an anchor element (a element) that contains the virtual path of the specified action.

public static System.Web.Mvc.MvcHtmlString RouteLink (this System.Web.Mvc.HtmlHelper htmlHelper, string linkText, System.Web.Routing.RouteValueDictionary routeValues, System.Collections.Generic.IDictionary<string,object> htmlAttributes);

static member RouteLink : System.Web.Mvc.HtmlHelper * string * System.Web.Routing.RouteValueDictionary * System.Collections.Generic.IDictionary<string, obj> -> System.Web.Mvc.MvcHtmlString

<Extension()>
Public Function RouteLink (htmlHelper As HtmlHelper, linkText As String, routeValues As RouteValueDictionary, htmlAttributes As IDictionary(Of String, Object)) As MvcHtmlString

Parameters

htmlHelper

HtmlHelper

The HTML helper instance that this method extends.

linkText

String

The inner text of the anchor element.

routeValues

RouteValueDictionary

An object that contains the parameters for a route.

htmlAttributes

IDictionary<String,Object>

An object that contains the HTML attributes to set for the element.

Returns

MvcHtmlString

An anchor element (a element).

Exceptions

ArgumentException

The linkText parameter is null or empty.

RouteLink(HtmlHelper, String, String, RouteValueDictionary)

Returns an anchor element (a element) that contains the virtual path of the specified action.

public static System.Web.Mvc.MvcHtmlString RouteLink (this System.Web.Mvc.HtmlHelper htmlHelper, string linkText, string routeName, System.Web.Routing.RouteValueDictionary routeValues);

static member RouteLink : System.Web.Mvc.HtmlHelper * string * string * System.Web.Routing.RouteValueDictionary -> System.Web.Mvc.MvcHtmlString

<Extension()>
Public Function RouteLink (htmlHelper As HtmlHelper, linkText As String, routeName As String, routeValues As RouteValueDictionary) As MvcHtmlString

Parameters

htmlHelper

HtmlHelper

The HTML helper instance that this method extends.

linkText

String

The inner text of the anchor element.

routeName

String

The name of the route that is used to return a virtual path.

routeValues

RouteValueDictionary

An object that contains the parameters for a route.

Returns

MvcHtmlString

An anchor element (a element).

Exceptions

ArgumentException

The linkText parameter is null or empty.

RouteLink(HtmlHelper, String, Object)

Returns an anchor element (a element) that contains the virtual path of the specified action.

public static System.Web.Mvc.MvcHtmlString RouteLink (this System.Web.Mvc.HtmlHelper htmlHelper, string linkText, object routeValues);

static member RouteLink : System.Web.Mvc.HtmlHelper * string * obj -> System.Web.Mvc.MvcHtmlString

<Extension()>
Public Function RouteLink (htmlHelper As HtmlHelper, linkText As String, routeValues As Object) As MvcHtmlString

Parameters

htmlHelper

HtmlHelper

The HTML helper instance that this method extends.

linkText

String

The inner text of the anchor element.

routeValues

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.

Returns

MvcHtmlString

An anchor element (a element).

Exceptions

ArgumentException

The linkText parameter is null or empty.

RouteLink(HtmlHelper, String, Object, Object)

Returns an anchor element (a element) that contains the virtual path of the specified action.

public static System.Web.Mvc.MvcHtmlString RouteLink (this System.Web.Mvc.HtmlHelper htmlHelper, string linkText, object routeValues, object htmlAttributes);

static member RouteLink : System.Web.Mvc.HtmlHelper * string * obj * obj -> System.Web.Mvc.MvcHtmlString

<Extension()>
Public Function RouteLink (htmlHelper As HtmlHelper, linkText As String, routeValues As Object, htmlAttributes As Object) As MvcHtmlString

Parameters

htmlHelper

HtmlHelper

The HTML helper instance that this method extends.

linkText

String

The inner text of the anchor element.

routeValues

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.

htmlAttributes

Object

An object that contains the HTML attributes to set for the element.

Returns

MvcHtmlString

An anchor element (a element).

Exceptions

ArgumentException

The linkText parameter is null or empty.

RouteLink(HtmlHelper, String, RouteValueDictionary)

Returns an anchor element (a element) that contains the virtual path of the specified action.

public static System.Web.Mvc.MvcHtmlString RouteLink (this System.Web.Mvc.HtmlHelper htmlHelper, string linkText, System.Web.Routing.RouteValueDictionary routeValues);

static member RouteLink : System.Web.Mvc.HtmlHelper * string * System.Web.Routing.RouteValueDictionary -> System.Web.Mvc.MvcHtmlString

<Extension()>
Public Function RouteLink (htmlHelper As HtmlHelper, linkText As String, routeValues As RouteValueDictionary) As MvcHtmlString

Parameters

htmlHelper

HtmlHelper

The HTML helper instance that this method extends.

linkText

String

The inner text of the anchor element.

routeValues

RouteValueDictionary

An object that contains the parameters for a route.

Returns

MvcHtmlString

An anchor element (a element).

Exceptions

ArgumentException

The linkText parameter is null or empty.

RouteLink(HtmlHelper, String, String)

Returns an anchor element (a element) that contains the virtual path of the specified action.

public static System.Web.Mvc.MvcHtmlString RouteLink (this System.Web.Mvc.HtmlHelper htmlHelper, string linkText, string routeName);

static member RouteLink : System.Web.Mvc.HtmlHelper * string * string -> System.Web.Mvc.MvcHtmlString

<Extension()>
Public Function RouteLink (htmlHelper As HtmlHelper, linkText As String, routeName As String) As MvcHtmlString

Parameters

htmlHelper

HtmlHelper

The HTML helper instance that this method extends.

linkText

String

The inner text of the anchor element.

routeName

String

The name of the route that is used to return a virtual path.

Returns

MvcHtmlString

An anchor element (a element).

Exceptions

ArgumentException

The linkText parameter is null or empty.

RouteLink(HtmlHelper, String, String, String, String, String, Object, Object)

Returns an anchor element (a element) that contains the virtual path of the specified action.

public static System.Web.Mvc.MvcHtmlString RouteLink (this System.Web.Mvc.HtmlHelper htmlHelper, string linkText, string routeName, string protocol, string hostName, string fragment, object routeValues, object htmlAttributes);

static member RouteLink : System.Web.Mvc.HtmlHelper * string * string * string * string * string * obj * obj -> System.Web.Mvc.MvcHtmlString

<Extension()>
Public Function RouteLink (htmlHelper As HtmlHelper, linkText As String, routeName As String, protocol As String, hostName As String, fragment As String, routeValues As Object, htmlAttributes As Object) As MvcHtmlString

Parameters

htmlHelper

HtmlHelper

The HTML helper instance that this method extends.

linkText

String

The inner text of the anchor element.

routeName

String

The name of the route that is used to return a virtual path.

protocol

String

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

hostName

String

The host name for the URL.

fragment

String

The URL fragment name (the anchor name).

routeValues

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.

htmlAttributes

Object

An object that contains the HTML attributes to set for the element.

Returns

MvcHtmlString

An anchor element (a element).

Exceptions

ArgumentException

The linkText parameter is null or empty.

RouteLink(HtmlHelper, String, String, Object)

Returns an anchor element (a element) that contains the virtual path of the specified action.

public static System.Web.Mvc.MvcHtmlString RouteLink (this System.Web.Mvc.HtmlHelper htmlHelper, string linkText, string routeName, object routeValues);

static member RouteLink : System.Web.Mvc.HtmlHelper * string * string * obj -> System.Web.Mvc.MvcHtmlString

<Extension()>
Public Function RouteLink (htmlHelper As HtmlHelper, linkText As String, routeName As String, routeValues As Object) As MvcHtmlString

Parameters

htmlHelper

HtmlHelper

The HTML helper instance that this method extends.

linkText

String

The inner text of the anchor element.

routeName

String

The name of the route that is used to return a virtual path.

routeValues

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.

Returns

MvcHtmlString

An anchor element (a element).

Exceptions

ArgumentException

The linkText parameter is null or empty.

RouteLink(HtmlHelper, String, String, String, String, String, RouteValueDictionary, IDictionary<String,Object>)

Returns an anchor element (a element) that contains the virtual path of the specified action.

public static System.Web.Mvc.MvcHtmlString RouteLink (this System.Web.Mvc.HtmlHelper htmlHelper, string linkText, string routeName, string protocol, string hostName, string fragment, System.Web.Routing.RouteValueDictionary routeValues, System.Collections.Generic.IDictionary<string,object> htmlAttributes);

static member RouteLink : System.Web.Mvc.HtmlHelper * string * string * string * string * string * System.Web.Routing.RouteValueDictionary * System.Collections.Generic.IDictionary<string, obj> -> System.Web.Mvc.MvcHtmlString

<Extension()>
Public Function RouteLink (htmlHelper As HtmlHelper, linkText As String, routeName As String, protocol As String, hostName As String, fragment As String, routeValues As RouteValueDictionary, htmlAttributes As IDictionary(Of String, Object)) As MvcHtmlString

Parameters

htmlHelper

HtmlHelper

The HTML helper instance that this method extends.

linkText

String

The inner text of the anchor element.

routeName

String

The name of the route that is used to return a virtual path.

protocol

String

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

hostName

String

The host name for the URL.

fragment

String

The URL fragment name (the anchor name).

routeValues

RouteValueDictionary

An object that contains the parameters for a route.

htmlAttributes

IDictionary<String,Object>

An object that contains the HTML attributes to set for the element.

Returns

MvcHtmlString

An anchor element (a element).

Exceptions

ArgumentException

The linkText parameter is null or empty.