ShellBrowser Delphi Components Documentation
ContentsIndexHome
PreviousUpNext
Jam.Shell.Controls.ExplorerBrowser.TJamExplorerBrowser

A TJamExplorerBrowser embeds the native Windows ExplorerBrowser control into a VCL component on Windows Vista and later.

Jam_Shell_Controls_ExplorerBrowser_TJamExplorerBrowserJam_Shell_Controls_ExplorerBrowser_TJamExplorerBrowserJam_Shell_Controls_ExplorerBrowser_TJamExplorerBrowserJam_Shell_Controls_ExplorerBrowser_TJamExplorerBrowserJam_Shell_Controls_ExplorerBrowser_TJamExplorerBrowser
Syntax
Pascal
TJamExplorerBrowser = class(TJamShellControl, IServiceProvider, IExplorerBrowserEvents, IExplorerPaneVisibility);

This control displays the contents of a folder in a ListView like control. It is a true instance of the ExplorerBrowser (on Windows Vista and later) that is used by the Windows Explorer and therefore looks and behaves exactly like the Windows Explorer on the system it is running on. In contrast to that, the TJamSystemShellView which is only the right pane of the Windows Explorer.  

There are some panes that can be shown or hidden by using the VisiblePanes property. The used view style can be changed using the ViewStyle property. Per default the native shell context menu is used when a user performs a right click on files or folders. With the PopupMenu and BackgroundPopupMenu properties it is possible to replace the shell context menu with a custom one.  

This control does not support Delphi VCL styles shipped with Rad Studio because it instantiates a Windows Explorer through ActiveX. Nevertheless the usage of the project VCL Styles Utils unlocks this limitation and makes it possible to use this component with VCL styles.  

 

JamSystemShellView.TJamShellControl
 
Name 
Description 
 
Creates an instance of a TJamShellControl base component class.  
 
Destructor of a TJamShellControl component.  
Jam.Shell.Controls.ExplorerBrowser.TJamExplorerBrowser
 
Name 
Description 
 
Creates an instance of a TJamExplorerBrowser component.  
 
Destructor of a TJamExplorerBrowser component.  
JamSystemShellView.TJamShellControl
 
Name 
Description 
 
Occurs, whenever a new item is added to a JamSystemShellView
 
Occurs when the user drags a file on the control.  
 
Occurs when the user drags a file over the control.  
 
Occurs when the user drops a file on the control.  
Jam.Shell.Controls.ExplorerBrowser.TJamExplorerBrowser
 
Name 
Description 
 
Occurs, whenever a new item is added to a JamSystemShellView
 
Occurs when the user drags a file on the control.  
 
Occurs when the user drags a file over the control.  
 
Occurs when the user drops a file on the control.  
 
Occurs when navigating to a folder.  
 
Name 
Description 
 
This method is called by the ShellLink instance if the currently selected item has changed. 
 
Getter method for the ShellLink property. 
 
GoUp 
This method indicates that the callee should go up one level and display the contents of the current folder's parent folder. 
 
This method is called by the ShellLink instance if the currently displayed folder has changed. 
 
This method indicates that the control should perform a refresh of its contents. 
 
This method indicates that the callee should select all item it currently displays. 
 
Setter method for the ShellLink property. 
ShellLink.IJamMultiSelectShellControl
 
Name 
Description 
 
Returns an IItemIdListCollection containing the selected ItemIdLists or an empty list if nothing is selected. 
ShellLink.IJamSupportsFilter
 
Name 
Description 
 
Called by the ShellLink instance when the Filter is changed.  
JamSystemShellView.TJamShellControl
 
Name 
Description 
 
Creates a new directory in the current folder.  
 
Issues that all items in the current view has to be deselected.  
 
Deselects the item at the position passed by IItemIdList.  
 
Puts the first selected item into the edit/rename mode.  
 
Scrolls to the item with the specified IItemIdList.  
 
Refreshes the contents of the TJamShellControl base class.  
 
Returns the full path of a given index of an item.  
 
GoUp 
Goes up one level in the file system structure.  
 
Returns the position of a path in the list.  
 
Executes a context menu command for the listed folder.  
 
Executes a context menu command for all selected items.  
 
Use this method to check if the item at the passed index is a folder.  
 
Checks if the item with the given IItemIdList is selected.  
 
Returns if the given item is a special folder.  
 
Moves one step back in history of visited folders.  
 
Moves one step forward in history of visited folders.  
 
Issues that all items in the current view has to be selected.  
 
Returns the summarized size of all selected files in Bytes.  
 
Selects the item at the position passed by IItemIdList.  
 
Triggers a smart refresh for all connected controls.  
 
Ungroups the items inside the current view.  
Jam.Shell.Controls.ExplorerBrowser.TJamExplorerBrowser
 
Name 
Description 
 
Deselects the item at the position passed by IItemIdList.  
 
Puts the first selected item into the edit/rename mode.  
 
Scrolls to the item with the specified IItemIdList.  
 
Invalidates the control.  
 
Executes a context menu command for listed folder or selected items depending on focus.  
 
Checks if the item with the given IItemIdList is selected.  
 
Moves one step back in history of visited folders.  
 
Moves one step forward in history of visited folders.  
 
Passes messages to the native ExplorerBrowser and/or raises matching events.  
 
Selects the item at the position passed by IItemIdList.  
 
Sets the keyboard focus to the current window.  
 
Sets the keyboard focus on the shell view located on the right side.  
 
Sets the keyboard focus on the tree view (navigation pane) located on the left side.  
 
Name 
Description 
 
The TJamShellLink instance to which the current control connected. 
JamSystemShellView.TJamShellControl
 
Name 
Description 
 
Popup menu for a right click on the background of the view.  
 
Determines whether the list view displays a single line border.  
 
Gets or sets a value indicating whether the control displays checkboxes that can be used to set the selection. After that the "Select" methods like SelectItem or DeselectItem can be used to check or uncheck items in the view.  
 
Gets or sets a value indicating if column headers should be shown. Per default column headers are only visible if ViewStyle is vsDetails.  
 
Gets or sets TJamShellViewColumns.  
 
Sets the new default text to be displayed when the ExplorerBrowser view is empty.  
 
Use FileSystemOnly to determine if only file system objects should be displayed.  
 
Allows you to filter objects by filename patterns.  
 
Gets or sets the current folder.  
 
Sets up some TJamShellFolderFlags for the view.  
 
Gets or sets the view grouping.  
 
Gets or sets the group direction.  
 
Gets or sets the number of visible rows of items in each group.  
 
The height and width of icons in pixels. Only reasonibly applies in ViewStyle vmIcon  
 
Item 
Use Item to directly access an item in the list.  
 
Read ItemCount to determine the number of items that are in the folder.  
 
Set this property to True to allow Ole Drag-and-Drop operations with the Windows Explorer and other shell controls.  
 
Occurs before the full refresh is executed.  
 
Occurs if the underlying view has changed.  
 
Occurs after user performs a double click or hits the enter key.  
 
Occurs when the user drags a file out of the selected control.  
 
Occurs when navigating to a folder has been completed successfully.  
 
Occurs when navigating to a folder has failed.  
 
The OnPathChanged event occurs, when the users changes the path.  
 
The OnPopulated event occurs, after the control was filled completely.  
 
Occurs when selection has changed.  
 
Path 
The file system path of the current folder.  
 
Returns the selected Item or nil if nothing is selected.  
 
Gets the number of currently selected items in the view.  
 
Provides access to the names of the selected files.  
 
Indicates the position of the list item in the list items collection.  
 
Contains the selected item collection in the current view. The collection is gathered upon first retrieval. It is updated internally when the items change, i.e. by moving to another folder. The items returned may be sorted differently than the view.  
 
Connects this component to a TJamShellLink in order to synchronize several shell controls.  
 
Gets the IShellView of the current folder view.  
 
Allow Windows error messages.  
 
This property allows to include files in the view.  
 
This property allows to display folders or not.  
 
This property allows to hide files or folders.  
 
This property allows to change the look and the objects displayed.  
 
Allows you to deal with non file system folders.  
 
The current version of the ShellBrowser components.  
 
Determines how the list items are displayed.  
Jam.Shell.Controls.ExplorerBrowser.TJamExplorerBrowser
 
Name 
Description 
 
The TJamShellBreadCrumbBar on top.  
 
Determines how the control aligns within its container (parent control).  
 
Specifies how the control is anchored to its parent.  
 
Popup menu for a right click on the background of the view.  
 
 
Determines whether the list view displays a single line border.  
 
Gets or sets a value indicating whether the control displays checkboxes that can be used to set the selection. After that the "Select" methods like SelectItem or DeselectItem can be used to check or uncheck items in the view.  
 
Use Constraints to specify the minimum and maximum width and height of the control.  
 
Sets the new default text to be displayed when the ExplorerBrowser view is empty.  
 
Controls whether the control responds to mouse, keyboard, and timer events.  
 
Gets the handle to the ExplorerBrowser window.  
 
Use FileSystemOnly to determine if only file system objects should be displayed.  
 
Allows you to filter objects by filename patterns.  
 
Gets or sets the number of visible rows of items in each group.  
 
The height and width of icons in pixels. Only reasonibly applies in ViewStyle vmIcon  
 
Set this property to True to allow Ole Drag-and-Drop operations with the Windows Explorer and other shell controls.  
 
Occurs before the full refresh is executed.  
 
Occurs if the underlying view has changed.  
 
Occurs when the user clicks the control.  
 
Occurs when the user right-clicks the control or otherwise invokes the pop-up menu (such as using the keyboard).  
 
Occurs after user performs a double click or hits the enter key.  
 
Occurs when the user drags a file out of the selected control.  
 
Occurs when a control receives the input focus.  
 
Occurs when the input focus shifts away from one control to another.  
 
Occurs when a user presses any key while the control has focus.  
 
Occurs when a key is pressed.  
 
Occurs when the user releases a key that was pressed.  
 
Occurs when the user presses a mouse button with the mouse pointer over a control.  
 
Occurs when the user moves the mouse pointer while the mouse pointer is over a control.  
 
Occurs when the user releases a mouse button that was pressed with the mouse pointer over a component.  
 
Occurs when navigating to a folder has been completed successfully.  
 
Occurs when navigating to a folder has failed.  
 
The OnPathChanged event occurs, when the users changes the path.  
 
The OnPopulated event occurs, after the control was filled completely.  
 
Occurs when the control is resized.  
 
Occurs when selection has changed.  
 
Influences the handling of entered file paths in the addressbar.  
 
Specifies whether the control uses its parent's BiDiMode.  
 
Path 
The file system path of the current folder.  
 
Specifies the pop-up menu associated with the control.  
 
Connects this component to a ShellLink.TJamShellLink in order to synchronize several shell controls.  
 
Allow Windows error messages.  
 
This property allows to include files in the view.  
 
This property allows to display folders or not.  
 
This property allows to hide files or folders.  
 
Show Network neighbourhood.  
 
Show the Recycle Bin.  
 
Allows you to deal with non file system folders.  
 
Specifies the style name for this control. 
 
Indicates the position of the control in its parent's tab order. 
 
Determines whether the user can tab to a control. 
 
Determines how the list items are displayed.  
 
Determines whether the component appears on screen.  
 
Gets or sets the visible panes.