Back to Devexpress

TreeListColumn.Caption Property

windowsforms-devexpress-dot-xtratreelist-dot-columns-dot-treelistcolumn-c060856b.md

latest7.1 KB
Original Source

TreeListColumn.Caption Property

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

Namespace : DevExpress.XtraTreeList.Columns

Assembly : DevExpress.XtraTreeList.v25.2.dll

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

Declaration

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

Property Value

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

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.

winforms-treelist-create-file-manager-drag-drop-files-folders/CS/FileList/FileListHelper.cs#L46

csharp
this.treeListColumn1.Caption = "FullName";
this.treeListColumn1.FieldName = "FullName";

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

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

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

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

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

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

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

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

winforms-treelist-create-file-manager-drag-drop-files-folders/VB/FileList/FileListHelper.vb#L45

vb
treeListColumn5 = New Columns.TreeListColumn()
treeListColumn1.Caption = "FullName"
treeListColumn1.FieldName = "FullName"

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

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

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

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

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

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

winforms-spreadsheetcontrol-api-part1/VB/SpreadsheetControl/BusinessObjects.vb#L67

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

See Also

FieldName

CustomizationCaption

GetTextCaption()

TreeListColumn Class

TreeListColumn Members

DevExpress.XtraTreeList.Columns Namespace