ProgressPanel.Caption Property

Gets or sets the control’s caption.

Namespace: DevExpress.XtraWaitForm

Assembly: DevExpress.XtraEditors.v24.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

[DefaultValue(null)]
[DXCategory("Display Options")]
public string Caption { get; set; }

VB.NET

<DefaultValue(Nothing)>
<DXCategory("Display Options")>
Public Property Caption As String

Property Value

Type	Default	Description
String	null	A string that specifies the control’s caption.

Remarks

The ProgressPanel contains a caption and ProgressPanel.Description displayed one under another. To control their visibility, use the ProgressPanel.ShowCaption and ProgressPanel.ShowDescription properties.

The appearance settings used to paint the caption and description are specified by the ProgressPanel.AppearanceCaption and ProgressPanel.AppearanceDescription properties, respectively.

The following properties affect the layout of the control’s caption, description and image:

• ProgressPanel.CaptionToDescriptionDistance - Specifies the vertical distance between the caption and description.
• ProgressPanel.AnimationToTextDistance - Specifies the horizontal distance between the image and text (caption plus description).
• ProgressPanel.ImageHorzOffset - Specifies the horizontal distance between the control’s left edge and the image.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Caption property.

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#L38

    base.SetCaption(caption);
    this.progressPanel1.Caption = caption;
}

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

    base.SetCaption(caption);
    this.progressPanel1.Caption = caption;
}

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

    base.SetCaption(caption);
    this.progressPanel1.Caption = caption;
}

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

    base.SetCaption(caption);
    this.progressPanel1.Caption = caption;
}

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

    base.SetCaption(caption);
    progressPanel1.Caption = caption;
}

VB.NET

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

    MyBase.SetCaption(caption)
    progressPanel1.Caption = caption
End Sub

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

    MyBase.SetCaption(caption)
    Me.progressPanel1.Caption = caption
End Sub

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

    MyBase.SetCaption(caption)
    progressPanel1.Caption = caption
End Sub

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

    MyBase.SetCaption(caption)
    Me.progressPanel1.Caption = caption
End Sub

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

    MyBase.SetCaption(caption)
    progressPanel1.Caption = caption
End Sub