ChildActionExtensions.Action Method (HtmlHelper, String, String)

Article
02/21/2011

Invokes the specified child action method using the specified controller name 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, _
    controllerName As String _
) As MvcHtmlString

public static MvcHtmlString Action(
    this HtmlHelper htmlHelper,
    string actionName,
    string controllerName
)

[ExtensionAttribute]
public:
static MvcHtmlString^ Action(
    HtmlHelper^ htmlHelper, 
    String^ actionName, 
    String^ controllerName
)

Parameters

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

actionName
Type: System.String
The name of the action method to invoke.

controllerName
Type: System.String
The name of the controller that contains the action method.

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 Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Exceptions

Exception	Condition
ArgumentNullException	The htmlHelper parameter is null reference (Nothing in Visual Basic).
ArgumentException	The actionName parameter is 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 and controller that renders the child view.

<%= Html.Action("ChildList", "Home") %>

Share via