ShowViewStrategyBase.ShowViewInPopupWindow(View, Action, Action, String, String, Frame) Method

Shows the specified View in a popup dialog with OK and Cancel buttons.

Namespace: DevExpress.ExpressApp

Assembly: DevExpress.ExpressApp.v20.2.dll

NuGet Package: DevExpress.ExpressApp

Declaration

C#

public void ShowViewInPopupWindow(
    View view,
    Action okDelegate = null,
    Action cancelDelegate = null,
    string okButtonCaption = null,
    string cancelButtonCaption = null,
    Frame sourceFrame = null
)

VB.NET

Public Sub ShowViewInPopupWindow(
    view As View,
    okDelegate As Action = Nothing,
    cancelDelegate As Action = Nothing,
    okButtonCaption As String = Nothing,
    cancelButtonCaption As String = Nothing,
    sourceFrame As Frame = Nothing
)

Parameters

Name	Type	Description
view	View	The View that this method shows in a pop-up window.

Optional Parameters

Name	Type	Default	Description
okDelegate	Action	*null*	The Action delegate that this method executes when the OK button is clicked. This parameter is optional.
cancelDelegate	Action	*null*	The Action delegate that this method executes when the Cancel button is clicked. This parameter is optional.
okButtonCaption	String	*null*	The custom caption of the OK button. This parameter is optional.
cancelButtonCaption	String	*null*	The custom caption of the Cancel button. This parameter is optional.
sourceFrame	Frame	*null*	The parent Frame of the View that this method shows in a pop-up window. This parameter is optional and used in WinForms applications only.

Remarks

The ShowViewInPopupWindow method displays the dialog that contains the specified View and two buttons - OK and Cancel. Both buttons close the dialog.

The following example demonstrates how to use this method:

C#

using DevExpress.ExpressApp;
using DevExpress.ExpressApp.Actions;
using DevExpress.ExpressApp.DC;
// ...
public class MyDialogController : ViewController {
    public MyDialogController() {
        SimpleAction action = new SimpleAction(this, "Email", "View");
        action.Execute += Action_Execute;
    }
    private void Action_Execute(object sender, SimpleActionExecuteEventArgs e) {
        IObjectSpace objectSpace = Application.CreateObjectSpace(typeof(MyDialog));
        MyDialog myDialogObject = new MyDialog("Do you want to send an email?");
        DetailView dialogView = Application.CreateDetailView(objectSpace, myDialogObject);
        Application.ShowViewStrategy.ShowViewInPopupWindow(dialogView,
            () => Application.ShowViewStrategy.ShowMessage("Done."),
            () => Application.ShowViewStrategy.ShowMessage("Cancelled."),
            null, null, this.Frame
        );
    }
}

[DomainComponent]
public class MyDialog {
    public MyDialog(string message) {
        this.Message = message;
    }
    public string Message { get; private set; }
}

VB.NET

Imports DevExpress.ExpressApp
Imports DevExpress.ExpressApp.Actions
Imports DevExpress.ExpressApp.DC
' ...
Public Class MyDialogController
    Inherits ViewController
    Public Sub New()
        Dim action As New SimpleAction(Me, "Email", "View")
        AddHandler action.Execute, AddressOf Action_Execute
    End Sub
    Private Sub Action_Execute(ByVal sender As Object, ByVal e As SimpleActionExecuteEventArgs)
        Dim objectSpace As IObjectSpace = Application.CreateObjectSpace(GetType(MyDialog))
        Dim myDialogObject As New MyDialog("Do you want to send an email?")
        Dim dialogView As DetailView = Application.CreateDetailView(objectSpace, myDialogObject)
        Application.ShowViewStrategy.ShowViewInPopupWindow(dialogView,
            Sub() Application.ShowViewStrategy.ShowMessage("Done."),
            Sub() Application.ShowViewStrategy.ShowMessage("Cancelled."),
            Nothing, Nothing, Me.Frame
        )
    End Sub
End Class

<DomainComponent>
Public Class MyDialog
    Public Sub New(ByVal message As String)
        Me.Message = message
    End Sub
    Private privateMessage As String
    Public Property Message() As String
        Get
            Return privateMessage
        End Get
        Private Set(ByVal value As String)
            privateMessage = value
        End Set
    End Property
End Class

You can also use PopupWindowShowAction to show a View in a pop-up window. For more information, refer to the following help topic: Add an Action that Displays a Pop-up Window.

Note

ASP.NET applications have the following specifics:

• You can use the ShowViewInPopupWindow method on XafCallbackManager callbacks that the RaiseXafCallback script initiates. You cannot use it on control callbacks (for example, grid sorting).
• It is not possible to pause the current request to wait for user input.
• The main window is not refreshed when the Cancel button is clicked.