WaitForm.SetCaption(String) Method

Sets the WaitForm‘s caption to the specified value.

Namespace: DevExpress.XtraWaitForm

Assembly: DevExpress.XtraEditors.v24.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

public virtual void SetCaption(
    string caption
)

VB.NET

Public Overridable Sub SetCaption(
    caption As String
)

Parameters

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

Remarks

A WaitForm contains two labels displaying a caption and description:

The SetCaption and WaitForm.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 SetCaption(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#L37

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

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

public override void SetCaption(string caption) {
    base.SetCaption(caption);
    this.progressPanel1.Caption = caption;

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

public override void SetCaption(string caption) {
    base.SetCaption(caption);
    this.progressPanel1.Caption = caption;

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

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

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

public override void SetCaption(string caption) {
    base.SetCaption(caption);
    progressPanel1.Caption = caption;

VB.NET

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

Public Overrides Sub SetCaption(ByVal caption As String)
    MyBase.SetCaption(caption)
    progressPanel1.Caption = caption

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

Public Overrides Sub SetCaption(ByVal caption As String)
    MyBase.SetCaption(caption)
    Me.progressPanel1.Caption = caption

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

Public Overrides Sub SetCaption(ByVal caption As String)
    MyBase.SetCaption(caption)
    progressPanel1.Caption = caption

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

Public Overrides Sub SetCaption(ByVal caption As String)
    MyBase.SetCaption(caption)
    Me.progressPanel1.Caption = caption

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

Public Overrides Sub SetCaption(ByVal caption As String)
    MyBase.SetCaption(caption)
    progressPanel1.Caption = caption