LinkExtensions.RouteLink Method (HtmlHelper, String, String)

Article
02/21/2011

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 _
) As MvcHtmlString

public static MvcHtmlString RouteLink(
    this HtmlHelper htmlHelper,
    string linkText,
    string routeName
)

[ExtensionAttribute]
public:
static MvcHtmlString^ RouteLink(
    HtmlHelper^ htmlHelper, 
    String^ linkText, 
    String^ routeName
)

Parameters

htmlHelper
Type: System.Web.Mvc.HtmlHelper
The HTML helper instance that this method extends.

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.

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.

Partager via