SplashScreenManager.SetWaitFormDescription(String) Method

Sets the active WaitForm‘s description to the specified value.

Namespace: DevExpress.XtraSplashScreen

Assembly: DevExpress.XtraEditors.v19.1.dll

Declaration

C#

public void SetWaitFormDescription(
    string description
)

VB.NET

Public Sub SetWaitFormDescription(
    description As String
)

Parameters

Name	Type	Description
description	String	A string that is the new value for the active WaitForm‘s description.

Remarks

A WaitForm is displayed by a SplashScreenManager in a separate thread. To safely set the active WaitForm’s caption and description, use the SplashScreenManager.SetWaitFormCaption and SplashScreenManager.SetWaitFormDescription properties.

Example

A Wait Form is displayed by a Splash Screen Manager in a separate thread. To dynamically change labels within the Wait Form, while it is being displayed, use the SplashScreenManager.SetWaitFormCaption and SetWaitFormDescription methods.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-dynamically-change-a-wait-forms-labels-e3575

Form1.cs

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Linq;
using System.Text;
using System.Windows.Forms;
using DevExpress.XtraSplashScreen;
using System.Threading;

namespace WaitForm_SetDescription {
    public partial class Form1 : Form {
        public Form1() {
            InitializeComponent();
        }

        private void btnShowWaitForm_Click(object sender, EventArgs e) {
            //Open Wait Form
            SplashScreenManager.ShowForm(this, typeof(WaitForm1), true, true, false);

            //The Wait Form is opened in a separate thread. To change its Description, use the SetWaitFormDescription method.
            for (int i = 1; i <= 100; i++) {
                SplashScreenManager.Default.SetWaitFormDescription(i.ToString() + "%");
                Thread.Sleep(25);
            }

            //Close Wait Form
            SplashScreenManager.CloseForm(false);
        }
    }
}

Form1.vb

Imports Microsoft.VisualBasic
Imports System
Imports System.Collections.Generic
Imports System.ComponentModel
Imports System.Data
Imports System.Drawing
Imports System.Linq
Imports System.Text
Imports System.Windows.Forms
Imports DevExpress.XtraSplashScreen
Imports System.Threading

Namespace WaitForm_SetDescription
    Partial Public Class Form1
        Inherits Form
        Public Sub New()
            InitializeComponent()
        End Sub

        Private Sub btnShowWaitForm_Click(ByVal sender As Object, ByVal e As EventArgs) Handles btnShowWaitForm.Click
            'Open Wait Form
            SplashScreenManager.ShowForm(Me, GetType(WaitForm1), True, True, False)

            'The Wait Form is opened in a separate thread. To change its Description, use the SetWaitFormDescription method.
            For i As Integer = 1 To 100
                SplashScreenManager.Default.SetWaitFormDescription(i.ToString() & "%")
                Thread.Sleep(25)
            Next i

            'Close Wait Form
            SplashScreenManager.CloseForm(False)
        End Sub
    End Class
End Namespace

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the SetWaitFormDescription(String) 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.

C#

how-to-dynamically-change-a-wait-forms-labels-e3575/CS/Form1.cs#L24

for (int i = 1; i <= 100; i++) {
    SplashScreenManager.Default.SetWaitFormDescription(i.ToString() + "%");
    Thread.Sleep(25);

VB.NET

how-to-dynamically-change-a-wait-forms-labels-e3575/VB/Form1.vb#L26

For i As Integer = 1 To 100
    SplashScreenManager.Default.SetWaitFormDescription(i.ToString() & "%")
    Thread.Sleep(25)