SimpleAction.Execute Event

Occurs when an end-user clicks a Simple Action’s control.

Namespace: DevExpress.ExpressApp.Actions

Assembly: DevExpress.ExpressApp.v24.1.dll

NuGet Package: DevExpress.ExpressApp

Declaration

C#

public event SimpleActionExecuteEventHandler Execute

VB.NET

Public Event Execute As SimpleActionExecuteEventHandler

Event Data

The Execute event's data class is SimpleActionExecuteEventArgs. 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.
SelectedObjects	Provides access to the objects selected in the currently invoked View.
ShowViewParameters	Provides access to the ShowViewParameters object, specifying a View, displayed after executing the current Action. Inherited from ActionBaseEventArgs.

Remarks

The main entry point of a Simple Action is its Execute event. This event is raised when an end-user clicks the Simple Action’s control, which is represented by a button by default. Handle this event to execute custom code. For this purpose, use the handler’s parameter represented by a SimpleActionExecuteEventArgs object. For instance, this parameter provides access to the current and selected objects. If you need an additional View to be displayed after executing the Action, use the ActionBaseEventArgs.ShowViewParameters parameter to specify this View and its settings.

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

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_how-to-create-a-custom-action-type-with-a-custom-control-barcheckitem-associated-with-it-e1977/CS/CustomActionControl.Module.Win/Controllers/SampleController.cs#L10

activeFilterAction.Caption = "Active";
activeFilterAction.Execute += activeFilterAction_Execute;
CheckableSimpleAction todayFilterAction = new CheckableSimpleAction(this, "TodayFilterAction", PredefinedCategory.Filters);

XAF_how-to-add-custom-buttons-actions-to-the-lookup-and-popup-windows/CS/WinSolution.Module.Win/PopupListViewController.cs#L27

    //Dennis: Refer to the http://documentation.devexpress.com/#Xaf/CustomDocument2815 help article to see how to reorder Actions within the PopupActions container.
    actionInPopup.Execute += actionInPopup_Execute;
}

xaf-how-to-access-the-master-detailview-information-from-a-nested-listview-controller/CS/WinWebSolution.Module/Controllers/PhoneNumberNestedListViewController.cs#L13

    saMasterDetailViewInfoAction = new SimpleAction(this, "MasterDetailViewInfoAction", DevExpress.Persistent.Base.PredefinedCategory.View);
    saMasterDetailViewInfoAction.Execute += new SimpleActionExecuteEventHandler(saMasterDetailViewInfoAction_Execute);
}

xaf-print-a-report-without-displaying-a-preview/CS/InstantPrintReportsV2Example.Module/Controllers/InstantPrintReportController.cs#L18

printAction.ImageName = "Action_Printing_Print";
printAction.Execute += delegate(object sender, SimpleActionExecuteEventArgs e) {
    IObjectSpace objectSpace = ReportDataProvider.ReportObjectSpaceProvider.CreateObjectSpace(typeof(ReportDataV2));

xaf-web-forms-use-oauth2-authentication-providers/CS/MySolution.Module.Web/Controllers/LogonAuthController.cs#L19

microsoftAction = new SimpleAction(this, "LoginWithMicrosoft", "OAuthActions");
microsoftAction.Execute += microsoftAccountAction_Execute;
microsoftAction.Caption = "Microsoft";

VB.NET

XAF_how-to-create-a-custom-action-type-with-a-custom-control-barcheckitem-associated-with-it-e1977/VB/CustomActionControl.Module.Win/Controllers/SampleController.vb#L12

activeFilterAction.Caption = "Active"
AddHandler activeFilterAction.Execute, AddressOf activeFilterAction_Execute
Dim todayFilterAction As New CheckableSimpleAction(Me, "TodayFilterAction", PredefinedCategory.Filters)

XAF_how-to-add-custom-buttons-actions-to-the-lookup-and-popup-windows/VB/WinSolution.Module.Win/PopupListViewController.vb#L27

    'Dennis: Refer to the http://documentation.devexpress.com/#Xaf/CustomDocument2815 help article to see how to reorder Actions within the PopupActions container.
    AddHandler actionInPopup.Execute, AddressOf actionInPopup_Execute
End Sub

xaf-how-to-access-the-master-detailview-information-from-a-nested-listview-controller/VB/WinWebSolution.Module/Controllers/PhoneNumberNestedListViewController.vb#L16

    saMasterDetailViewInfoAction = New SimpleAction(Me, "MasterDetailViewInfoAction", DevExpress.Persistent.Base.PredefinedCategory.View)
    AddHandler saMasterDetailViewInfoAction.Execute, New SimpleActionExecuteEventHandler(AddressOf saMasterDetailViewInfoAction_Execute)
End Sub

xaf-print-a-report-without-displaying-a-preview/VB/InstantPrintReportsV2Example.Module/Controllers/InstantPrintReportController.vb#L20

printAction.ImageName = "Action_Printing_Print"
AddHandler printAction.Execute, Sub(sender As Object, e As SimpleActionExecuteEventArgs)
    Dim objectSpace As IObjectSpace = ReportDataProvider.ReportObjectSpaceProvider.CreateObjectSpace(GetType(ReportDataV2))

xaf-web-forms-use-oauth2-authentication-providers/VB/MySolution.Module.Web/Controllers/LogonAuthController.vb#L21

microsoftAction = New SimpleAction(Me, "LoginWithMicrosoft", "OAuthActions")
AddHandler microsoftAction.Execute, AddressOf microsoftAccountAction_Execute
microsoftAction.Caption = "Microsoft"