Back to Devexpress

DxFlyout.CloseAsync(CancellationToken) Method

blazor-devexpress-dot-blazor-dot-dxflyout-dot-closeasync-x28-system-dot-threading-dot-cancellationtoken-x29.md

latest2.7 KB
Original Source

DxFlyout.CloseAsync(CancellationToken) Method

Asynchronously closes the flyout window.

Namespace : DevExpress.Blazor

Assembly : DevExpress.Blazor.v25.2.dll

NuGet Package : DevExpress.Blazor

Declaration

csharp
public Task<bool> CloseAsync(
    CancellationToken token = default(CancellationToken)
)

Optional Parameters

NameTypeDefaultDescription
tokenCancellationTokennull

An object that propagates a cancellation notification.

|

Returns

TypeDescription
Task<Boolean>

An asynchronous operation that closes the window and returns true if the operation is successful; otherwise, it returns false.

|

Remarks

Call the ShowAsync and CloseAsync methods to show and close the flyout window asynchronously.

razor
<DxButton Text="Show" Click="ShowWindow" aria-describedby="flyout" />
<DxButton Text="Hide" Click="HideWindow" />

<DxFlyout Id="flyout" @ref="flyoutWindow" Width="400" CloseOnOutsideClick="false"
            BodyText="Lorem ipsum dolor sit amet, consectetur adipiscing elit." />

@code {
    DxFlyout flyoutWindow { get; set; }

    async Task ShowWindow(MouseEventArgs args) {
        if (!flyoutWindow.IsInitialized)
            await flyoutWindow.InitializedTask;
            await flyoutWindow.ShowAsync();
    }
    async Task HideWindow(MouseEventArgs args) {
        await flyoutWindow.CloseAsync();
    }
}

You can handle the following events related to ShowAsync and CloseAsync methods:

ShowingFires before the flyout window is displayed.ShownFires after the flyout window is displayed.ClosingFires before the flyout window is closed.ClosedFires after the flyout window is closed.

To show and close the flyout window synchronously, implement two-way binding for the IsOpen property.

See Also

DxFlyout Class

DxFlyout Members

DevExpress.Blazor Namespace