A newer version of this page is available. Switch to the current version.

OptionsColumnEditForm.Caption Property

Gets or sets the caption of the editor that represents the current grid column within an Edit Form.

Namespace: DevExpress.XtraGrid.Columns

Assembly: DevExpress.XtraGrid.v19.2.dll

Declaration

[DefaultValue("")]
[XtraSerializableProperty]
public virtual string Caption { get; set; }
<DefaultValue("")>
<XtraSerializableProperty>
Public Overridable Property Caption As String

Property Value

Type Default Description
String

String.Empty

The caption of the editor that represents the current grid column.

Property Paths

You can access this nested property as listed below:

Object Type Path to Caption
GridColumn
.OptionsEditForm.Caption
LayoutViewColumn
.OptionsEditForm.Caption
BandedGridColumn
.OptionsEditForm.Caption

Remarks

By default, an editor's caption matches the corresponding grid column's caption. You can override the editor's caption within an Edit Form using the Caption property. It is possible to assign a value to this property at design time or in code:

gridView1.Columns.ColumnByFieldName("Region").OptionsEditForm.Caption = "State:";

The following picture shows the result of assigning a custom caption to the editor that corresponds to the "Region" grid column:

OptionsColumnEditForm_CustomCaption

You can also specify the caption location via the OptionsColumnEditForm.CaptionLocation property.

See Also