BaseView.ViewCaption Property

Gets or sets the View Caption.

Namespace: DevExpress.XtraGrid.Views.Base

Assembly: DevExpress.XtraGrid.v24.2.dll

Declaration

C#

[DefaultValue("")]
[DXCategory("Appearance")]
[XtraSerializableProperty]
public string ViewCaption { get; set; }

VB.NET

<DefaultValue("")>
<XtraSerializableProperty>
<DXCategory("Appearance")>
Public Property ViewCaption As String

Property Value

Type	Default	Description
String	String.Empty	A string value specifying the View’s caption.

Remarks

View Captions are displayed in the following cases:

• When the ColumnViewOptionsView.ShowViewCaption option is enabled. In this mode, the View Caption is displayed above the View.
• Within Detail tabs that allow end-users to switch between details.
• Within Detail tooltips that are used to expand master rows, making a particular detail visible.
• Within the joined group panel, View captions are used to identify master and detail Views.

If the ViewCaption property value is an empty string, the View’s corresponding relationship name (BaseView.LevelName) is used. If a View is the main View (see GridControl.MainView) and the ViewCaption property is not set, the ‘MainView‘ string is used as the View caption.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the ViewCaption 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.

VB.NET

winforms-grid-visualize-master-detail-data/VB/Form1.vb#L40

'Specify text to be displayed within detail tabs.
cardView1.ViewCaption = "Category Products"
'Hide the CategoryID column for the master View