Skip to main content

TdxCustomShellTreeView Class

The base class for the Shell Tree View control.

Declaration

TdxCustomShellTreeView = class(
    TdxCustomTreeView,
    IDropTarget,
    IcxShellDependedControls,
    IcxShellRoot
)

Remarks

Shell Tree View is a Tree View control version designed to display Windows Shell content. The TdxCustomShellTreeView class implements base Shell Tree View functionality.

VCL Editors Library: A Shell Tree View Example

Main API Members

The list below outlines key members of the TdxCustomShellTreeView 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 OnShellChange event occurs only if the ShellOptions.TrackShellChanges property is set to 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.
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.

Terminal TdxCustomShellTreeView Class Descendant

Do not use the TdxCustomShellTreeView class directly. Use the TdxShellTreeView control instead.

See Also