TreeListColumn.Caption Property

Gets or sets the column caption displayed in the HeaderPanel of the XtraTreeList.

Namespace: DevExpress.XtraTreeList.Columns

Assembly: DevExpress.XtraTreeList.v19.1.dll

Declaration

C#

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

VB.NET

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

Property Value

Type	Default	Description
String	String.Empty	Column caption.

Remarks

Use this property to set a string which describes column data. If the column is visible, its caption is displayed in the HeaderPanel of the XtraTreeList.

By default, the Caption property is set to an empty string. In this instance, a friendly caption is generated for a column based on its TreeListColumn.FieldName property. Friendly captions are generated adding SPACE characters between parts of the field name starting with uppercase letters. For example, if the field name is “CustomerName”, the display caption will be “Customer Name”. To override the default display caption, assign it to the Caption property.

If the TreeListOptionsView.AllowHtmlDrawHeaders property is set to true, you can use HTML tags to format the Caption. For detailed information, see HTML Text Formatting.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Caption property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-allow-an-end-user-to-rename-treelistcolumn-at-runtime-e2713/CS/WindowsApplication3/TreeListColumnMenuExtender.cs#L39

void OnRenameEditorValidated(object sender, EventArgs e) {
    renameColumn.Caption = renameEditor.Text;
    renameEditor.Visible = false;

spreadsheet-document-api-apply-conditional-formatting-to-cell-range/CS/ConditionalFormatting_Example/BusinessObjects.cs#L58

SpreadsheetNode obj = info.Node as SpreadsheetNode;
switch (info.Column.Caption)
{

how-to-apply-conditional-formatting-to-a-range-of-cells-e4929/CS/SpreadsheetControl/BusinessObjects.cs#L54

SpreadsheetNode obj = info.Node as SpreadsheetNode;
switch (info.Column.Caption)
{

excel-export-api-examples-t253492/CS/XLExportExamples/BusinessObjects.cs#L48

SpreadsheetNode obj = info.Node as SpreadsheetNode;
switch (info.Column.Caption) {
    case "Name":

winforms-spreadsheetcontrol-api-e4655/CS/SpreadsheetControl/BusinessObjects.cs#L54

SpreadsheetNode obj = info.Node as SpreadsheetNode;
switch (info.Column.Caption)
{

VB.NET

how-to-allow-an-end-user-to-rename-treelistcolumn-at-runtime-e2713/VB/WindowsApplication3/TreeListColumnMenuExtender.vb#L39

Private Sub OnRenameEditorValidated(ByVal sender As Object, ByVal e As EventArgs)
    renameColumn.Caption = renameEditor.Text
    renameEditor.Visible = False

an-example-of-using-the-expression-editor-with-the-treelist-and-xpview-e1887/VB/E1887/Form1.vb#L58

End If
If String.IsNullOrEmpty(column.Caption) Then
    Return column.FieldName

spreadsheet-document-api-apply-conditional-formatting-to-cell-range/VB/ConditionalFormatting_Example/BusinessObjects.vb#L71

Dim obj As SpreadsheetNode = TryCast(info.Node, SpreadsheetNode)
Select Case info.Column.Caption
    Case "Name"

how-to-apply-conditional-formatting-to-a-range-of-cells-e4929/VB/SpreadsheetControl/BusinessObjects.vb#L79

Dim obj As SpreadsheetNode = TryCast(info.Node, SpreadsheetNode)
Select Case info.Column.Caption
    Case "Name"

excel-export-api-examples-t253492/VB/XLExportExamples/BusinessObjects.vb#L70

Dim obj As SpreadsheetNode = TryCast(info.Node, SpreadsheetNode)
Select Case info.Column.Caption
    Case "Name"