ParametrizedAction.DoExecute(Object) Method

Raises the ActionBase.Executing, SimpleAction.Execute, ActionBase.Executed, ActionBase.ProcessCreatedView and ActionBase.ExecuteCompleted events one after another.

Namespace: DevExpress.ExpressApp.Actions

Assembly: DevExpress.ExpressApp.v24.1.dll

NuGet Package: DevExpress.ExpressApp

Declaration

C#

public void DoExecute(
    object parameterNewValue
)

VB.NET

Public Sub DoExecute(
    parameterNewValue As Object
)

Parameters

Name	Type	Description
parameterNewValue	Object	An object that represents the value currently entered into the Parametrized Action’s editor.

Remarks

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

The following code snippets (auto-collected from DevExpress Examples) contain references to the DoExecute(Object) method.

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#L50

        && Guid.TryParse(GetOid(e), out var oid)) {
    openDetailViewAction.DoExecute(oid);
}

xaf-how-to-execute-actions-in-code/CS/WinWebSolution.Module.Win/ActionsInvokerViewController.cs#L34

if(filterController != null) {
    filterController.FullTextFilterAction.DoExecute("test value");
}

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

    isExecuted = true;
    ((ParametrizedAction)Action).DoExecute(Control.Value);
}

VB.NET

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

If (IsGridDashboardItem(dashboard, e.DashboardItemName) AndAlso openDetailViewAction.Enabled.ResultValue AndAlso openDetailViewAction.Active.ResultValue AndAlso Guid.TryParse(GetOid(e), oid)) Then
    openDetailViewAction.DoExecute(oid)
End If

xaf-how-to-execute-actions-in-code/VB/WinWebSolution.Module.Win/ActionsInvokerViewController.vb#L40

If filterController IsNot Nothing Then
    filterController.FullTextFilterAction.DoExecute("test value")
End If

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

    isExecuted = True
    CType(Action, ParametrizedAction).DoExecute(Control.Value)
End If