Back to Devexpress

TreeListOptionsEditForm.FormCaptionFormat Property

windowsforms-devexpress-dot-xtratreelist-dot-treelistoptionseditform-69b097d2.md

latest2.5 KB
Original Source

TreeListOptionsEditForm.FormCaptionFormat Property

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

Namespace : DevExpress.XtraTreeList

Assembly : DevExpress.XtraTreeList.v25.2.dll

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

Declaration

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

Property Value

TypeDefaultDescription
StringString.Empty

A String value that specifies the Edit From’s caption.

|

Property Paths

You can access this nested property as listed below:

Object TypePath to FormCaptionFormat
TreeList

.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
treeList1.OptionsEditForm.FormCaptionFormat = "{CompanyName} company is located at {Address}, {PostalCode} {City}, {Country}";
vb
treeList1.OptionsEditForm.FormCaptionFormat = "{CompanyName} company is located at {Address}, {PostalCode} {City}, {Country}"

See Also

TreeListOptionsEditForm Class

TreeListOptionsEditForm Members

DevExpress.XtraTreeList Namespace