GridOptionsEditForm.FormCaptionFormat Property

Gets or sets a custom caption for an Edit From displayed as a modal window. Use field names in braces {} to display field values in the caption.

Namespace: DevExpress.XtraGrid.Views.Grid

Assembly: DevExpress.XtraGrid.v20.2.dll

NuGet Package: DevExpress.Win.Grid

Declaration

C#

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

VB.NET

<DefaultValue("")>
<XtraSerializableProperty>
Public Overridable Property FormCaptionFormat As String

Property Value

Type	Default	Description
String	String.Empty	The custom caption of an Edit From displayed as a modal window.

Property Paths

You can access this nested property as listed below:

Object Type	Path to FormCaptionFormat
AdvBandedGridView	.OptionsEditForm .FormCaptionFormat
BandedGridView	.OptionsEditForm .FormCaptionFormat
GridView	.OptionsEditForm .FormCaptionFormat
TileView	.OptionsEditForm .FormCaptionFormat

Remarks

Use the FormCaptionFormat property to specify the Edit Form’s caption. To display a field value in the caption, enter the field name in braces.

C#

gridView1.OptionsEditForm.FormCaptionFormat = "{CompanyName} company is located at {Address}, {PostalCode} {City}, {Country}";

VB.NET

gridView1.OptionsEditForm.FormCaptionFormat = "{CompanyName} company is located at {Address}, {PostalCode} {City}, {Country}"