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

NuGet Package: DevExpress.Win.TreeList

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	A String value that specifies the Edit From’s caption.

Property Paths

You can access this nested property as listed below:

Library	Object Type	Path to FormCaptionFormat
WinForms Controls	GanttControl	.OptionsEditForm .FormCaptionFormat
	ResourcesTree	.OptionsEditForm .FormCaptionFormat
	TreeList	.OptionsEditForm .FormCaptionFormat
Reporting	XRDesignFieldList	.OptionsEditForm .FormCaptionFormat
	XRDesignReportExplorer	.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#

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

VB.NET

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