TJamShellList Class

A JamShellList control looks and behaves like the right pane of the Windows Explorer.

Syntax

Pascal

TJamShellList = class(TJamBaseShellListView, IDropTarget, IDropSource, IThumbnailViewer, IIconViewer, ICheckBoxViewer);

File

ShellControls

Remarks

This control displays the contents of a folder in a listview. When the user right clicks on a folder, it will automatically show the context menu. TJamShellList is derived from Delphi's TListView control, so you can use most of the properties and methods of the superclass with a TJamShellList.

Use the Path property to get or set the current Folder, use the SpecialFolder property to set a special folder like the Control Panel. The Filter property can be used to filter certain files by extension. The FullRefresh method refreshes the displayed information. This control does not have a Font property, because it automatically uses the same font the Windows Explorer uses. Use the Popup property to merge your Delphi popup menus with the Shell Context menu. You can synchronize a TJamShellList with a TJamShellTree by using the ShellLink property.

By default, a double click is handled by the component and it tries to perform the default action for the selected object. You can however use the OnDblClick event handler of the component to perform your own action. If you for example want to create a file open dialog, you want to handle double clicks on files by yourself, but double clicks on folders should be handled by the component. In this case, an event handler could look like this:

procedure TMyDialog.ShellListViewDblClick(Sender: TObject); begin With ShellListView do begin if (SelectedFiles.Count>0) and FileExists(Path + SelectedFiles[0]) then //Process File like you want ShowMessage('Double click on file: ' + Path + SelectedFiles[0]) else InvokeCommandOnSelected('default'); end;//With end;

Notes

To improve the speed in which a TJamShellList gets filled, we are using Windows API messages that fill the Subitems of a TJamShellListItem by demand only. As a result, Delphi's SubItems array appears to be empty. If you for some reason need to access the information in the SubItems array, you can use the OnAddItem event. Whenever this event is used, the SubItems array of each item gets filled when it is added (which results in a slower performance).

Since the extensions of the file may be not displayed dependant on the user's settings it is not sufficient to use the TJamShellListItem. Caption property to determine the name of a file that corresponds to a TJamShellListItem. You should use GetFullPath and SelectedFiles instead.

While this controls only mimics the right pane of the Windows Explorer, the TJamSystemShellView control hosts a true instance of the Windows Explorer's right pane and therefore looks an behaves exactly like the Windows Explorer on the target system.

Public Methods

TJamBaseShellListView Class

	Name	Description
	Create	Creates an instances of a TJamBaseShellListView component
	Destroy	Destroys an instance of a TJamBaseShellListView component

TJamShellList Class

	Name	Description
	Create	Creates an instance of a TJamShellList component.
	Destroy	Destroys the instance of a TJamShellList component.

public

	Name	Description
	ApplyCheckState	This is ApplyCheckState, a member of class ICheckBoxViewer.

IIconViewer Interface

	Name	Description
	SetIcon	This is SetIcon, a member of class IIconViewer.

IThumbnailViewer Interface

	Name	Description
	SetThumbnailBitmap	This is SetThumbnailBitmap, a member of class IThumbnailViewer.

IJamShellControl Interface

	Name	Description
	ShellLink	The TJamShellLink instance to which the current control connected.
	FileChanged	This method is called by the ShellLink instance if the currently selected item has changed.
	FullRefresh	This method indicates that the callee should perform a full refresh of its contents. This will usually be an entrie reload of the displyed items.
	getShellLink	Setter method for the ShellLink property.
	GoUp	This method indicates that the callee should go up one level and siplay the contents of the current folder's parent folder.
	PathChanged	This method is called by the ShellLink instance if the currently displayed folder has changed.
	SelectAll	This method indicates that the callee should select all item it currently displays.
	setShellLink	Getter method for the ShellLink property.
	SmartRefresh	This method indicates that the callee should perform a quick refresh of its contents. It is tolerable that changes in metadata are not detected. Removed and deleted items hsould be detected. The runtime of this method should be significantly faster thatn the one of the FullRefresh method.

TJamBaseShellListView Class

	Name	Description
	AutoSizeColumn	This has to be overwritten by the deriving class. Adjust the size of the given column so that it fills the remaining horizontal space.
	DoubleBuffered	Determines whether the control's image is rendered directly to the window or painted to an in-memory bitmap first.
	AutoAdjustColumnWidths	Auto adjust the widths of all columns.
	GetColumnOrderArray	Use this function to get an Array of Integers that contains the internal order of the columns. This is helpful if you changed the order during runtime and e.g. want to fill the subitems.
	GetColumnPosition	Returns the current column index for a given SHColumnId.
	GetDragImages	This is GetDragImages, a member of class TJamBaseShellListView.
	GetVisibleColumns	Use this function to get an array of currently visible columns.
	IsColumnVisible	Returns whether the given SHColumnId is currently visible or not.
	SetColumnVisibility	Set the visibility of a column.
	ShowBackgroundMenu	This has to be overwritten by the deriving class.
	ShowContextMenu	This is ShowContextMenu, a member of class TJamBaseShellListView.

TJamShellList Class

	Name	Description
	Columns	This is Columns, a member of class TJamShellList.
	FolderIdList	FolderIdList contains a pointer to the ItemIdList of the current folder.
	History	History manages a set of paths, which have been visited. It owns a Paths property to access its members
	Items	Contains the list of items displayed by the list view.
	LargeImages	This is LargeImages, a member of class TJamShellList.
	ReverseSortOrder	Indicates if sort order is normal or reverse.
	Selected	Indicates the first selected item in the list view.
	SelectedFiles	Provides a list of all selected files.
	SmallImages	This is SmallImages, a member of class TJamShellList.
	SortColumn	The column according to which the listed object are sorted.
	StateImages	This is StateImages, a member of class TJamShellList.
	CreateDir	Creates a new directory in the current folder.
	FullRefresh	Refreshes the contents of the TJamShellList.
	GetFullPath	Returns the full file system path of the given TJamShellListItem
	GetItemSelectionState	Get the checkbox state of an item.
	GoUp	Goes up one level in the file system structure.
	InvokeCommandOnFolder	Executes a context menu command for the listed folder.
	InvokeCommandOnSelected	Executes a context menu command for all selected items.
	IsFolder	This is IsFolder, a member of class TJamShellList.
	IsMovePossible	Checks if move is possible.
	IsSpecialObject	This is IsSpecialObject, a member of class TJamShellList.
	MoveInHistory	Jump back and forward to directories, which you selected before.
	SelectAll	Selects all Items in a TJamShellList.
	SelectedFilesSize	This method returns the size of the files, which the user selected in the TJamShellList.
	ShowBackgroundMenu	This has to be implemented by the deriving class.
	ShowContextMenu	Show the context menu for the selected items.
	SmartRefresh	Performs a quick refresh of the contents of the TJamShellList.

published

TJamBaseShellListView Class

	Name	Description
	IconSpacing	Let's you control the spacing between the large icons and thumbnails. The small icons should not be affected by this property.
	OnCreateColumns	This event is triggered after the columns were created
	ParentFont	This is ParentFont, a member of class TJamBaseShellListView.
	ReadOnly	Prevents operations that change the file system from being executed.
	ShellContextMenu	Automatically display the shell context menu.
	UseSystemStyles	Use the same styles as the Windows Explorer.
	Version	The version number of the ShellBrower controls.

TJamShellList Class

	Name	Description
	Align	This is Align, a member of class TJamShellList.
	Anchors	This is Anchors, a member of class TJamShellList.
	AutomaticRefresh	Receives notifications about changes in the shell and performs refreshes automatically.
	AutoSizeColumn	Adjust the size of the given column so that it fills the remaining horizontal space.
	BackgroundImage	Image that will be drawn in the background of the control.
	BackgroundImageStyle	If a background image is assigned, this property determines the style in which the image will be shown.
	BackgroundPopupMenu	Popup menu for a right click on the background of the List.
	BorderStyle	Determines whether the list view displays a single line border.
	Checkboxes	Turns on/off checkboxes for file and folder selection.
	Color	Specifies the background color of the control.
	ColorCompressed	Color compressed files.
	ColorEncrypted	Color encrypted files.
	Constraints	This is Constraints, a member of class TJamShellList.
	CopyMode	Use CopyMode to control the operation when an item is dragged or dropped.
	Ctl3D	This is Ctl3D, a member of class TJamShellList.
	Details	Use this property to control, if the TJamShellList control will show the Details of each object.
	DoubleBuffered	Determines whether the control's image is rendered directly to the window or painted to an in-memory bitmap first.
	DragCursor	This is DragCursor, a member of class TJamShellList.
	DragKind	This is DragKind, a member of class TJamShellList.
	DragMode	This is DragMode, a member of class TJamShellList.
	Enabled	Controls whether the control responds to mouse, keyboard, and timer events.
	FileSystemOnly	Use FileSystemOnly to specify, if only file system objects should be displayed.
	Filter	Allows you to filter objects by filename patterns.
	FlatScrollBars	Specifies whether the list view's scroll bars are flat.
	Font	Controls the attributes of text written on or in the control. Make sure to turn off UseSystemFont before editing this control! Otherwise the changes will not persist.
	FullDrag	Specifies whether headers are repainted when they are dragged.
	GridLines	Determines whether lines are drawn separating items in the list.
	HideSelection	Determines whether the list view gives a visual indication of which item is selected when focus shifts to another control.
	Hint	This is Hint, a member of class TJamShellList.
	HotTrack	Specifies whether list items are highlighted when the mouse passes over them.
	HotTrackStyles	This is HotTrackStyles, a member of class TJamShellList.
	HoverTime	Specifies how long the user must pause with the mouse before an item is selected.
	IconOptions	This is IconOptions, a member of class TJamShellList.
	IconsBasedOnFileExtension	If set to true, Icons will be determined based on their file extensions only. This is usually faster, in certains cases like EXE files the icons will differ from those shown in Windows Explorer.
	ImeMode	This is ImeMode, a member of class TJamShellList.
	ImeName	This is ImeName, a member of class TJamShellList.
	MultiSelect	Determines whether the user can select more than one list item at a time.
	NoFillOnStartup	Prevent the control to be filled on startup of the application.
	OleDragDrop	Set this property to true to allow Ole Drag and Drop operation with the Windows Explorer and other shell controls.
	OnAddItem	OnAddItem occurs, whenever a new item is added to a TJamShellList.
	OnAdvancedCustomDraw	This is OnAdvancedCustomDraw, a member of class TJamShellList.
	OnAdvancedCustomDrawItem	This is OnAdvancedCustomDrawItem, a member of class TJamShellList.
	OnAdvancedCustomDrawSubItem	This is OnAdvancedCustomDrawSubItem, a member of class TJamShellList.
	OnBeforeFullRefresh	This event occurs just before the full refresh is executed.
	OnBeforeShellCommand	This event occurs, before a context menu command is executed.
	OnBeforeShellDrop	Allows you to prevent unwanted shell drops.
	OnCanResize	This is OnCanResize, a member of class TJamShellList.
	OnChange	This is OnChange, a member of class TJamShellList.
	OnChanging	This is OnChanging, a member of class TJamShellList.
	OnCheckStateChanged	This event is fired, if the state of a checkbox was changed by the user.
	OnClick	Occurs when the user clicks the control.
	OnColumnClick	This is OnColumnClick, a member of class TJamShellList.
	OnColumnDragged	Occurs when a column is dragged to a new position.
	OnColumnRightClick	This is OnColumnRightClick, a member of class TJamShellList.
	OnCompare	This is OnCompare, a member of class TJamShellList.
	OnContextMenuSelect	This event occurs, if the user has selected a menu item of the shell context menu.
	OnContextPopup	This is OnContextPopup, a member of class TJamShellList.
	OnCustomDraw	This is OnCustomDraw, a member of class TJamShellList.
	OnCustomDrawItem	This is OnCustomDrawItem, a member of class TJamShellList.
	OnCustomDrawSubItem	This is OnCustomDrawSubItem, a member of class TJamShellList.
	OnDblClick	Occurs when the user double-clicks the left mouse button when the mouse pointer is over the control.
	OnDeletion	This is OnDeletion, a member of class TJamShellList.
	OnDragDrop	This is OnDragDrop, a member of class TJamShellList.
	OnDragOver	This is OnDragOver, a member of class TJamShellList.
	OnDrawItem	This is OnDrawItem, a member of class TJamShellList.
	OnEdited	This is OnEdited, a member of class TJamShellList.
	OnEditing	This is OnEditing, a member of class TJamShellList.
	OnEndDock	This is OnEndDock, a member of class TJamShellList.
	OnEndDrag	This is OnEndDrag, a member of class TJamShellList.
	OnEnter	This is OnEnter, a member of class TJamShellList.
	OnExit	This is OnExit, a member of class TJamShellList.
	OnGetImageIndex	This is OnGetImageIndex, a member of class TJamShellList.
	OnInfoTip	This is OnInfoTip, a member of class TJamShellList.
	OnKeyDown	Occurs when a user presses any key while the control has focus.
	OnKeyPress	Occurs when key pressed.
	OnKeyUp	Occurs when a user presses any key while the control has focus.
	OnMouseDown	This is OnMouseDown, a member of class TJamShellList.
	OnMouseEnter	Occurs when the mouse pointer moves over the control.
	OnMouseLeave	Occurs when the mouse pointer moves off from over the control.
	OnMouseMove	This is OnMouseMove, a member of class TJamShellList.
	OnMouseUp	This is OnMouseUp, a member of class TJamShellList.
	OnOperation	The OnOperation event occurs after the TJamShellList executed a shell operation like pasting or dragging and dropping files.
	OnPathChanged	The OnPathChanged event occurs, when the users changes the path.
	OnPopulated	The OnPopulated event occurs, after a TJamShellList was filled completely.
	OnResize	This is OnResize, a member of class TJamShellList.
	OnSelectItem	This is OnSelectItem, a member of class TJamShellList.
	OnStartDock	This is OnStartDock, a member of class TJamShellList.
	OnStartDrag	This is OnStartDrag, a member of class TJamShellList.
	OnThumbnailUpdated	The OnThumbnailUpdated event occurs, when a viewed thumbnail is updated.
	ParentColor	This is ParentColor, a member of class TJamShellList.
	ParentCtl3D	This is ParentCtl3D, a member of class TJamShellList.
	ParentDoubleBuffered	Determines whether the control's image is rendered directly to the window or painted to an in-memory bitmap first.
	ParentFont	This is ParentFont, a member of class TJamShellList.
	ParentShowHint	This is ParentShowHint, a member of class TJamShellList.
	path	The file system path of the current folder.
	PopupMenu	This is PopupMenu, a member of class TJamShellList.
	RowSelect	Determines whether an entire row in the list view can be selected.
	ShellLink	Connects this component to a TJamShellLink in order to synchronize several shell controls.
	ShowColumnHeaders	Determines whether the column headers are displayed.
	ShowContextMenuOnTop	Show the context menu on the top of the supplied Delphi TPopupMenu.
	ShowErrorMessages	Allow Windows error messages.
	ShowExtraLargeIcons	Shows extra large icons.
	ShowFiles	The property ShowFiles allows you to include the files in the TJamShellList.
	ShowFolders	The property ShowFolders allows you to include the folders in the TJamShellList, similar to FrontPage 2000.
	ShowHidden	With this property you can hide or show hidden folders like the recycle bin or some special directories in the Windows folder.
	ShowHint	When this property is set to true, the hint text which the shell provides is shown.
	ShowJumboIcons	Shows jumbo icons.
	ShowNethood	If set to false, the Network Neighborhood will not be shown. The default value is true.
	ShowOverlayIcons	Determines whether the overlay icons are displayed.
	ShowParentFolder	Use this property to show an additional folder ".." to navigate upwards.
	ShowRecycleBin	Show the Recycle Bin.
	SpecialFolder	Allows you to deal with non file system folders.
	TabOrder	This is TabOrder, a member of class TJamShellList.
	TabStop	This is TabStop, a member of class TJamShellList.
	ThumbnailBorderColor	Specifies the background color of the control.
	ThumbnailHeight	Use ThumbnailHeight to find the vertical size in pixels of the jpeg image.
	Thumbnails	Switches the thumbnail mode on and off.
	ThumbnailWidth	Use ThumbnailWidth to find the horizontal size in pixels of the thumbnail image.
	UseSystemFont	If it is set to true, the TJamShellList uses the same font as the Windows Explorer.
	ViewStyle	Determines how the list items are displayed.
	Visible	Determines whether the component appears on screen.

Links

Members, public, published

Contents | Index | Home