TcxShellAddFolderEvent Type

The procedural type for shell item addition events.

Declaration

TcxShellAddFolderEvent = procedure(Sender: TObject; AFolder: TcxShellFolder; var ACanAdd: Boolean) of object;

Name	Type	Description
Sender	TObject	Provides access to the shell control that raised the shell item addition event. Cast the `Sender` property value to the corresponding shell control class to access its public members.
AFolder	TcxShellFolder	The shell item that is about to be added.
ACanAdd	Boolean	If `True`, the `Sender` shell control can add the `AFolder` shell item. If `False`, the shell item addition operation is forbidden.

The shell item addition event occurs every time a shell item is about to be added to a DevExpress shell control.

The following public API members reference the TcxShellChangeEvent procedural type:

TcxCustomShellListView.OnAddFolder: Allows you to prevent certain shell items from appearing in the Shell List View control.
TcxCustomShellTreeView.OnAddFolder: Allows you to prevent certain shell items from appearing in the Shell Tree View control.
TcxCustomShellBreadcrumbEdit.OnAddFolder: Enables you to prohibit adding a breadcrumb node associated with a specific shell item to the parent node‘s dropdown window.
TcxCustomShellComboBoxProperties.OnAddFolder: Allows you to prevent certain shell items from appearing in the Shell Combo Box editor.
TdxCustomShellListView.OnAddFolder: Allows you to prevent certain shell items from appearing in the Shell List View control.
TdxCustomShellTreeView.OnAddFolder: Allows you to prevent certain shell items from appearing in the Shell Tree View control.

Note

To improve shell navigation consistency, share the same OnAddFolder event handler between all associated DevExpress shell controls.