ChildActionExtensions.Action Method (HtmlHelper, String, Object)

Invokes the specified child action method with the specified parameters and returns the result as an HTML string.

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

Syntax

'Declaration
<ExtensionAttribute> _
Public Shared Function Action ( _
    htmlHelper As HtmlHelper, _
    actionName As String, _
    routeValues As Object _
) As MvcHtmlString
'Usage
Dim htmlHelper As HtmlHelper 
Dim actionName As String 
Dim routeValues As Object 
Dim returnValue As MvcHtmlString 

returnValue = htmlHelper.Action(actionName, _
    routeValues)
public static MvcHtmlString Action(
    this HtmlHelper htmlHelper,
    string actionName,
    Object routeValues
)
[ExtensionAttribute]
public:
static MvcHtmlString^ Action(
    HtmlHelper^ htmlHelper, 
    String^ actionName, 
    Object^ routeValues
)
static member Action : 
        htmlHelper:HtmlHelper * 
        actionName:string * 
        routeValues:Object -> MvcHtmlString
public static function Action(
    htmlHelper : HtmlHelper, 
    actionName : String, 
    routeValues : Object
) : MvcHtmlString

Parameters

  • actionName
    Type: System.String

    The name of the action method to invoke.

  • routeValues
    Type: System.Object

    An object that contains the parameters for a route. You can use routeValues to provide the parameters that are bound to the action method parameters. The routeValues parameter is merged with the original route values and overrides them.

Return Value

Type: System.Web.Mvc.MvcHtmlString
The child action result as an HTML string.

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 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
ArgumentNullException

The htmlHelper parameter is nulla null reference (Nothing in Visual Basic).

ArgumentException

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

InvalidOperationException

The required virtual path data cannot be found.

Examples

The following example shows how to call the Action helper method in markup and how to pass to it the name of the action method that renders the child view and an anonymous object that contains route values.

<%= Html.Action("Display", New With {.section = "News"}) %>
<%= Html.Action("Display", new { section = "News" }); %>

See Also

Reference

ChildActionExtensions Class

Action Overload

System.Web.Mvc.Html Namespace