Back to Devexpress

SplashScreenManager.ShowWaitForm() Method

windowsforms-devexpress-dot-xtrasplashscreen-dot-splashscreenmanager-c05657ef.md

latest5.6 KB
Original Source

SplashScreenManager.ShowWaitForm() Method

Creates and displays a WaitForm, whose type is specified by the SplashScreenManager.ActiveSplashFormTypeInfo property.

Namespace : DevExpress.XtraSplashScreen

Assembly : DevExpress.XtraEditors.v25.2.dll

NuGet Package : DevExpress.Win.Navigation

Declaration

csharp
public void ShowWaitForm()
vb
Public Sub ShowWaitForm

Remarks

To close the Wait Form, use the SplashScreenManager.CloseWaitForm method.

If the Wait Form is not displayed, calling the CloseWaitForm method throws an exception.

The following code snippets (auto-collected from DevExpress Examples) contain references to the ShowWaitForm() 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.

report-server-how-to-manage-scheduled-jobs-from-a-windows-forms-application/CS/ScheduledTasksAPIClientDemo/MainForm.cs#L27

csharp
void MainForm_Load(object sender, EventArgs e) {
    splashScreenManager1.ShowWaitForm();

winforms-scheduler-synchronize-appointments-with-outlook-365/CS/DXOutlook365Sync/Form1.cs#L103

csharp
// Displays the wait form.
splashScreenManager1.ShowWaitForm();
splashScreenManager1.SetWaitFormDescription("Importing Outlook365 events...");

winforms-wait-form-cancel-operation/CS/WaitFormCanceling/Form1.cs#L77

csharp
splashScreenManager1.ShowWaitForm();
splashScreenManager1.SendCommand(WaitForm1.WaitFormCommand.SendObject, locker1);

winforms-spreadsheet-create-custom-progress-indicator/CS/SpreadsheetProgressSample/Form1.cs#L27

csharp
savedCancellationTokenProvider = spreadsheetControl1.ReplaceService<ICancellationTokenProvider>(new CancellationTokenProvider(cancellationTokenSource.Token));
splashScreenManager1.ShowWaitForm();
// Display the name of the running operation in the Wait Form.

report-server-how-to-manage-scheduled-jobs-from-a-windows-forms-application/VB/ScheduledTasksAPIClientDemo/MainForm.vb#L29

vb
Private Sub MainForm_Load(ByVal sender As Object, ByVal e As EventArgs) Handles Me.Load
    splashScreenManager1.ShowWaitForm()

winforms-scheduler-synchronize-appointments-with-outlook-365/VB/DXOutlook365Sync/Form1.vb#L95

vb
' Displays the wait form.
splashScreenManager1.ShowWaitForm()
splashScreenManager1.SetWaitFormDescription("Importing Outlook365 events...")

winforms-wait-form-cancel-operation/VB/WaitFormCanceling/Form1.vb#L66

vb
backgroundWorker1.RunWorkerAsync(locker1)
splashScreenManager1.ShowWaitForm()
splashScreenManager1.SendCommand(WaitForm1.WaitFormCommand.SendObject, locker1)

winforms-spreadsheet-create-custom-progress-indicator/VB/SpreadsheetProgressSample/Form1.vb#L29

vb
savedCancellationTokenProvider = spreadsheetControl1.ReplaceService(Of ICancellationTokenProvider)(New CancellationTokenProvider(cancellationTokenSource.Token))
splashScreenManager1.ShowWaitForm()
' Display the name of the running operation in the Wait Form.

See Also

CloseWaitForm()

SplashScreenManager Class

SplashScreenManager Members

DevExpress.XtraSplashScreen Namespace