[Expand]General Information
[Collapse]WinForms Controls
  Prerequisites
 [Expand]What's Installed
 [Expand]Build an Application
 [Expand]Controls and Libraries
 [Expand]Common Features
  Get More Help
 [Collapse]API Reference
  [Expand]DevExpress.DataAccess.UI
  [Expand]DevExpress.DataAccess.UI.Design
  [Expand]DevExpress.DataAccess.UI.EntityFramework
  [Expand]DevExpress.DataAccess.UI.Excel
  [Expand]DevExpress.DataAccess.UI.ObjectBinding
  [Expand]DevExpress.DataAccess.UI.Sql
  [Expand]DevExpress.DataAccess.UI.Wizard
  [Expand]DevExpress.DataAccess.UI.Wizard.Services
  [Expand]DevExpress.DataAccess.UI.Wizard.Views
  [Expand]DevExpress.DocumentView
  [Expand]DevExpress.DocumentView.Controls
  [Expand]DevExpress.LookAndFeel
  [Expand]DevExpress.LookAndFeel.Helpers
  [Expand]DevExpress.Skins
  [Expand]DevExpress.Snap
  [Expand]DevExpress.Snap.API.Native
  [Expand]DevExpress.Snap.Core
  [Expand]DevExpress.Snap.Core.API
  [Expand]DevExpress.Snap.Core.Fields
  [Expand]DevExpress.Snap.Core.Forms
  [Expand]DevExpress.Snap.Core.Options
  [Expand]DevExpress.Snap.Core.Services
  [Expand]DevExpress.Snap.Extensions
  [Expand]DevExpress.Snap.Extensions.Localization
  [Expand]DevExpress.Snap.Extensions.UI
  [Expand]DevExpress.Snap.Localization
  [Expand]DevExpress.Snap.Options
  [Expand]DevExpress.Snap.Services
  [Expand]DevExpress.Utils
  [Expand]DevExpress.Utils.Animation
  [Expand]DevExpress.Utils.Behaviors
  [Expand]DevExpress.Utils.Controls
  [Expand]DevExpress.Utils.DragDrop
  [Expand]DevExpress.Utils.Drawing
  [Expand]DevExpress.Utils.Filtering
  [Expand]DevExpress.Utils.Layout
  [Expand]DevExpress.Utils.Menu
  [Expand]DevExpress.Utils.MVVM
  [Expand]DevExpress.Utils.Taskbar
  [Expand]DevExpress.Utils.Taskbar.Core
  [Expand]DevExpress.Utils.UI.Localization
  [Expand]DevExpress.Utils.VisualEffects
  [Expand]DevExpress.Utils.Win
  [Expand]DevExpress.XtraBars
  [Expand]DevExpress.XtraBars.Alerter
  [Expand]DevExpress.XtraBars.Docking
  [Expand]DevExpress.XtraBars.Docking2010
  [Expand]DevExpress.XtraBars.Docking2010.Base
  [Expand]DevExpress.XtraBars.Docking2010.Customization
  [Expand]DevExpress.XtraBars.Docking2010.Views
  [Expand]DevExpress.XtraBars.Docking2010.Views.NativeMdi
  [Expand]DevExpress.XtraBars.Docking2010.Views.Tabbed
  [Expand]DevExpress.XtraBars.Docking2010.Views.Widget
  [Expand]DevExpress.XtraBars.Docking2010.Views.WindowsUI
  [Expand]DevExpress.XtraBars.FluentDesignSystem
  [Expand]DevExpress.XtraBars.Localization
  [Expand]DevExpress.XtraBars.Navigation
  [Expand]DevExpress.XtraBars.Ribbon
  [Expand]DevExpress.XtraBars.Ribbon.Gallery
  [Expand]DevExpress.XtraBars.Ribbon.ViewInfo
  [Expand]DevExpress.XtraBars.ToastNotifications
  [Expand]DevExpress.XtraBars.ToolbarForm
  [Expand]DevExpress.XtraBars.Utils
  [Expand]DevExpress.XtraBars.WinRTLiveTiles
  [Expand]DevExpress.XtraCharts
  [Expand]DevExpress.XtraCharts.Designer
  [Expand]DevExpress.XtraCharts.Wizard
  [Expand]DevExpress.XtraDataLayout
  [Expand]DevExpress.XtraDiagram
  [Expand]DevExpress.XtraDiagram.Docking
  [Expand]DevExpress.XtraDiagram.Options
  [Expand]DevExpress.XtraEditors
  [Expand]DevExpress.XtraEditors.ButtonPanel
  [Expand]DevExpress.XtraEditors.Calendar
  [Expand]DevExpress.XtraEditors.Camera
  [Expand]DevExpress.XtraEditors.Container
  [Expand]DevExpress.XtraEditors.Controls
  [Expand]DevExpress.XtraEditors.CustomEditor
  [Expand]DevExpress.XtraEditors.DXErrorProvider
  [Expand]DevExpress.XtraEditors.Filtering
  [Expand]DevExpress.XtraEditors.Mask
  [Expand]DevExpress.XtraEditors.Persistent
  [Expand]DevExpress.XtraEditors.Repository
  [Expand]DevExpress.XtraEditors.ViewInfo
  [Expand]DevExpress.XtraFilterEditor
  [Expand]DevExpress.XtraGauges.Presets.Styles
  [Expand]DevExpress.XtraGauges.Win
  [Expand]DevExpress.XtraGauges.Win.Base
  [Expand]DevExpress.XtraGauges.Win.Gauges.Circular
  [Expand]DevExpress.XtraGauges.Win.Gauges.Digital
  [Expand]DevExpress.XtraGauges.Win.Gauges.Linear
  [Expand]DevExpress.XtraGauges.Win.Gauges.State
  [Expand]DevExpress.XtraGrid
  [Expand]DevExpress.XtraGrid.Columns
  [Expand]DevExpress.XtraGrid.EditForm
  [Expand]DevExpress.XtraGrid.FilterEditor
  [Expand]DevExpress.XtraGrid.Localization
  [Expand]DevExpress.XtraGrid.Views.BandedGrid
  [Expand]DevExpress.XtraGrid.Views.BandedGrid.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Base
  [Expand]DevExpress.XtraGrid.Views.Base.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Card
  [Expand]DevExpress.XtraGrid.Views.Card.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Grid
  [Expand]DevExpress.XtraGrid.Views.Grid.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Layout
  [Expand]DevExpress.XtraGrid.Views.Layout.Events
  [Expand]DevExpress.XtraGrid.Views.Layout.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Printing
  [Expand]DevExpress.XtraGrid.Views.Tile
  [Expand]DevExpress.XtraGrid.Views.WinExplorer
  [Expand]DevExpress.XtraGrid.WinExplorer
  [Expand]DevExpress.XtraLayout
  [Expand]DevExpress.XtraLayout.Converter
  [Expand]DevExpress.XtraLayout.Customization
  [Expand]DevExpress.XtraLayout.HitInfo
  [Expand]DevExpress.XtraLayout.Localization
  [Expand]DevExpress.XtraLayout.Utils
  [Expand]DevExpress.XtraMap
  [Expand]DevExpress.XtraMap.Printing
  [Expand]DevExpress.XtraNavBar
  [Expand]DevExpress.XtraNavBar.ViewInfo
  [Expand]DevExpress.XtraPdfViewer
  [Expand]DevExpress.XtraPdfViewer.Commands
  [Expand]DevExpress.XtraPdfViewer.Localization
  [Expand]DevExpress.XtraPivotGrid
  [Expand]DevExpress.XtraPivotGrid.Data
  [Expand]DevExpress.XtraPrinting
  [Expand]DevExpress.XtraPrinting.Control
  [Expand]DevExpress.XtraPrinting.Preview
  [Expand]DevExpress.XtraPrintingLinks
  [Expand]DevExpress.XtraReports.UI
  [Expand]DevExpress.XtraRichEdit
  [Expand]DevExpress.XtraRichEdit.Commands
  [Expand]DevExpress.XtraRichEdit.Export
  [Expand]DevExpress.XtraRichEdit.Import
  [Expand]DevExpress.XtraRichEdit.Menu
  [Expand]DevExpress.XtraScheduler
  [Expand]DevExpress.XtraScheduler.Drawing
  [Expand]DevExpress.XtraScheduler.GoogleCalendar
  [Expand]DevExpress.XtraScheduler.Printing
  [Expand]DevExpress.XtraScheduler.Reporting
  [Expand]DevExpress.XtraScheduler.Reporting.UI
  [Expand]DevExpress.XtraScheduler.Services
  [Expand]DevExpress.XtraScheduler.Services.Implementation
  [Expand]DevExpress.XtraScheduler.UI
  [Expand]DevExpress.XtraSpellChecker
  [Expand]DevExpress.XtraSpellChecker.Localization
  [Expand]DevExpress.XtraSplashForm
  [Expand]DevExpress.XtraSplashScreen
  [Expand]DevExpress.XtraSpreadsheet
  [Expand]DevExpress.XtraSpreadsheet.Services
  [Expand]DevExpress.XtraTab
  [Expand]DevExpress.XtraTab.Buttons
  [Expand]DevExpress.XtraTab.ViewInfo
  [Expand]DevExpress.XtraTabbedMdi
  [Expand]DevExpress.XtraToolbox
  [Collapse]DevExpress.XtraTreeList
   [Expand]BeforeCollapseEventArgs Class
    BeforeCollapseEventHandler Delegate
   [Expand]BeforeDragNodeEventArgs Class
    BeforeDragNodeEventHandler Delegate
   [Expand]BeforeExpandEventArgs Class
    BeforeExpandEventHandler Delegate
   [Expand]BeforeFocusNodeEventArgs Class
    BeforeFocusNodeEventHandler Delegate
   [Expand]CalcNodeDragImageIndexEventArgs Class
    CalcNodeDragImageIndexEventHandler Delegate
   [Expand]CalcNodeHeightEventArgs Class
    CalcNodeHeightEventHandler Delegate
   [Expand]CellEventArgs Class
   [Expand]CellValueChangedEventArgs Class
    CellValueChangedEventHandler Delegate
   [Expand]ClipboardNodePastingEventArgs Class
   [Expand]ColumnChangedEventArgs Class
    ColumnChangedEventHandler Delegate
   [Expand]CompareNodeValuesEventArgs Class
    CompareNodeValuesEventHandler Delegate
   [Expand]CreateCustomNodeEventArgs Class
    CreateCustomNodeEventHandler Delegate
   [Expand]CustomDrawColumnHeaderEventArgs Class
    CustomDrawColumnHeaderEventHandler Delegate
   [Expand]CustomDrawEmptyAreaEventArgs Class
    CustomDrawEmptyAreaEventHandler Delegate
   [Expand]CustomDrawEventArgs Class
   [Expand]CustomDrawFooterCellEventArgs Class
    CustomDrawFooterCellEventHandler Delegate
   [Expand]CustomDrawFooterEventArgs Class
    CustomDrawFooterEventHandler Delegate
   [Expand]CustomDrawNodeButtonEventArgs Class
    CustomDrawNodeButtonEventHandler Delegate
   [Expand]CustomDrawNodeCellEventArgs Class
    CustomDrawNodeCellEventHandler Delegate
   [Expand]CustomDrawNodeImagesEventArgs Class
    CustomDrawNodeImagesEventHandler Delegate
   [Expand]CustomDrawNodeIndicatorEventArgs Class
    CustomDrawNodeIndicatorEventHandler Delegate
   [Expand]CustomDrawNodePreviewEventArgs Class
    CustomDrawNodePreviewEventHandler Delegate
   [Expand]CustomDrawRowFooterCellEventArgs Class
    CustomDrawRowFooterCellEventHandler Delegate
   [Expand]CustomDrawRowFooterEventArgs Class
    CustomDrawRowFooterEventHandler Delegate
   [Expand]CustomizeNewNodeFromOuterDataEventArgs Class
    CustomizeNewNodeFromOuterDataEventHandler Delegate
   [Expand]CustomRowFilterEventArgs Class
    FilterMode Enumeration
   [Expand]FilterNodeEventArgs Class
    FilterPopupMode Enumeration
    FindMode Enumeration
   [Expand]FocusedColumnChangedEventArgs Class
    FocusedColumnChangedEventHandler Delegate
   [Expand]FocusedNodeChangedEventArgs Class
    FocusedNodeChangedEventHandler Delegate
   [Expand]GetCustomNodeCellEditEventArgs Class
    GetCustomNodeCellEditEventHandler Delegate
   [Expand]GetCustomNodeCellStyleEventArgs Class
    GetCustomNodeCellStyleEventHandler Delegate
   [Expand]GetCustomSummaryValueEventArgs Class
    GetCustomSummaryValueEventHandler Delegate
   [Expand]GetNodeDisplayValueEventArgs Class
    GetNodeDisplayValueEventHandler Delegate
   [Expand]GetPreviewTextEventArgs Class
    GetPreviewTextEventHandler Delegate
   [Expand]GetSelectImageEventArgs Class
    GetSelectImageEventHandler Delegate
   [Expand]GetStateImageEventArgs Class
    GetStateImageEventHandler Delegate
    HitInfoType Enumeration
   [Expand]InvalidNodeExceptionEventArgs Class
    InvalidNodeExceptionEventHandler Delegate
    LineStyle Enumeration
   [Expand]NodeChangedEventArgs Class
    NodeChangedEventHandler Delegate
    NodeChangeTypeEnum Enumeration
   [Expand]NodeClickEventArgs Class
    NodeClickEventHandler Delegate
   [Expand]NodeEventArgs Class
    NodeEventHandler Delegate
   [Expand]OptionsLayoutTreeList Class
   [Expand]PopupMenuShowingEventArgs Class
    PopupMenuShowingEventHandler Delegate
    ScrollVisibility Enumeration
    ShowButtonModeEnum Enumeration
    ShowFilterPanelMode Enumeration
    SummaryItemType Enumeration
   [Collapse]TreeList Class
     TreeList Members
     TreeList Constructor
    [Expand]TreeList Properties
    [Expand]TreeList Events
    [Expand]TreeList Methods
    TreeListAnimationType Enumeration
   [Expand]TreeListAppearanceCollection Class
    TreeListBestFitMode Enumeration
   [Expand]TreeListHitInfo Class
   [Expand]TreeListMenuEventArgs Class
    TreeListMenuEventHandler Delegate
   [Expand]TreeListMenuItemClickEventArgs Class
    TreeListMenuItemClickEventHandler Delegate
   [Expand]TreeListMultiSelection Class
   [Expand]TreeListOptionsBehavior Class
   [Expand]TreeListOptionsClipboard Class
   [Expand]TreeListOptionsCustomization Class
   [Expand]TreeListOptionsDragAndDrop Class
   [Expand]TreeListOptionsFilter Class
   [Expand]TreeListOptionsMenu Class
   [Expand]TreeListOptionsNavigation Class
   [Expand]TreeListOptionsPrint Class
   [Expand]TreeListOptionsSelection Class
   [Expand]TreeListOptionsView Class
   [Expand]TreeListPrintAppearanceCollection Class
    TreeListState Enumeration
   [Expand]ValidateNodeEventArgs Class
    ValidateNodeEventHandler Delegate
    VirtualTreeGetCellValueEventHandler Delegate
   [Expand]VirtualTreeGetCellValueInfo Class
    VirtualTreeGetChildNodesEventHandler Delegate
   [Expand]VirtualTreeGetChildNodesInfo Class
    VirtualTreeSetCellValueEventHandler Delegate
   [Expand]VirtualTreeSetCellValueInfo Class
  [Expand]DevExpress.XtraTreeList.Columns
  [Expand]DevExpress.XtraTreeList.Data
  [Expand]DevExpress.XtraTreeList.Localization
  [Expand]DevExpress.XtraTreeList.Menu
  [Expand]DevExpress.XtraTreeList.Nodes
  [Expand]DevExpress.XtraTreeList.Nodes.Operations
  [Expand]DevExpress.XtraTreeList.StyleFormatConditions
  [Expand]DevExpress.XtraTreeMap
  [Expand]DevExpress.XtraTreeMap.Printing
  [Expand]DevExpress.XtraVerticalGrid
  [Expand]DevExpress.XtraVerticalGrid.Events
  [Expand]DevExpress.XtraVerticalGrid.Localization
  [Expand]DevExpress.XtraVerticalGrid.Rows
  [Expand]DevExpress.XtraWaitForm
  [Expand]DevExpress.XtraWizard
[Expand]ASP.NET Controls and MVC Extensions
[Expand]ASP.NET Bootstrap Controls
[Expand]ASP.NET Core Bootstrap Controls
[Expand]WPF Controls
[Expand]Xamarin Controls
[Expand]Windows 10 App Controls
[Expand]Office File API
[Expand]Reporting
[Expand]Report and Dashboard Server
[Expand]Dashboard
[Expand]eXpressApp Framework
[Expand]eXpress Persistent Objects
[Expand]CodeRush
[Expand]CodeRush Classic
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation
View this topic on docs.devexpress.com (Learn more)

TreeList Class

Displays data as a multi-column tree view. Can be used in either bound or unbound mode. See Tree List for more information.

Namespace:DevExpress.XtraTreeList
Assembly:DevExpress.XtraTreeList.v19.1.dll

Expanded Syntax

Expanded Remarks

The Tree List displays data with parent-child relations as nodes organized into a hierarchy.

The control supports bound and unbound modes. In bound mode, data is loaded from an external data source specified by the DataSource and DataMember properties. A data source must contain two fields that provide information on parent-child relationships between records: a unique record ID (key), and a parent record ID. These fields must be assigned to the KeyFieldName and ParentFieldName properties.

In unbound mode, you need to manually populate the TreeList with nodes manually. You can either create all nodes at once, or start with root nodes only to provide child nodes on demand. See Unbound Mode for more information.

Main TreeList features are:

The column collection can be accessed with the Columns property. At design time, you can create columns in the Tree List Designer. See Columns for more information.

The collection of root level nodes is stored in the Nodes property. Child nodes of each node are stored in the node's TreeListNode.Nodes collection. See Nodes for information on node objects, node structure and how to iterate through nodes.

Note

If the TreeList control is created at design time, changing the visual settings and size of the control and its elements (e.g., invoking the best fit functionality) is not in effect before the Tree List has completed its initialization. To customize these settings in the form's System.Windows.Forms.Form.Load event handler, call the ForceInitialize method prior to performing additional customization.

Expanded Example

The following example creates a TreeList (see TreeList) at runtime and shows how to perform basic customization tasks:

  • Bind the treelist to a data source
  • Specify the key fields that form a hierarchy
  • Access automatically created columns
  • Set a custom row height
  • Customize column captions (using HTML tags) and cell appearance settings
  • Create unbound columns and create Excel-style format conditions based on these column values
  • Assign an in-place editor (a spin editor) to columns
  • Sort data
  • Calculate total summaries
  • Filter nodes
  • Hide columns and calculate column "best" widths
  • Locate and expand nodes
  • Focus a specific cell
  • Specify DataAnnotation attributes at the data source level (the "p0" display format for the MarketShare field)

Expanded Inheritance Hierarchy

System.Object
    System.MarshalByRefObject
       System.ComponentModel.Component
          System.Windows.Forms.Control
             EditorContainer
                TreeList
                   DevExpress.XtraEditors.Base.Controls.FoldersViewer
                   ResourcesTree

Expanded See Also

Is this topic helpful?​​​​​​​