Поделиться через


LinkExtensions.RouteLink Method (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.

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

Syntax

'Declaration
<ExtensionAttribute> _
Public Shared 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
public static MvcHtmlString RouteLink(
    this HtmlHelper htmlHelper,
    string linkText,
    string routeName,
    string protocol,
    string hostName,
    string fragment,
    RouteValueDictionary routeValues,
    IDictionary<string, Object> htmlAttributes
)
[ExtensionAttribute]
public:
static MvcHtmlString^ RouteLink(
    HtmlHelper^ htmlHelper, 
    String^ linkText, 
    String^ routeName, 
    String^ protocol, 
    String^ hostName, 
    String^ fragment, 
    RouteValueDictionary^ routeValues, 
    IDictionary<String^, Object^>^ htmlAttributes
)

Parameters

  • linkText
    Type: System.String
    The inner text of the anchor element.
  • routeName
    Type: System.String
    The name of the route that is used to return a virtual path.
  • protocol
    Type: System.String
    The protocol for the URL, such as "http" or "https".
  • fragment
    Type: System.String
    The URL fragment name (the anchor name).

Return Value

Type: System.Web.Mvc.MvcHtmlString
An anchor element (a element).

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type HtmlHelper. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Exceptions

Exception Condition
ArgumentException

The linkText parameter is null reference (Nothing in Visual Basic) or empty.

Remarks

The RouteLink method renders an element that links to a URL, which can resolve to an action method, a file, a folder, or some other resource.

The htmlAttributes parameter consists of an object that contains name/value pairs. The attributes that are specified in the name/value pairs depend on the HTML element that is being rendered. For example, for an anchor (a) element, you might provide the following anonymous object:

new { target="_self", name="summary" }
New With {.target="_self", .name="summary" }

See Also

Reference

LinkExtensions Class

RouteLink Overload

System.Web.Mvc.Html Namespace