TreeListColumn.VisibleIndex Property

Gets or sets the position in the Tree List where the current column is displayed.

Namespace: DevExpress.XtraTreeList.Columns

Assembly: DevExpress.XtraTreeList.v19.1.dll

Declaration

C#

[DefaultValue(-1)]
[XtraSerializableProperty]
public int VisibleIndex { get; set; }

VB.NET

<DefaultValue(-1)>
<XtraSerializableProperty>
Public Property VisibleIndex As Integer

Property Value

Type	Default	Description
Int32	-1	An Integer value that specifies the position of the current column in the Tree List.

Remarks

Use this property to set the position of columns created manually or move the existing column to a new position. Unlike the TreeListColumn.AbsoluteIndex property, this property defines the column position among visible columns (TreeList.VisibleColumns). If the VisibleIndex property is set to -1, the current column is not displayed.

The VisibleIndex property cannot be set to a value less than -1, or greater than the number of currently visible columns. When assigning a value outside of these bounds, the value is automatically set to either -1 or the last available index.

When you use the VisibleIndex property to move a column forward (i.e., assign a new visible index that is higher than the current visible index), the current column is actually moved to the position before the column, whose VisibleIndex equals to the assigned value. So, the actual visible index will be the assigned value minus one. When you move a column backward using the VisibleIndex property (i.e. assign a new visible index that is lower than the current visible index), the current column is moved to the position specified by the assigned value. The actual visible index will match the assigned value.

Note

The VisibleIndex property cannot be used to change the positions of columns in banded mode. Instead of this property, use the TreeList.SetColumnPosition and TreeListBand.Columns.SetColumnIndex methods.

Example

The following example adds a column bound to the “Phone” field and displays it at the end of all visible columns.

C#

treeList1.Columns.Add("Phone");
treeList1.Columns["Phone"].VisibleIndex = treeList1.Columns.Count - 1;

VB.NET

TreeList1.Columns.Add("Phone")
TreeList1.Columns("Phone").VisibleIndex = TreeList1.Columns.Count - 1

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the VisibleIndex 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-add-a-horizontal-cells-merge-capability-to-an-xtratreelist-control-e2501/CS/TreeListCellMerging/MyTreeList.cs#L29

{
    TreeListColumn nextColumn = GetColumnByVisibleIndex(e.Column.VisibleIndex - 1);
    if(Equals(this.FocusedNode.GetValue(e.Column), this.FocusedNode.GetValue(nextColumn)))

how-to-print-a-treelist-that-supports-the-horizontal-cell-merging-capability-e4344/CS/TreeListCellMerging/MyTreeList.cs#L30

{
    TreeListColumn nextColumn = GetColumnByVisibleIndex(e.Column.VisibleIndex - 1);
    if(Equals(this.FocusedNode.GetValue(e.Column), this.FocusedNode.GetValue(nextColumn)))

how-to-implement-block-selection-for-treelist-cells-e2176/CS/BlockSelection/BlockSelector.cs#L40

{
    if (fBlock.Contains(e.Column.VisibleIndex, e.Node.Id))
        e.Appearance.BackColor = SystemColors.Highlight;

how-to-delete-selected-nodes-within-the-treelist-control-e799/CS/E799_Sample/Form1.cs#L27

private void InitColumnsVisibleOrder() {
    treeList1.Columns["Name"].VisibleIndex = 0;
    treeList1.Columns["Status"].VisibleIndex = 1;

how-to-create-an-analog-of-gridlookupedit-with-treelist-in-a-popup-window-e4319/CS/Form1.cs#L242

TreeList.Columns[0].FieldName = "Name";
TreeList.Columns[0].VisibleIndex = 0;
TreeList.Columns.Add();

VB.NET

how-to-add-a-horizontal-cells-merge-capability-to-an-xtratreelist-control-e2501/VB/TreeListCellMerging/MyTreeList.vb#L27

Private Sub JumpIfInMergedCell(ByVal e As FocusedColumnChangedEventArgs, ByVal [step] As Integer)
    Dim nextColumn As TreeListColumn = GetColumnByVisibleIndex(e.Column.VisibleIndex - 1)
    If Equals(Me.FocusedNode.GetValue(e.Column), Me.FocusedNode.GetValue(nextColumn)) Then

how-to-print-a-treelist-that-supports-the-horizontal-cell-merging-capability-e4344/VB/TreeListCellMerging/MyTreeList.vb#L28

Private Sub JumpIfInMergedCell(ByVal e As FocusedColumnChangedEventArgs, ByVal [step] As Integer)
    Dim nextColumn As TreeListColumn = GetColumnByVisibleIndex(e.Column.VisibleIndex - 1)
    If Equals(Me.FocusedNode.GetValue(e.Column), Me.FocusedNode.GetValue(nextColumn)) Then

how-to-implement-block-selection-for-treelist-cells-e2176/VB/BlockSelection/BlockSelector.vb#L45

Private Sub fList_NodeCellStyle(ByVal sender As Object, ByVal e As GetCustomNodeCellStyleEventArgs)
    If fBlock.Contains(e.Column.VisibleIndex, e.Node.Id) Then
        e.Appearance.BackColor = SystemColors.Highlight

how-to-implement-the-cells-multi-selection-feature-in-treelist-e2795/VB/WindowsApplication1/Helper/SelectionOperation.vb#L40

For Each column As TreeListColumn In node.TreeList.Columns
    If block.Contains(column.VisibleIndex, node.TreeList.GetVisibleIndexByNode(node)) Then
        result_Renamed &= node.GetDisplayText(column)

how-to-delete-selected-nodes-within-the-treelist-control-e799/VB/E799_Sample/Form1.vb#L29

Private Sub InitColumnsVisibleOrder()
    treeList1.Columns("Name").VisibleIndex = 0
    treeList1.Columns("Status").VisibleIndex = 1