PopupWindowShowAction.Execute Event
Occurs when an end-user clicks the accept button on the Pop-up Window Show Action’s pop-up Window.
Namespace: DevExpress.ExpressApp.Actions
Assembly: DevExpress.ExpressApp.v24.2.dll
NuGet Package: DevExpress.ExpressApp
Declaration
Event Data
The Execute event's data class is PopupWindowShowActionExecuteEventArgs. The following properties provide information specific to this event:
Property | Description |
---|---|
Action | Provides access to the Action being executed. Inherited from ActionBaseEventArgs. |
CanCloseWindow | Specifies whether to close a Pop-up Window Show Action’s pop-up Window after clicking its accepting button. |
CurrentObject | Provides access to the current object represented by the currently displayed View. Inherited from SimpleActionExecuteEventArgs. |
PopupWindow | Provides access to a Pop-up Window Show Actions’ pop-up Window. |
PopupWindowView | Gets a View displayed within the PopupWindowShowActionExecuteEventArgs.PopupWindow. |
PopupWindowViewCurrentObject | Gets the current object of the PopupWindowShowActionExecuteEventArgs.PopupWindowView View. |
PopupWindowViewSelectedObjects | Gets the list of objects selected in the PopupWindowShowActionExecuteEventArgs.PopupWindowView View. |
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
Handle this event to execute custom code when clicking the accept button on the pop-up Window of the Pop-up Window Show Action. Use the handler’s PopupWindowShowActionExecuteEventArgs.PopupWindow parameter to access the current pop-up Window. Use the PopupWindowShowActionExecuteEventArgs.PopupWindowViewCurrentObject and PopupWindowShowActionExecuteEventArgs.PopupWindowViewSelectedObjects properties to access the current and selected objects of the View displayed within the pop-up Window. You can also specify whether to close the pop-up Window after executing your code. To do this, use the PopupWindowShowActionExecuteEventArgs.CanCloseWindow parameter.
To execute custom code when clicking the cancel button on the pop-up Window, handle the PopupWindowShowAction.Cancel event.
If you need an additional View to be displayed after clicking the accept button, use the event handler’s 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 asExecute
). - 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.