WaitForm.SetDescription(String) Method

Sets the WaitForm‘s description to the specified value.

Namespace: DevExpress.XtraWaitForm

Assembly: DevExpress.XtraEditors.v24.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

public virtual void SetDescription(
    string description
)

VB.NET

Public Overridable Sub SetDescription(
    description As String
)

Parameters

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

Remarks

A WaitForm contains two labels displaying a caption and description:

The WaitForm.SetCaption and SetDescription methods allow you to set the form’s caption and descriptions to custom values.

Related GitHub Examples

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

winforms-wait-form-cancel-operation/CS/WaitFormCanceling/WaitForm1.cs#L42

{
    base.SetDescription(description);
    this.progressPanel1.Description = description;

winforms-splash-screen-loading-panel/CS/WaitForm1.cs#L24

public override void SetDescription(string description) {
    base.SetDescription(description);
    this.progressPanel1.Description = description;

winforms-wait-form-dynamically-change-labels/CS/WaitForm1.cs#L24

public override void SetDescription(string description) {
    base.SetDescription(description);
    this.progressPanel1.Description = description;

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

{
    base.SetDescription(description);
    this.progressPanel1.Description = description;

winforms-spreadsheet-create-custom-progress-indicator/CS/SpreadsheetProgressSample/WaitForm1.cs#L20

public override void SetDescription(string description) {
    base.SetDescription(description);
    progressPanel1.Description = description;

VB.NET

winforms-wait-form-cancel-operation/VB/WaitFormCanceling/WaitForm1.vb#L36

Public Overrides Sub SetDescription(ByVal description As String)
    MyBase.SetDescription(description)
    progressPanel1.Description = description

winforms-splash-screen-loading-panel/VB/WaitForm1.vb#L26

Public Overrides Sub SetDescription(ByVal description As String)
    MyBase.SetDescription(description)
    Me.progressPanel1.Description = description

winforms-wait-form-dynamically-change-labels/VB/WaitForm1.vb#L23

Public Overrides Sub SetDescription(ByVal description As String)
    MyBase.SetDescription(description)
    progressPanel1.Description = description

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

Public Overrides Sub SetDescription(ByVal description As String)
    MyBase.SetDescription(description)
    Me.progressPanel1.Description = description

winforms-spreadsheet-create-custom-progress-indicator/VB/SpreadsheetProgressSample/WaitForm1.vb#L22

Public Overrides Sub SetDescription(ByVal description As String)
    MyBase.SetDescription(description)
    progressPanel1.Description = description