RowProperties.Caption Property

Gets or sets the row caption.

Namespace: DevExpress.XtraVerticalGrid.Rows

Assembly: DevExpress.XtraVerticalGrid.v24.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 that specifies the row caption.

Remarks

Use the Caption property to specify the row caption, which is displayed in the row header.

You can also use the Caption argument to set a custom caption in a CustomDrawRowHeaderCell event handler.

The CustomizationCaption property specifies the row caption when it is displayed in the customization form.

You can use the DisplayAttribute to specify a caption for a data field. See the following topic for more information: Data Annotation Attributes.

If neither of these means is used to specify the row caption, the control uses the FieldName property value. If the field name is in the pascal case, the control separates the words with spaces.

If the ShowCaption option is disabled, the caption is not displayed.

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 specify custom tags by which the find panel can locate this row.

Related GitHub Examples

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

winforms-property-grid-create-rows/CS/AddRowsRuntime/Form1.cs#L27

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

VB.NET

winforms-property-grid-create-rows/VB/AddRowsRuntime/Form1.vb#L27

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