BaseOptionsView.ShowCaption Property

Gets or sets whether the control displays a caption (Caption) at the top.

Namespace: DevExpress.XtraVerticalGrid

Assembly: DevExpress.XtraVerticalGrid.v24.2.dll

Declaration

C#

[DefaultValue(false)]
[XtraSerializableProperty]
public virtual bool ShowCaption { get; set; }

VB.NET

<DefaultValue(False)>
<XtraSerializableProperty>
Public Overridable Property ShowCaption As Boolean

Property Value

Type	Default	Description
Boolean	false	true if the control displays a caption; otherwise, false.

Property Paths

You can access this nested property as listed below:

Object Type	Path to ShowCaption
VGridControlBase	.OptionsView .ShowCaption

Remarks

Do the following to display a caption for the control:

• Enable the ShowCaption option.
• Set the VGridControlBase.Caption property.

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

C#

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.NET

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