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

OptionsColumnEditForm.CaptionLocation Property

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

Namespace: DevExpress.XtraGrid.Columns

Assembly: DevExpress.XtraGrid.v19.1.dll

Declaration

[DefaultValue(EditFormColumnCaptionLocation.Default)]
[XtraSerializableProperty]
public virtual EditFormColumnCaptionLocation CaptionLocation { get; set; }

Property Value

Type Default Description
EditFormColumnCaptionLocation

Default

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

Available values:

Name Description
Default

Specifies the same location as the EditFormColumnCaptionLocation.Near value.

Near

A caption is located on the left side of an editor in a left-to-right layout. In a right-to-left layout, the near position is right.

Top

A caption is located above the editor.

None

A caption is not displayed.

Property Paths

You can access this nested property as listed below:

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

Remarks

You can set a value from the EditFormColumnCaptionLocation enumeration to the CaptionLocation property to specify the editor’s caption location. The EditFormColumnCaptionLocation enumeration provides you with the following values:

  • Default and Near — A caption is located on the left side of an editor in a left-to-right layout. In a right-to-left layout, the near position is right.
  • Top — A caption is located above the editor.
  • None — A caption is not displayed.

If you use the Top value, ensure that an editor spans a minimum of two layout rows within an Edit Form. To specify the number of layout rows an editor spans, use the OptionsColumnEditForm.RowSpan property.

See Also