Back to Devexpress

GridOptionsEditForm.FormCaptionFormat Property

windowsforms-devexpress-dot-xtragrid-dot-views-dot-grid-dot-gridoptionseditform-06ab4877.md

latest2.6 KB
Original Source

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.v25.2.dll

NuGet Packages : DevExpress.Win.Grid, DevExpress.Win.Navigation

Declaration

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

Property Value

TypeDefaultDescription
StringString.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 TypePath to FormCaptionFormat
GridView

.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.

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

See Also

EditingMode

GridOptionsEditForm Class

GridOptionsEditForm Members

DevExpress.XtraGrid.Views.Grid Namespace