ParametrizedAction Class

Represents a Parametrized Action.

Namespace: DevExpress.ExpressApp.Actions

Assembly: DevExpress.ExpressApp.v24.1.dll

NuGet Package: DevExpress.ExpressApp

Declaration

C#
VB.NET

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

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

Remarks

The ParametrizedAction class inherits the basic functionality of Actions from the ActionBase class.

Use Parametrized Actions to execute custom code when a user enters a value into an Action’s editor.

To access the input value, use the ParametrizedAction.Value property. The value is of the string type by default.

To specify another type for input values (integer or DateTime), use the ParametrizedAction.ValueType property. For each type, XAF displays an appropriate control.

Note

For some value types, an Action Container cannot create an appropriate control. In this case, you have to implement a special Action Container.

Handle the ParametrizedAction.Execute event to execute custom code when a user enters a value into an Action’s editor. Use the handler’s ParametrizedActionExecuteEventArgs.ParameterCurrentValue parameter to access the input value.

For more information about how to add a Parametrized Action to a Controller, refer to the following topic: Add a Parametrized Action.

Note

CodeRush allows you to add Actions and Controllers with a few keystrokes. To learn about the Code Templates for XAF, refer to the following help topic: XAF Templates.

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.