ActionBase.GetFormattedConfirmationMessage() Method

Returns a formatted confirmation message displayed when executing an Action.

Namespace: DevExpress.ExpressApp.Actions

Assembly: DevExpress.ExpressApp.v23.2.dll

NuGet Package: DevExpress.ExpressApp

Declaration

C#

public string GetFormattedConfirmationMessage()

VB.NET

Public Function GetFormattedConfirmationMessage As String

Returns

Type	Description
String	A string that represents a formatted confirmation message.

Remarks

Via an Action’s ActionBase.ConfirmationMessage property, you can specify a message that will be displayed before executing the Action. Moreover, you can set this property to a string value that contains variables. When an Action Container performs a confirmation dialog display, it uses the GetFormattedConfirmationMessage method to get the specified message.

When implementing a custom Action Container, use the GetFormattedConfirmationMessage to get an Action’s cofirmation message.

You can handle the ActionBase.CustomGetFormattedConfirmationMessage event to customize this method result.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the GetFormattedConfirmationMessage() 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-how-to-create-a-custom-action-with-a-custom-control-in-xaf-aspnet-application/CS/Solution28.Module.Web/ParametrizedRangeActionMenuActionItem.cs#L116

public override void SetClientClickHandler(XafCallbackManager callbackManager, string controlID) {
    string clientScript = callbackManager.GetScript(controlID, string.Format("'{0}'", MenuItem.IndexPath), Action.GetFormattedConfirmationMessage(), IsPostBackRequired);
    clientClickHandler = string.Format("function(s, e) {{ {0}e.processOnServer = false;}}", clientScript);

VB.NET

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

Public Overrides Sub SetClientClickHandler(ByVal callbackManager As XafCallbackManager, ByVal controlID As String)
    Dim clientScript As String = callbackManager.GetScript(controlID, String.Format("'{0}'", MenuItem.IndexPath), Action.GetFormattedConfirmationMessage(), IsPostBackRequired)
    clientClickHandler = String.Format("function(s, e) {{ {0}e.processOnServer = false;}}", clientScript)