TShellBrowser Class

The ShellBrowser component is a non-visual component and allows you to browse to the shell name space of Windows, to query information about shell objects and to perform context menu operations. It is currently only available in the VCL version and is the base for all visual controls.

Class Hierarchy

Syntax

Pascal

TShellBrowser = class(TComponent);

File

ShellBrowser

Remarks

The ShellBrowser component is a non-visual component. The property Folder contains the path of the current folder, ObjectName contains the name of the current object. Use the method Next to enumerate the objects in the current folder. TShellBrowser.IconNumber contains the number of the corresponding icon of the current object in the system icon list. The method ShowContextMenu shows the context menu of the current object at a given point. You can shuffle your own popup menus together with the explorer context menu. InvokeContextMenuCommand will execute a command of the context menu, for example 'properties', 'default' or 'delete'. Use IsFolder to check if the current object is a folder. Use a TJamSystemImageList component to get the icons of files and folders.

Example

This example shows how to get all drives of the current system.

ShellBrowser.SpecialFolder := SF_DRIVES; While ShellBrowser.Next do begin if Pos(':', ShellBrowser.ObjectName)>0 then ListOfDrives.Items.Add(ShellBrowser.ObjectName); end;

Public Methods

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

public

	Name	Description
	AbsoluteItemIdList	AbsoluteItemIdList returns a pointer to a fully qualified ItemIdList of the current object.
	AsyncContextMenuOperations	If set to True (the default value), context menu operations will be executed asynchronously in an own thread if possible, if False, they will be executed synchronously in the main thread.
	FolderIdList	FolderIdList contains a pointer to the ItemIdList of the current folder.
	FullPath	The full path of the current object.
	IconNumber	Use IconNumber to get the number of the icon for the current object.
	ItemIdList	ItemIdList contains a pointer to the ItemIdList of the current object.
	ObjectName	ObjectName contains the name of the current object
	ReadOnly	If set to true, context menu operations that make changes to the file system (like "delete" or "copy") will not be executed.
	SelectedIconNumber	Use SelectedIconNumber to get the number of the 'opened' icon for the current object.
	ShellFolder	This property gives access to the IShellFolder interface of the current folder.
	SpecialObject	Allows you deal with non file system objects.
	BrowseObject	Use BrowseObject to browse into the current object.
	CanRename	Returns true, if the current object can be renamed.
	CheckIfValid	Checks if the current object is in a valid state for performing operations
	CompareCurrentObjectTo	Compares the current object to another, specified by it ItemIdList relative to the current folder.
	FilterMatch	Checks if the currently active object matches the filter.
	GetAttributes	Get Attributes of the current object
	GetColumnInfo	Returns information about alignment and width of a column.
	GetColumnText	Returns the text which would be displayed in the Details view of the Windows Explorer.
	GetDefaultColumnState	Returns the default column state
	GetDesktopIconIndex	Use GetDesktopIconIndex to get the number of the desktop icon.
	GetDesktopName	This method returns the language defendant name of the Desktop folder.
	GetFileSize	This method returns the size of the current file in Bytes and -1 upon error.
	GetIndexOfShColumnId	Returns the index for a given SHColumnId.
	GetInfoTip	This method returns the hint text of the current object, which is provided by the shell.
	GetLastChangeDate	Returns the last change date of the current object.
	GetOverlayIndex	Use GetOverlayIndex to get the index of the overlay icon of the current object.
	GetShColumnIdFromColumnNumber	Returns the SHColumnId for a given column number.
	GetShellObjectName	Gets the well formatted shell name of the current object
	GetSortColumn	Returns the default sort column.
	GetThumbnailBitmap	Use GetThumbnailBitmap to get a TBitmap Thumbnail of the current file
	GetThumbnailImage	Use GetThumnailImage to get a TImage of a thumbnail.
	GetUIObject	Wrapper for IShellFolder.GetUIObjectOf method.
	HandlePopupMessages	Handles messages of popup messages, neccessary to show Send To submenu correct
	HasSubFolders	Use the property HasSubFolders to check if the current object has subfolders.
	InvokeContextMenuCommand	Executes a command of the context menu of the current object.
	InvokeDefaultContextMenuCommand	Executes the default path on the given files.
	IsDrive	This function returns true, if the given path is a drive like C:, D: or \servershare .
	IsFileSystemFolder	This function returns true, if the current object is a folder of the file system.
	IsFolder	Use the property IsFolder to check if the current object is a folder.
	IsHidden	Use this property to determine if the current object should be displayed as hidden.
	IsLink	Use this property to determine if the current object is a shortcut to another object.
	IsLinkToFolder	Find out if the current object is a shortcut to a folder
	IsSpecialObject	Returns the type of the current object.
	Next	Next enumerates the objects in the current folder.
	QueryBackgroundMenu	Query the BackgroundMenu - needed to generate the ShellNew-registry value for our NewFile-menu
	RenameObject	Use RenameObject to rename the current object.
	SaveThumbnailToJPEG	Use SaveThumbnailToJPEG to save a thumbnail image as jpeg-file.
	SelectParent	Use SelectParent to select the parent folder.
	ShowBackgroundMenu	Show the context menu when the user right clicks on the background of the Windows Explorer
	ShowContextMenu	Shows the context menu for files or folders as submenu of an existing menu item.
	ShowNetConnectionDialog	Use this method to display the system dialog to connect a new network drive.

published

	Name	Description
	FileSystemOnly	Use FileSystemOnly to specify, if Next will return only file system objects.
	Filter	Allows you to filter objects by filename when enumerating them using the Next function.
	Folder	Folder contains the path to the current object.
	MultiObjects	Use MultiObjects if you want use ShowContextMenu or InvokeContextMenuCommand for multiple files and folders.
	OnBeforeShellCommand	This event occurs, before a context menu command is executed.
	OnContextMenuSelect	This event occurs, if the user has selected a menu item of the shell context menu.
	OnRename	This event occurs when the user selected 'Rename' in the context menu of an object.
	ShowContextMenuOnTop	Decides if the shell context menu is added above or below the supplied Delphi TPopupMenu.
	ShowErrorMessages	Use this property to define, if Windows error messages will be shown to the user or not.
	SpecialFolder	Allows you to deal with non file system folders.
	Version	This is Version, a member of class TShellBrowser.
	SetThumbnailProvider	Allows to set a callback function that can supply a thumbnail image in case the system cannot provide one.

Links

Members, public, published

Contents | Index | Home