SimpleAction.Execute Event

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

Namespace: DevExpress.ExpressApp.Actions

Assembly: DevExpress.ExpressApp.v22.1.dll

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.

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-replace-a-list-views-default-action-e3275/CS/ReplaceDefaultActionInListView.Module.Win/EditAddressBookRecordController.cs#L16

        SelectionDependencyType.RequireSingleObject;
    editAddressBookRecordAction.Execute += editAddressBookRecordAction_Execute;
}

XAF_how-to-save-and-share-custom-view-settings-t537863/CS/ViewSettingsSolution.Module/Controllers/ViewVariantsController.cs#L149

this.DeleteViewVariantAction = new SimpleAction(this, "DeleteViewVariant", "Edit");
this.DeleteViewVariantAction.Execute += new SimpleActionExecuteEventHandler(this.DeleteViewVariantAction_Execute);

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-e466/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-show-an-xtrareport-created-at-design-time-without-the-use-of-xaf-reports-module-e4752/CS/NativeXtraReportExample.Module.Win/Controllers/ShowXtraReportController.cs#L19

showReportAction.PaintStyle = ActionItemPaintStyle.CaptionAndImage;
showReportAction.Execute += new SimpleActionExecuteEventHandler(showReportAction_Execute);
var showReportWithParametersAction = new PopupWindowShowAction(this, "ShowReportWithParameters", PredefinedCategory.View);

VB.NET

XAF_how-to-execute-actions-in-code-e1393/VB/WinWebSolution.Module.Win/ActionsInvokerViewController.vb#L15

End Sub
Private Sub saPopupWindowShowActionInvoker_Execute(ByVal sender As Object, ByVal e As SimpleActionExecuteEventArgs) Handles saPopupWindowShowActionInvoker.Execute
    Dim linkUnlinkController As LinkUnlinkController = Frame.GetController(Of LinkUnlinkController)()

XAF_how-to-replace-a-list-views-default-action-e3275/VB/ReplaceDefaultActionInListView.Module.Win/EditAddressBookRecordController.vb#L16

    editAddressBookRecordAction.SelectionDependencyType = SelectionDependencyType.RequireSingleObject
    AddHandler editAddressBookRecordAction.Execute, AddressOf editAddressBookRecordAction_Execute
End Sub

XAF_how-to-save-and-share-custom-view-settings-t537863/VB/ViewSettingsSolution.Module/Controllers/ViewVariantsController.vb#L150

Me.DeleteViewVariantAction = New SimpleAction(Me, "DeleteViewVariant", "Edit")
AddHandler DeleteViewVariantAction.Execute, AddressOf DeleteViewVariantAction_Execute

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-e466/VB/WinSolution.Module.Win/PopupListViewController.vb#L24

    '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