AjaxExtensions.RouteLink Method (AjaxHelper, String, String, AjaxOptions, Object)

Returns an anchor element that contains the virtual path for the specified route values; when the link is clicked, a request is made to the virtual path asynchronously by using JavaScript.

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

Syntax

'Declaration
<ExtensionAttribute> _
Public Shared Function RouteLink ( _
    ajaxHelper As AjaxHelper, _
    linkText As String, _
    routeName As String, _
    ajaxOptions As AjaxOptions, _
    htmlAttributes As Object _
) As MvcHtmlString
'Usage
Dim ajaxHelper As AjaxHelper 
Dim linkText As String 
Dim routeName As String 
Dim ajaxOptions As AjaxOptions 
Dim htmlAttributes As Object 
Dim returnValue As MvcHtmlString 

returnValue = ajaxHelper.RouteLink(linkText, _
    routeName, ajaxOptions, htmlAttributes)
public static MvcHtmlString RouteLink(
    this AjaxHelper ajaxHelper,
    string linkText,
    string routeName,
    AjaxOptions ajaxOptions,
    Object htmlAttributes
)
[ExtensionAttribute]
public:
static MvcHtmlString^ RouteLink(
    AjaxHelper^ ajaxHelper, 
    String^ linkText, 
    String^ routeName, 
    AjaxOptions^ ajaxOptions, 
    Object^ htmlAttributes
)
static member RouteLink : 
        ajaxHelper:AjaxHelper * 
        linkText:string * 
        routeName:string * 
        ajaxOptions:AjaxOptions * 
        htmlAttributes:Object -> MvcHtmlString
public static function RouteLink(
    ajaxHelper : AjaxHelper, 
    linkText : String, 
    routeName : String, 
    ajaxOptions : AjaxOptions, 
    htmlAttributes : Object
) : MvcHtmlString

Parameters

  • linkText
    Type: System.String

    The inner text of the anchor element.

  • routeName
    Type: System.String

    The name of the route to use to obtain the form post URL.

  • htmlAttributes
    Type: System.Object

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

Return Value

Type: System.Web.Mvc.MvcHtmlString
An anchor element.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type AjaxHelper. When you use instance method syntax to call this method, omit the first parameter. For more information, see https://msdn.microsoft.com/en-us/library/bb384936(v=vs.108) or https://msdn.microsoft.com/en-us/library/bb383977(v=vs.108).

Exceptions

Exception Condition
ArgumentException

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

Remarks

The RouteLink method renders an anchor (a) element that links to a URL, which could 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

AjaxExtensions Class

RouteLink Overload

System.Web.Mvc.Ajax Namespace