RowProperties.Caption Property

Gets or sets the caption for a row item.

Namespace: DevExpress.XtraVerticalGrid.Rows

Assembly: DevExpress.XtraVerticalGrid.v19.2.dll

Declaration

C#

[DefaultValue("")]
[XtraSerializableProperty]
public string Caption { get; set; }

VB.NET

<DefaultValue("")>
<XtraSerializableProperty>
Public Property Caption As String

Property Value

Type	Default	Description
String	String.Empty	A string value specifying the caption of a row item. If not set, returns an empty string.

Remarks

Use this property to specify the string that describes data which is represented by a row item. If the row to which the item belongs is visible, the row item caption is displayed as a row header in the header panel of a vertical grid control.

This property is not initially set (it is equal to an empty string). You should set the Caption property manually (either at design time or runtime) for a row item to display the caption.

The find panel searches for a row by its caption, tooltip, field name, and caption in the customization form. The SearchTags property allows you to provide custom tags by which the find panel can find this row.

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#

how-to-create-propertygridcontrol-rows-at-runtime-e2098/CS/AddRowsRuntime/Form1.cs#L27

EditorRow rowLastName = new EditorRow("LastName");
rowLastName.Properties.Caption = "Last name";
propertyGridControl1.Rows.Add(rowLastName);

how-to-use-the-vertical-grid-for-in-place-editing-and-in-view-mode-e2330/CS/WindowsApplication3/Custom Edit.cs#L117

row.Properties.UnboundType = DevExpress.Data.UnboundColumnType.String;
row.Properties.Caption = captions[i];
row.Height = RepositoryItemCustomEdit.RowHeight;

VB.NET

how-to-create-propertygridcontrol-rows-at-runtime-e2098/VB/AddRowsRuntime/Form1.vb#L29

Dim rowLastName As New EditorRow("LastName")
rowLastName.Properties.Caption = "Last name"
propertyGridControl1.Rows.Add(rowLastName)

how-to-use-the-vertical-grid-for-in-place-editing-and-in-view-mode-e2330/VB/WindowsApplication3/Custom Edit.vb#L120

row.Properties.UnboundType = DevExpress.Data.UnboundColumnType.String
row.Properties.Caption = captions(i)
row.Height = RepositoryItemCustomEdit.RowHeight