A newer version of this page is available. Switch to the current version.

WaitForm Class

A small form, designed to display the progress of a lengthy operation. The form's display is managed by the SplashScreenManager component.

Namespace: DevExpress.XtraWaitForm

Assembly: DevExpress.XtraEditors.v19.2.dll

Declaration

public class WaitForm :
    SplashFormBase
Public Class WaitForm
    Inherits SplashFormBase

Remarks

A WaitForm contains an animated image (obtained from the current skin) and two custom labels (caption and description) displayed one under another:

ProgressPanel

To create a Wait Form, drop a SplashScreenManager component onto your form, click the component's tag and then click the Add Wait Form link in the SplashScreenManager Tasks window that will open:

SplashScreenManager-Tasks.png

This generates a WaitForm descendant that you can modify at design time or in code.

using DevExpress.XtraWaitForm;

namespace WindowsFormsApplication445
{
    public partial class WaitForm1 : WaitForm
    {
        public WaitForm1()
        {
            InitializeComponent();
            this.progressPanel1.AutoHeight = true;
            this.progressPanel1.Caption = "My caption";
            this.progressPanel1.ShowCaption = true;
            this.progressPanel1.Description = "My description";
            this.progressPanel1.ShowDescription = true;
            this.progressPanel1.ToolTip = "My tooltip";
            this.progressPanel1.ShowToolTips = true;
            this.progressPanel1.WaitAnimationType = DevExpress.Utils.Animation.WaitingAnimatorType.Ring;
            this.progressPanel1.CaptionToDescriptionDistance = 5;
        }
     }
}

A Wait Form needs to be manually displayed, using the methods provided by the SplashScreenManager component.

See Wait Form to learn more.

Inheritance

Show 13 items
Object
MarshalByRefObject
Component
Control
ScrollableControl
ContainerControl
Form
DevExpress.XtraEditors.DForm
DevExpress.Utils.Win.TopFormBase
DevExpress.Utils.Win.CustomTopForm
DevExpress.Utils.Win.StickLookAndFeelForm
See Also