ActionBase.ConfirmationMessage Property

Specifies the confirmation message displayed when an end-user executes an Action.

Namespace: DevExpress.ExpressApp.Actions

Assembly: DevExpress.ExpressApp.v18.2.dll

Declaration

C#

[DefaultValue("")]
public string ConfirmationMessage { get; set; }

VB.NET

<DefaultValue("")>
Public Property ConfirmationMessage As String

Property Value

Type	Default	Description
String	String.Empty	A string containing the current Action’s confirmation message.

Remarks

When executing an Action, a pop-up window is invoked to display a confirmation message if it is specified by the ConfirmationMessage property. To change an Action’s confirmation message at run time, use the Application Model’s IModelAction.ConfirmationMessage property of the corresponding ActionDesign | Actions | <Action> node. You can do this either via the Model Editor or by accessing the Application Model in code.

You can include the ‘{0}’ format item in the confirmation message. This item will be replaced at run time with either the currently selected object’s caption (if the ActionBase.SelectionDependencyType property is set to RequireSingleObject) or the selected objects count (if the ActionBase.SelectionDependencyType property is set to RequireMultipleObjects). To learn more about formatting confirmation messages, refer to the Specify Action Settings tutorial lesson.

In Windows Forms applications, the confirmation dialog contains “Yes” and “No” buttons. Meantime, in ASP.NET applications, the buttons are “OK” and “Cancel”. Keep this fact in mind when composing text for the ConfirmationMessage property.

Tip

To use data from objects that are currently selected by user, follow the approach described in the How to: Access Objects Selected in the Current View example.

The example below adds a confirmation message to a SimpleAction, and if the user confirms, assigns a Contact‘s FirstName value to the NickName property.

C#

using DevExpress.ExpressApp;
using DevExpress.ExpressApp.Actions;
using DevExpress.Persistent.Base;
using MainDemo.Module.BusinessObjects;
// ...
public class SetNickNameController : ObjectViewController<DetailView, Contact> {
    public SetNickNameController() {
        SimpleAction setNickNameAction = new SimpleAction(this, "SetNickName", PredefinedCategory.Edit);
        setNickNameAction.ConfirmationMessage = "Do you want to continue?";
        setNickNameAction.Execute += SetNickNameAction_Execute;
    }
    private void SetNickNameAction_Execute(object sender, SimpleActionExecuteEventArgs e) {
        Contact currentObject = ViewCurrentObject;
        if(currentObject != null) {
            currentObject.NickName = currentObject.FirstName;
        }
    }
}

VB.NET

Imports DevExpress.ExpressApp
Imports DevExpress.ExpressApp.Actions
Imports DevExpress.Persistent.Base
Imports MainDemo.Module.BusinessObjects

Public Class SetNickNameController
    Inherits ObjectViewController(Of DetailView, Contact)
    Public Sub New()
        Dim setNickNameAction As New SimpleAction(Me, "SetNickName", PredefinedCategory.Edit)
        setNickNameAction.ConfirmationMessage = "Do you want to continue?"
        AddHandler setNickNameAction.Execute, AddressOf SetNickNameAction_Execute
    End Sub
    Private Sub SetNickNameAction_Execute(ByVal sender As Object, ByVal e As SimpleActionExecuteEventArgs)
        Dim currentObject As Contact = ViewCurrentObject
        If currentObject IsNot Nothing Then
            currentObject.NickName = currentObject.FirstName
        End If
    End Sub
End Class

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the ConfirmationMessage property.

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-access-objects-selected-in-the-current-view-e3016/CS/SelectedObjects.Module/MyConfirmationController.cs#L27

if (View.SelectedObjects.Count == 1) {
    deleteObjectsViewController.DeleteAction.ConfirmationMessage =
        String.Format("You are about to delete the '{0}' Contact. Do you want to proceed?",

VB.NET

XAF_how-to-access-objects-selected-in-the-current-view-e3016/VB/SelectedObjects.Module/MyConfirmationController.vb#L29

If View.SelectedObjects.Count = 1 Then
    deleteObjectsViewController.DeleteAction.ConfirmationMessage = String.Format("You are about to delete the '{0}' Contact. Do you want to proceed?", CType(View.CurrentObject, Contact).FullName)
Else