ParametrizedAction.Execute Event

Occurs after a Parametrized Action’s editor value has been validated.

Namespace: DevExpress.ExpressApp.Actions

Assembly: DevExpress.ExpressApp.v23.2.dll

NuGet Package: DevExpress.ExpressApp

Declaration

C#

public event ParametrizedActionExecuteEventHandler Execute

VB.NET

Public Event Execute As ParametrizedActionExecuteEventHandler

Event Data

The Execute event's data class is ParametrizedActionExecuteEventArgs. The following properties provide information specific to this event:

Property	Description
Action	Provides access to the Action being executed. Inherited from ActionBaseEventArgs.
CurrentObject	Provides access to the current object represented by the currently displayed View. Inherited from SimpleActionExecuteEventArgs.
ParameterCurrentValue	Returns the value that has been entered into a Parametrized Action’s editor.
SelectedObjects	Provides access to the objects selected in the currently invoked View. Inherited from SimpleActionExecuteEventArgs.
ShowViewParameters	Provides access to the ShowViewParameters object, specifying a View, displayed after executing the current Action. Inherited from ActionBaseEventArgs.

Remarks

In Windows Forms applications, end-users can validate entered values by pressing the ENTER or ESC key or moving focus outside the edited cell. In ASP.NET WebForms applications, the entered value is validated either after the editor’s Text property value has been changed or when clicking the button attached to this editor. Handle this event to execute custom code after an end-user has validated the entered value. To access this value, use the handler’s ParametrizedActionExecuteEventArgs.ParameterCurrentValue parameter.

If you want to display an additional View after executing the event, use the handler’s ActionBaseEventArgs.ShowViewParameters parameter to specify this View and its settings.

For additional information, refer to How to: Access Objects Selected in the Current View.

Execute Actions Programmatically

We do not recommend that you use the DoExecute and other methods to execute Actions because such methods can contain UI-specific code. You can refactor your Action’s event handlers and extract the required code into separate methods. Call these separate methods directly without triggering UI-related Action code.

Programmatic execution of custom and built-in Actions is acceptable in rare advanced scenarios, for example, if you:

• Create a custom Action Container and call the DoExecute method inside the Action control. In this context, you have complete control over your custom code and can execute any action. Remember to trigger life-cycle events for your actions (such as Execute).
• Add new ways to invoke Actions from the UI (for example, support keyboard or voice control).
• Reuse a built-in Action in a specific context where you would need to write a lot of code to re-implement the Action’s internal business logic.

For more information on how to implement such complex requirements, refer to the following materials:

• XAF - How to execute Actions programmatically.
• “Related GitHub Examples” section of the SimpleAction.DoExecute topic.
• “Related GitHub Examples” section of the ParametrizedAction.DoExecute(Object) topic.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Execute event.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

xaf-win-web-open-detail-view-when-grid-row-is-clicked-in-the-dashboard/CS/ShowDetailViewFromDashboard.Module.Win/Controllers/WinShowDetailViewFromDashboardController.cs#L21

    openDetailViewAction.SelectionDependencyType = SelectionDependencyType.RequireSingleObject;
    openDetailViewAction.Execute += OpenDetailViewAction_Execute;
}

xaf-how-to-create-a-custom-action-with-a-custom-control-in-xaf-aspnet-application/CS/Solution28.Module.Web/Controllers/ViewControllerWithParametrizedAction.cs#L11

    ParametrizedAction filterAction = new ParametrizedAction(this, "FilterRange", "Edit", typeof(DateTime));
    filterAction.Execute += new ParametrizedActionExecuteEventHandler(filterAction_Execute);
}

VB.NET

xaf-win-web-open-detail-view-when-grid-row-is-clicked-in-the-dashboard/VB/ShowDetailViewFromDashboard.Module.Win/Controllers/WinShowDetailViewFromDashboardController.vb#L23

    openDetailViewAction.SelectionDependencyType = SelectionDependencyType.RequireSingleObject
    AddHandler openDetailViewAction.Execute, AddressOf OpenDetailViewAction_Execute
End Sub

xaf-how-to-create-a-custom-action-with-a-custom-control-in-xaf-aspnet-application/VB/Solution28.Module.Web/Controllers/ViewControllerWithParametrizedAction.vb#L13

    Dim filterAction As New ParametrizedAction(Me, "FilterRange", "Edit", GetType(Date))
    AddHandler filterAction.Execute, AddressOf filterAction_Execute
End Sub