Jam.Shell.Controls.ExplorerBrowser.TJamExplorerBrowser

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

Class Hierarchy

Syntax

Pascal

TJamExplorerBrowser = class(TJamShellControl, IServiceProvider, IExplorerBrowserEvents, IExplorerPaneVisibility);

Remarks

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.

Namespace

Jam.Shell.Controls.ExplorerBrowser

Public Methods

JamSystemShellView.TJamShellControl

	Name	Description
	constructor Create(pOwner: TComponent); override;	Creates an instance of a TJamShellControl base component class.
	destructor Destroy; override;	Destructor of a TJamShellControl component.

Jam.Shell.Controls.ExplorerBrowser.TJamExplorerBrowser

	Name	Description
	constructor Create(pOwner: TComponent); override;	Creates an instance of a TJamExplorerBrowser component.
	destructor Destroy; override;	Destructor of a TJamExplorerBrowser component.

TJamShellControl Events

JamSystemShellView.TJamShellControl

	Name	Description
	property OnAddItem: TSystemShellViewAddItem read GetOnAddItem write SetOnAddItem;	Occurs, whenever a new item is added to a JamSystemShellView.
	property OnDragEnter: TJamDragDropEvent read fOnDragEnter write fOnDragEnter;	Occurs when the user drags a file on the control.
	property OnDragOver: TJamDragDropEvent read fOnDragOver write fOnDragOver;	Occurs when the user drags a file over the control.
	property OnDrop: TJamDragDropEvent read fOnDrop write fOnDrop;	Occurs when the user drops a file on the control.

Jam.Shell.Controls.ExplorerBrowser.TJamExplorerBrowser

	Name	Description
	property OnAddItem;	Occurs, whenever a new item is added to a JamSystemShellView.
	property OnBeforeDefaultAction: TCancelEvent read fOnBeforeDefaultAction write fOnBeforeDefaultAction;	Like OnDefaultAction, this event is called before the user double-clicks, presses Enter or selects the default context menu command for an element in the ShellView. Using the "Cancel" parameter you the action can be intercepted and stopped.
	property OnDragEnter;	Occurs when the user drags a file on the control.
	property OnDragOver;	Occurs when the user drags a file over the control.
	property OnDrop;	Occurs when the user drops a file on the control.
	property OnNavigating: TNavigationPendingEvent read fOnNavigating write fOnNavigating;	Occurs when navigating to a folder.

IJamShellControl Methods

	Name	Description
	procedure FileChanged(FolderPIDL: IItemIdList; FilePIDL: IItemIdList);	This method is called by the ShellLink instance if the currently selected item has changed.
	function getShellLink: TJamShellLink;	Getter method for the ShellLink property.
	function GoUp: Boolean;	This method indicates that the callee should go up one level and display the contents of the current folder's parent folder.
	procedure PathChanged(FolderPIDL: IItemIdList);	This method is called by the ShellLink instance if the currently displayed folder has changed.
	procedure Refresh(pRefreshLevel: TRefreshLevel; pItemIdList: IItemIdList = nil);	This method indicates that the control should perform a refresh of its contents.
	procedure SelectAll;	This method indicates that the callee should select all item it currently displays.
	procedure setShellLink(aValue: TJamShellLink);	Setter method for the ShellLink property.

ShellLink.IJamMultiSelectShellControl

	Name	Description
	function GetSelectedElements: IItemIdListCollection;	Returns an IItemIdListCollection containing the selected ItemIdLists or an empty list if nothing is selected.

ShellLink.IJamSupportsFilter

	Name	Description
	procedure FilterChanged(const Filter: string);	Called by the ShellLink instance when the Filter is changed.

JamSystemShellView.TJamShellControl

	Name	Description
	function CreateDir(pName: string; pEditMode: Boolean): Boolean;	Creates a new directory in the current folder.
	procedure DeselectAll;	Issues that all items in the current view has to be deselected.
	function DeselectItem(const pRelativeItemIdList: IItemIdList): Boolean; virtual; abstract; overload;	Deselects the item at the position passed by IItemIdList.
	function DeselectItem(pIndex: Integer): Boolean; virtual; abstract; overload;	Deselects an item in the current view by its index.
	procedure EditSelected; virtual; abstract;	Puts the first selected item into the edit/rename mode.
	function EnsureVisible(const pRelativeItemIdList: IItemIdList): Boolean; virtual; abstract; overload;	Scrolls to the item with the specified IItemIdList.
	function EnsureVisible(pIndex: Integer): Boolean; virtual; abstract; overload;	Scrolls to the item at the specified index.
	procedure FullRefresh;	Refreshes the contents of the TJamShellControl base class.
	function GetFullPath(pIndex: Integer): string;	Returns the full path of a given index of an item.
	function GoUp: Boolean; virtual;	Goes up one level in the file system structure.
	function IndexOf(const pPath: string): Integer; overload;	Returns the position of a path in the list.
	function InvokeCommandOnFolder(const pCommand: TShellCommand): Boolean; virtual;	Executes a context menu command for the listed folder.
	function InvokeCommandOnSelected(const pCommand: TShellCommand): Boolean; virtual;	Executes a context menu command for all selected items.
	function IsFolder(pIndex: Integer): Boolean;	Use this method to check if the item at the passed index is a folder.
	function IsSelected(const pRelativeItemIdList: IItemIdList): Boolean; virtual; abstract; overload;	Checks if the item with the given IItemIdList is selected.
	function IsSelected(pIndex: Integer): Boolean; virtual; abstract; overload;	Checks if the item with the given index is selected.
	function IsSpecialObject(pIndex: Integer): TJamShellFolder;	Returns if the given item is a special folder.
	procedure MoveBack; virtual; abstract;	Moves one step back in history of visited folders.
	procedure MoveForward; virtual; abstract;	Moves one step forward in history of visited folders.
	procedure SelectAll;	Issues that all items in the current view has to be selected.
	function SelectedFilesSize: Int64;	Returns the summarized size of all selected files in Bytes.
	function SelectItem(const pRelativeItemIdList: IItemIdList; pAdd: Boolean = True): Boolean; virtual; abstract; overload;	Selects the item at the position passed by IItemIdList.
	function SelectItem(pIndex: Integer; pAdd: Boolean = True): Boolean; virtual; abstract; overload;	Selects the item at the position passed by index.
	procedure SmartRefresh;	Triggers a smart refresh for all connected controls.
	procedure Ungroup;	Ungroups the items inside the current view.

Jam.Shell.Controls.ExplorerBrowser.TJamExplorerBrowser

	Name	Description
	function DeselectItem(const pRelativeItemIdList: IItemIdList): Boolean; override;	Deselects the item at the position passed by IItemIdList.
	function DeselectItem(pIndex: Integer): Boolean; override;	Deselects an item in the current view by its index.
	procedure EditSelected; override;	Puts the first selected item into the edit/rename mode.
	function EnsureVisible(const pRelativeItemIdList: IItemIdList): Boolean; override;	Scrolls to the item with the specified IItemIdList.
	function EnsureVisible(pIndex: Integer): Boolean; override;	Scrolls to the item at the specified index.
	procedure Invalidate; override;	Invalidates the control.
	function InvokeCommand(const pCommand: TShellCommand): Boolean;	Executes a context menu command for listed folder or selected items depending on focus.
	function IsSelected(const pRelativeItemIdList: IItemIdList): Boolean; override;	Checks if the item with the given IItemIdList is selected.
	function IsSelected(pIndex: Integer): Boolean; override;	Checks if the item with the given index is selected.
	procedure MoveBack; override;	Moves one step back in history of visited folders.
	procedure MoveForward; override;	Moves one step forward in history of visited folders.
	function PreProcessMessage(var pMsg: TMsg): Boolean; override;	Passes messages to the native ExplorerBrowser and/or raises matching events.
	function SelectItem(const pRelativeItemIdList: IItemIdList; pAdd: Boolean = True): Boolean; override;	Selects the item at the position passed by IItemIdList.
	function SelectItem(pIndex: Integer; pAdd: Boolean = True): Boolean; override; overload;	Selects the item at the position passed by index.
	procedure SetFocus; override;	Sets the keyboard focus to the current window.
	procedure SetFocusOnShellView;	Sets the keyboard focus on the shell view located on the right side.
	procedure SetFocusOnTreeView;	Sets the keyboard focus on the tree view (navigation pane) located on the left side.

IJamShellControl Properties

	Name	Description
	property ShellLink: TJamShellLink read getShellLink write setShellLink;	The TJamShellLink instance to which the current control connected.

JamSystemShellView.TJamShellControl

	Name	Description
	property BackgroundPopupMenu: TPopupMenu read fBackgroundPopupMenu write SetBackgroundContextMenu;	Popup menu for a right click on the background of the view.
	property BorderStyle: TBorderStyle read fBorderStyle write SetBorderStyle default bsNone;	Determines whether the list view displays a single line border.
	property CheckMode: TJamShellCheckMode read GetCheckMode write SetCheckMode default cmSelect;	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.
	property ColumnHeader: TJamShellColumnHeader read GetColumnHeader write SetColumnHeader default chAuto;	Gets or sets a value indicating if column headers should be shown. Per default column headers are only visible if ViewStyle is vsDetails.
	property Columns: TJamShellViewColumns read GetColumns write SetColumns;	Gets or sets TJamShellViewColumns.
	property EmptyText: string read GetEmptyText write SetEmptyText;	Sets the new default text to be displayed when the ExplorerBrowser view is empty.
	property FileSystemOnly: Boolean read GetFileSystemOnly write SetFileSystemOnly default False;	Use FileSystemOnly to determine if only file system objects should be displayed.
	property Filter: string read GetFilter write SetFilter;	Allows you to filter objects by filename patterns.
	property FolderIdList: IItemIdList read GetFolderIdList write SetFolderIdList;	Gets or sets the current folder.
	property FolderOptions: TJamShellFolderFlags read GetFolderFlags write SetFolderFlags default [ffNoHeaderInAllViews, ffAutoArrange, ffFullRowSelect];	Sets up some TJamShellFolderFlags for the view.
	property GroupBy: TShellColumnId read GetGroupedBy write SetGroupedBy;	Gets or sets the view grouping.
	property GroupDirection: TJamSortDirection read GetGroupDirection write SetGroupDirection default sdAscending;	Gets or sets the group direction.
	property GroupSubsetCount: UINT read GetGroupSubsetCount write SetGroupSubsetCount;	Gets or sets the number of visible rows of items in each group.
	property IconDimensions: Integer read GetIconDimensions write SetIconDimensions default 48;	The height and width of icons in pixels. Only reasonibly applies in ViewStyle vmIcon
	property Item [Index: Integer]: IJamSystemShellItem read GetItem;	Use Item to directly access an item in the list.
	property ItemCount: Integer read GetItemCount;	Read ItemCount to determine the number of items that are in the folder.
	property OleDragDrop: Boolean read fOleDragDrop write SetOleDragDrop default True;	Set this property to True to allow Ole Drag-and-Drop operations with the Windows Explorer and other shell controls.
	property OnBeforeFullRefresh: TNotifyEvent read GetOnBeforeFullRefresh write SetOnBeforeFullRefresh;	Occurs before the full refresh is executed.
	property OnChanged: TNotifyEvent read GetOnChanged write SetOnChanged;	Occurs if the underlying view has changed.
	property OnDefaultAction: TNotifyEvent read GetOnDefaultAction write SetOnDefaultAction;	Occurs after user performs a double click or hits the enter key.
	property OnDragLeave: TNotifyEvent read fOnDragLeave write fOnDragLeave;	Occurs when the user drags a file out of the selected control.
	property OnNavigationCompleted: TNotifyEvent read GetOnNavigationCompleted write SetOnNavigationCompleted;	Occurs when navigating to a folder has been completed successfully.
	property OnNavigationImpossible: TNotifyEvent read GetOnNavigationFailed write SetOnNavigationFailed;	Occurs when navigating to a folder has failed.
	property OnPathChanged: TNotifyEvent read GetOnPathChanged write SetOnPathChanged;	The OnPathChanged event occurs, when the users changes the path.
	property OnPopulated: TNotifyEvent read GetOnPopulated write SetOnPopulated;	The OnPopulated event occurs, after the control was filled completely.
	property OnSelectionChanged: TNotifyEvent read GetOnSelectionChanged write SetOnSelectionChanged;	Occurs when selection has changed.
	property Path: TFileName read GetPath write SetPath stored NotIsSpecialFolder;	The file system path of the current folder.
	property Selected: IJamSystemShellItem read GetSelected;	Returns the selected Item or nil if nothing is selected.
	property SelectedCount: Integer read GetSelectedCount;	Gets the number of currently selected items in the view.
	property SelectedFiles: TFilenames read GetSelectedFiles;	Provides access to the names of the selected files.
	property SelectedIndex: Integer read GetSelectedIndex;	Indicates the position of the list item in the list items collection.
	property SelectedItems: TItemIdLists read GetSelectedItems;	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.
	property ShellLink: TJamShellLink read GetShellLink write SetShellLink;	Connects this component to a TJamShellLink in order to synchronize several shell controls.
	property ShellView: IShellView read GetShellView;	Gets the IShellView of the current folder view.
	property ShowErrorMessages: Boolean read GetShowErrorMessages write SetShowErrorMessage default True;	Allow Windows error messages.
	property ShowFiles: Boolean read GetShowFiles write SetShowFiles default True;	This property allows to include files in the view.
	property ShowFolders: Boolean read GetShowFolders write SetShowFolders default True;	This property allows to display folders or not.
	property ShowHidden: Boolean read GetShowHidden write SetShowHidden default False;	This property allows to hide files or folders.
	property ShowOptions: TJamShellShowOptions read GetShowOptions write SetShowOptions stored False default [soShowNethood, soShowRecycleBin, soShowFiles];	This property allows to change the look and the objects displayed.
	property SpecialFolder: TJamShellFolder read GetSpecialFolder write SetSpecialFolder default SF_DRIVES;	Allows you to deal with non file system folders.
	property Version: string read GetVersion stored False;	The current version of the ShellBrowser components.
	property ViewStyle: TJamViewStyle read GetViewStyle write SetViewStyle default vmAuto;	Determines how the list items are displayed.

Jam.Shell.Controls.ExplorerBrowser.TJamExplorerBrowser

	Name	Description
	property Addressbar: TJamShellBreadCrumbBar read fAddressbar;	The TJamShellBreadCrumbBar on top.
	property Align;	Determines how the control aligns within its container (parent control).
	property Anchors;	Specifies how the control is anchored to its parent.
	property BackgroundPopupMenu;	Popup menu for a right click on the background of the view.
	property BiDiMode;	See TControl.BiDiMode
	property BorderStyle;	Determines whether the list view displays a single line border.
	property CheckMode;	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.
	property Constraints;	Use Constraints to specify the minimum and maximum width and height of the control.
	property EmptyText;	Sets the new default text to be displayed when the ExplorerBrowser view is empty.
	property Enabled;	Controls whether the control responds to mouse, keyboard, and timer events.
	property ExplorerBrowserHandle: HWND read GetHandle;	Gets the handle to the ExplorerBrowser window.
	property FileSystemOnly;	Use FileSystemOnly to determine if only file system objects should be displayed.
	property Filter;	Allows you to filter objects by filename patterns.
	property GroupSubsetCount;	Gets or sets the number of visible rows of items in each group.
	property IconDimensions;	The height and width of icons in pixels. Only reasonibly applies in ViewStyle vmIcon
	property OleDragDrop;	Set this property to True to allow Ole Drag-and-Drop operations with the Windows Explorer and other shell controls.
	property OnBeforeFullRefresh;	Occurs before the full refresh is executed.
	property OnChanged;	Occurs if the underlying view has changed.
	property OnClick;	Occurs when the user clicks the control.
	property OnContextPopup;	Occurs when the user right-clicks the control or otherwise invokes the pop-up menu (such as using the keyboard).
	property OnDefaultAction;	Occurs after user performs a double click or hits the enter key.
	property OnDragLeave;	Occurs when the user drags a file out of the selected control.
	property OnEnter;	Occurs when a control receives the input focus.
	property OnExit;	Occurs when the input focus shifts away from one control to another.
	property OnKeyDown;	Occurs when a user presses any key while the control has focus.
	property OnKeyPress;	Occurs when a key is pressed.
	property OnKeyUp;	Occurs when the user releases a key that was pressed.
	property OnMouseDown;	Occurs when the user presses a mouse button with the mouse pointer over a control.
	property OnMouseMove;	Occurs when the user moves the mouse pointer while the mouse pointer is over a control.
	property OnMouseUp;	Occurs when the user releases a mouse button that was pressed with the mouse pointer over a component.
	property OnNavigationCompleted;	Occurs when navigating to a folder has been completed successfully.
	property OnNavigationImpossible;	Occurs when navigating to a folder has failed.
	property OnPathChanged;	The OnPathChanged event occurs, when the users changes the path.
	property OnPopulated;	The OnPopulated event occurs, after the control was filled completely.
	property OnResize;	Occurs when the control is resized.
	property OnSelectionChanged;	Occurs when selection has changed.
	property OpenFilesExternally: Boolean read fOpenFilesExternally write SetOpenFilesExternally default True;	Influences the handling of entered file paths in the addressbar.
	property ParentBiDiMode;	Specifies whether the control uses its parent's BiDiMode.
	property Path;	The file system path of the current folder.
	property PopupMenu;	Specifies the pop-up menu associated with the control.
	property ShellLink;	Connects this component to a ShellLink.TJamShellLink in order to synchronize several shell controls.
	property ShowErrorMessages;	Allow Windows error messages.
	property ShowFiles;	This property allows to include files in the view.
	property ShowFolders;	This property allows to display folders or not.
	property ShowHidden;	This property allows to hide files or folders.
	property ShowNethood;	Show Network neighbourhood.
	property ShowRecycleBin;	Show the Recycle Bin.
	property SpecialFolder;	Allows you to deal with non file system folders.
	property StyleName;	Specifies the style name for this control.
	property TabOrder;	Indicates the position of the control in its parent's tab order.
	property TabStop;	Determines whether the user can tab to a control.
	property ViewStyle;	Determines how the list items are displayed.
	property Visible;	Determines whether the component appears on screen.
	property VisiblePanes: TJamShellExplorerPanes read fVisiblePanes write SetVisiblePanes default [epAuto];	Gets or sets the visible panes.

Links

Jam.Shell.Controls.ExplorerBrowser, Legend, Members, Public Methods, TJamShellControl Events, IJamShellControl Methods, IJamShellControl Properties

Contents | Index | Home