CustomDrawRowHeaderCellEventArgs.Caption Property

Gets or sets the text displayed within the painted row header cell.

Namespace: DevExpress.XtraVerticalGrid.Events

Assembly: DevExpress.XtraVerticalGrid.v18.2.dll

Declaration

C#

public string Caption { get; set; }

VB.NET

Public Property Caption As String

Property Value

Type	Description
String	A String value representing the painted row header cell’s text.

Remarks

Initially, the Caption property contains the row header cell’s default text specified by the RowProperties.Caption property. This property can be used in two ways:

• read the property value to paint the default text;
• change the Caption property value and leave the CustomDrawEventArgs.Handled property set to false. This forces the control to paint the row header cell using the default mechanism but with a modified caption.

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-highlight-a-row-in-the-verticalgrid-when-another-row-is-dragged-over-it-e780/CS/Form1.cs#L164

e.Appearance.FillRectangle(e.Cache, e.Bounds);
e.Appearance.DrawString(e.Cache, e.Caption, e.Bounds);
e.Graphics.FillRectangle(Brushes.Red, e.Bounds.Left, e.Bounds.Bottom - 2, e.Bounds.Width, 1);

how-to-show-mnemonics-in-the-verticalgrid-row-headers-e809/CS/Form1.cs#L127

frm.HotkeyPrefix = System.Drawing.Text.HotkeyPrefix.Show;
e.Appearance.DrawString(e.Cache, e.Caption, e.Bounds, frm);
e.Handled = true;

how-to-provide-in-place-editors-for-row-headers-in-a-vertical-grid-t244577/CS/S170863/RowInplaceEditorHelper.cs#L42

if(e.Row == _Row) {
    e.Caption = string.Empty;
    e.Handled = true;

how-to-provide-in-place-editors-for-row-headers-in-the-vertical-grid-t493645/CS/S170863/RowInplaceEditorHelper.cs#L40

if(e.Row == _Row) {
    e.Caption = string.Empty;
    e.Handled = true;

VB.NET

how-to-highlight-a-row-in-the-verticalgrid-when-another-row-is-dragged-over-it-e780/VB/Form1.vb#L155

e.Appearance.FillRectangle(e.Cache, e.Bounds)
e.Appearance.DrawString(e.Cache, e.Caption, e.Bounds)
e.Graphics.FillRectangle(Brushes.Red, e.Bounds.Left, e.Bounds.Bottom - 2, e.Bounds.Width, 1)

how-to-show-mnemonics-in-the-verticalgrid-row-headers-e809/VB/Form1.vb#L117

frm.HotkeyPrefix = System.Drawing.Text.HotkeyPrefix.Show
e.Appearance.DrawString(e.Cache, e.Caption, e.Bounds, frm)
e.Handled = True

how-to-provide-in-place-editors-for-row-headers-in-a-vertical-grid-t244577/VB/S170863/RowInplaceEditorHelper.vb#L50

If e.Row Is _Row Then
    e.Caption = String.Empty
    e.Handled = True

how-to-provide-in-place-editors-for-row-headers-in-the-vertical-grid-t493645/VB/S170863/RowInplaceEditorHelper.vb#L45

If e.Row Is _Row Then
    e.Caption = String.Empty
    e.Handled = True