Back to Devexpress

VGridControlBase.Caption Property

windowsforms-devexpress-dot-xtraverticalgrid-dot-vgridcontrolbase-acf69507.md

latest3.3 KB
Original Source

VGridControlBase.Caption Property

Gets or sets the control’s caption. Enable the OptionsView.ShowCaption property to display the caption.

Namespace : DevExpress.XtraVerticalGrid

Assembly : DevExpress.XtraVerticalGrid.v25.2.dll

NuGet Packages : DevExpress.Win.Navigation, DevExpress.Win.VerticalGrid

Declaration

csharp
[DefaultValue("")]
[DXCategory("Appearance")]
[XtraSerializableProperty]
public string Caption { get; set; }
vb
<DefaultValue("")>
<DXCategory("Appearance")>
<XtraSerializableProperty>
Public Property Caption As String

Property Value

TypeDefaultDescription
StringString.Empty

The control’s caption.

|

Remarks

Do the following to display a caption for the control:

Example

The following code snippet handles the VGridControl.RecordCountChanged event. The event handler updates the Vertical Grid’s caption (VGridControlBase.Caption) to display the visible record count and total record count.

See the following demo for the complete code: Run Demo: PC Market

csharp
vGridControl1.OptionsView.ShowCaption = true;
//...
// RecordCountChanged event handler:
void OnRecordCountChanged(object sender, System.EventArgs e) {
    UpdateCaption(vGridControl1.RecordCount, configurations.Count);
}
void UpdateCaption(int visible, int total) {
    vGridControl1.Caption = string.Format("Showing {0:n0} out of {1:n0} configurations", visible, total);
}
vb
vGridControl1.OptionsView.ShowCaption = True

' RecordCountChanged event handler:
Private Sub OnRecordCountChanged(ByVal sender As Object, ByVal e As System.EventArgs)
    UpdateCaption(vGridControl1.RecordCount, configurations.Count)
End Sub

Private Sub UpdateCaption(ByVal visible As Integer, ByVal total As Integer)
    vGridControl1.Caption = String.Format("Showing {0:n0} out of {1:n0} configurations", visible, total)
End Sub

See Also

ShowCaption

VGridControlBase Class

VGridControlBase Members

DevExpress.XtraVerticalGrid Namespace