Skip to main content
All docs
V24.2

MessageBoxOptions.CloseOnEscape Property

Specifies whether the message box should be closed when a user presses Escape.

Namespace: DevExpress.Blazor

Assembly: DevExpress.Blazor.v24.2.dll

NuGet Package: DevExpress.Blazor

Declaration

[DefaultValue(null)]
public bool? CloseOnEscape { get; set; }

Property Value

Type Default Description
Nullable<Boolean> null

true to close the message box when a user presses Escape;
false to keep the message box open when a user presses Escape;
null to inherit the value from the DxDialogProvider.CloseOnEscape property.

Remarks

Users can close a message box in the following ways:

  • Click the Close button in the header.
  • Press Escape.
  • Click outside the message box’s boundaries.

Set the CloseOnEscape property to false to prevent the message box from closing in response to the Escape keystroke. The ShowCloseButton and CloseOnOutsideClick properties allow you to control other user capabilities.

Run Demo

<DxDialogProvider />
<DxButton Text="Show a message box window" Click="@OpenConfirmDialogAsync" />

@code {
    [Inject] IDialogService DialogService { get; set; }

    private async Task OpenConfirmDialogAsync() {
    await DialogService.ConfirmAsync(new MessageBoxOptions() {
            Title = "Error",
            Text = "Unable to process the request. Please try again later or contact support.",
            CloseOnEscape = false,
            ShowCloseButton = false,
            CloseOnOutsideClick = true
        });
    }
}

If the CloseOnEscape property is not specified, the DxDialogProvider.CloseOnEscape property determines the message box behavior.

See Also