ParametrizedAction Class

Represents a Parametrized Action.

Namespace: DevExpress.ExpressApp.Actions

Assembly: DevExpress.ExpressApp.v21.1.dll

NuGet Package: DevExpress.ExpressApp

Declaration

C#
VB.NET

[ToolboxTabName("DX.21.1: XAF Actions")]
public class ParametrizedAction :
    ActionBase

<ToolboxTabName("DX.21.1: XAF Actions")>
Public Class ParametrizedAction
    Inherits ActionBase

Remarks

The ParametrizedAction class inherits the basic functionality of Actions from the ActionBase class. Parametrized Actions are used to execute custom code, when an end-user enters a value into the Action’s editor. This value is accessed via the ParametrizedAction.Value property. By default, this value is of the string type. You can specify another type for entered values via the ParametrizedAction.ValueType property (integer or DateTime). For each type, the appropriate control is displayed for the Action.

Note

For some types of a Parametrized Action’s values, Action Containers cannot create an appropriate control. In this instance, you will have to implement a special Action Container.

To execute custom code when users input a value into the Action’s editor, handle the ParametrizedAction.Execute event. To access the entered value, use the handler’s ParametrizedActionExecuteEventArgs.ParameterCurrentValue parameter.

To add a Parametrized Action to a Controller, drag and drop the ParametrizedAction item from the Toolbox (the XAF Actions section) onto the Controller’s Designer area (see Add a Parametrized Action).

Set the IModelActionWeb.IsPostBackRequired property to true to send a postback when a user executes an Action in an ASP.NET Web Forms application. For example, for Actions that download files or change the application’s language.