TdxShellTreeView Class
A Shell Tree View control.
#Declaration
TdxShellTreeView = class(
TdxCustomShellTreeView
)
#Remarks
Shell Tree View is a Tree View control version designed to display Windows Shell content. The Shell Tree View control can synchronize with other DevExpress shell controls and allows you to build fully-functional shell dialogs in your applications.
#Main API Members
The list below outlines key members of the TdxShellTreeView
class. These members allow you to configure the Shell Tree View control.
#Appearance Settings
- OptionsView
- Provides access to general Tree View appearance settings.
#Behavior and User Interaction APIs
- AlphaSort
- Sorts shell items by their display names.
- CustomSort | OnCompare
- Allow you to implement a custom sort algorithm for shell items.
- ExpandTo | FullExpand | FullCollapse | MakeVisible
- Expand and collapse nodes.
- FocusedNode
- Specifies the focused node.
- OptionsBehavior
- Provides access to general Tree View behavior settings.
- OptionsSelection
- Provides access to selection-related settings.
- OnShellChange
Allows you to respond to external changes in Windows Shell.
Note
The On
Shell event occurs only if the ShellChange Options. property is set toTrack Shell Changes True
(default).- ScrollBy | TopItem
- Allow you to scroll Shell Tree View content.
- Select | Subselect | Deselect | ClearSelection
- Select and deselect shell items.
- Selected | Selections
- Provide access to selected shell items.
#Shell-Related API Members
- FolderCount
- Returns the number of displayed shell items accessible through the Folders property.
- Folders
- Provides indexed access to displayed shell items.
- GroupIndex
- Allows you to associate the Shell Tree View control with other shell controls.
- OnAddFolder
- Allows you to prevent certain shell items from appearing in the Shell Tree View control when it expands a node.
- Path
- Allows you to navigate to any accessible shell folder.
- ShellOptions
- Provides access to shell-related behavior settings.
- ShellRoot
- Allows you to configure shell root settings.
- UpdateContent
- Reloads displayed Windows Shell content.
#General-Purpose API Members
- Assign
- Copies settings between Shell Tree View controls.
- BeginUpdate | EndUpdate
- Allow you to avoid excessive redraw operations during batch state and setting changes and improve application performance.
- BeginSelect | EndSelect
- Allow you to avoid excessive redraw operations during batch node selection changes and improve application performance. These procedures complement BeginUpdate and EndUpdate.
- FullRefresh
- Redraws the Shell Tree View control.
#Shell Control Synchronization
You can associate the Shell Tree View control with the following shell controls to synchronize displayed content:
- TcxShellComboBox
- A Shell Combo Box editor.
- TdxShellBreadcrumbEdit
- A Shell Breadcrumb control.
- TdxShellListView
- A Shell List View control.