ShellBrowser Class

SystemObject
  SystemMarshalByRefObject
    System.ComponentModelComponent
      Jam.ShellShellBrowserBase
        Jam.ShellShellBrowser

C#

VB

C++

F#

Copy

public class ShellBrowser : ShellBrowserBase

Public Class ShellBrowser
	Inherits ShellBrowserBase

public ref class ShellBrowser : public ShellBrowserBase

type ShellBrowser =  
    class
        inherit ShellBrowserBase
    end

	Name	Description
	ShellBrowser	Initializes a new instance of the ShellBrowser class. Since version 4.0 SpecialFolder does not point to Drives anymore, use ShellBrowser(ShellFolder) constructor instead, this is due to performance reasons.
	ShellBrowser(String)	Initializes a new instance of the ShellBrowser class makes the object with the given path the active object.
	ShellBrowser(ItemIdList)	Initializes a new instance of the ShellBrowser class makes the object with the given ItemIdList the active object.
	ShellBrowser(ShellBrowser)	Initializes a copy of the given ShellBrowser.
	ShellBrowser(ShellFolder)	Initializes a new instance of the ShellBrowserBase class and assigns its SpecialFolder property

Top

	Name	Description
	AbsoluteItemIdList	This property should only be used by advanced users. It sets or returns the absolute ItemIdList of the current object. The returned pointer to an ItemIdList will be valid, until a new object was selected. (Inherited from ShellBrowserBase.)
	AsyncOperations	Activates asynchronous file operations executed via InvokeContextMenuCommand(ShellCommand).
	DefaultSortColumn	Get the default sort column of the currently selected ShellFolder.
	FileNameFormat	Specifies, whether filename are presented with file extensions or not. By default, this depends on the respective setting in Windows Explorer. (Inherited from ShellBrowserBase.)
	FileSystemOnly	If FileSystemOnly is set to True, objects and virtual folders which do not have a file system path, will not be displayed. Exceptions are 'My Computer', 'Libraries' and 'Network' (Inherited from ShellBrowserBase.)
	Filter	You can use a single pattern, e.g. '.doc' or concatenate several patterns using semicolons to separate them, e.g. '.exe;*.com'. (Inherited from ShellBrowserBase.)
	FilterFilesOnly	Gets or sets a value indicating whether the Filter property applies to files only, but all folders are listed. (Inherited from ShellBrowserBase.)
	Folder	Use Folder to specify the path of the folder, which should be browsed or to get the path that is currently active. (Inherited from ShellBrowserBase.)
	FolderIdList	This property should only be used by advanced users. The returned ItemIdList has to be freed when it is not needed any more. (Inherited from ShellBrowserBase.)
	FullPath	Gets or set the full path of the active object. (Inherited from ShellBrowserBase.)
	HasSubFolders	Checks if the currently active object has subfolders. (Inherited from ShellBrowserBase.)
	IconNumber	Use IconNumber to get the number of the icon for the current object.
	IsEnumerable	True if the currently active object is a folder and can be browsed. (Inherited from ShellBrowserBase.)
	IsFolder	Can be used to query if the currently active object is a folder or not. (Inherited from ShellBrowserBase.)
	ItemIdList	Returns the relative ItemIdList of the current element in this instance. (Inherited from ShellBrowserBase.)
	MultiObjects	Holds a list of files that serves as selection for some operations like showing the context menu. (Inherited from ShellBrowserBase.)
	ObjectName	Use ObjectName to specify the current object or to retrieve the file system name of the current object. A valid folder must be set, see FullPath and SpecialFolder (Inherited from ShellBrowserBase.)
	ReadOnly	If set to 'true', context menu operations that make changes to the file system will not be executed.
	SelectedIconNumber	Use SelectedIconNumber to get the number of the 'opened' icon for the current object.
	ShowErrorMessages	If set to to 'true', error messages will be shown to the user. If set to 'false', error messages will be suppressed. (Inherited from ShellBrowserBase.)
	ShowShellContextMenuOnTop	Decides if the shell context menu is added above or below the supplied ContextMenuStrip.
	SpecialFolder	Get or set a special folder as the currently active folder (Inherited from ShellBrowserBase.)
	SpecialObject	Get or set a special object as the currently active object (Inherited from ShellBrowserBase.)
	Version	The current version of the ShellBrowser.

Top

	Name	Description
	BrowseObject	Makes the currently active shell object the current folder. (Inherited from ShellBrowserBase.)
	CanRename	Checks if the currently active object can be renamed. (Inherited from ShellBrowserBase.)
	CheckIfValid(Boolean)	Checks if the current object is in a valid state for performing operations (Inherited from ShellBrowserBase.)
	CheckIfValid(Boolean, Boolean)	Checks if the current object is in a valid state for performing operations (Inherited from ShellBrowserBase.)
	ConnectToServer	Connects to a remote computer.
	Dispose	Releases all resources held by this instance. (Inherited from ShellBrowserBase.)
	EnsureExtension	Ensures the given extension for a filename or path.
	FilterMatch	Checks if the currently active object matches the filter that is set. (Inherited from ShellBrowserBase.)
	FromHbitmap	Obsolete. Converts a handle to a HBITMAP structure to an Image instance. If the size given is lesser than 256 pixels in width and height, the alpha channel is preserved.
	GetAttributes	Checks if the given attributes apply to the current objects (Inherited from ShellBrowserBase.)
	GetColumnInfo	Use this function to get information about the columns, which the Explorer uses in the details view. Provides the default alignment and the default width of a column, like Explorer would use it. Use GetColumnText(Int32, Boolean) or GetColumnText(SHCOLUMNID, Boolean) to get the column title or the text for a specific column.
	GetColumnText(Int32, Boolean)	Returns the text to show for the currently active item in a certain column.
	GetColumnText(SHCOLUMNID, Boolean)	Returns the text to show for the currently active item in a certain column.
	GetColumnText(SHCOLUMNID, Boolean, Object)	Returns the text which would be displayed in the Details view of the Windows Explorer as String and Variant.
	GetDataObject	Returns the Windows Shell IDataObject interface for the currently active object wrapped into an instance of type DataObject.
	GetDataObject(ItemIdList)	Returns the Windows Shell IDataObject interface for the passed relative ItemIdLists wrapped into an instance of type DataObject.
	GetDefaultSavePathFromLibrary	For a given Windows 7+ library, this function returns the default save path.
	GetDomain	Returns the domain name of the currently active object. (Inherited from ShellBrowserBase.)
	GetDragEffects	Returns which drag effects are possible for the currently active object.
	GetEnumerator	Implemetation of IEnumerable.GetEnumerator (Inherited from ShellBrowserBase.)
	GetIndexOfShColumnID	Gets the shell index for a given ShColumnID.
	GetInfoTip	This method returns the hint text of the current object which is provided by the shell. Per default this includes information that might take some time until it is retrieved, (ie. recursively determine folder size)
	GetInfoTip(Boolean)	This method returns the hint text of the current object, which is provided by the shell.
	GetIShellDetails	Tests if ShellFolder1.CreateViewObject succeeds. This is a prerequisite for other methods to work successfully. (Inherited from ShellBrowserBase.)
	GetLastChangeDate	Returns the last modified date of the currently active object.
	GetLinkTarget	Returns the target a windows file link (.lnk file) is pointing to.
	GetOverlayIndex	Use GetOverlayIndex to get the index of the overlay icon of the current object.
	GetSelectedItemIdLists	Gets the items the command will be executed upon. (Inherited from ShellBrowserBase.)
	GetShColumnIdFromColumnNumber	Returns the ShColumnID for the given shell column number.
	GetShellObjectName	Returns the Windows shell display name of the currently active object. (Inherited from ShellBrowserBase.)
	GetThumbnailBitmap(Size)	Returns the thumbnail image of the currently active shell object in the requested size.
	GetThumbnailBitmap(Size, GetThumbnailCallback, Object)	Asynchronously extracts the thumbnail image of the currently active shell object in the requested size. Only for folders on Vista or later the size will always be quadratic with side length being the smallest of either p_Size.Width or p_Size.Height, to avoid a stretching - use the synchronous call GetThumbnailBitmap(Size) if you'd like to explicitly specify the dimensions
	GetThumbnailBitmap(Size, GetThumbnailCallback, Object, Int32)	Asynchronously extracts the thumbnail image of the currently active shell object in the requested size. Only for folders on Vista or later the size will always be quadratic with side length being the smallest of either p_Size.Width or p_Size.Height, to avoid a stretching - use the synchronous call GetThumbnailBitmap(Size) if you'd like to explicitly specify the dimensions
	GetThumbnailBitmap(Size, GetThumbnailCallback, Object, Int32, Boolean)	Asynchronously extracts the thumbnail image of the currently active shell object in the requested size. Only for folders on Vista or later the size will always be quadratic with side length being the smallest of either p_Size.Width or p_Size.Height, to avoid a stretching - use the synchronous call GetThumbnailBitmap(Size) if you'd like to explicitly specify the dimensions
	GetUIObject(Guid)	Queries and returns COM interfaces from the currently active Folder and object. If object names are assigned to the MultiObject collection, then they will be used. (Inherited from ShellBrowserBase.)
	GetUIObject(Guid, ItemIdList)	Queries and returns COM interfaces from the currently active Folder and the given ItemIdLists. (Inherited from ShellBrowserBase.)
	GetWindowHandle	Returns an approriate window handle for operations that require a window handle. It takes care that a null handle is returned to prevent error messages if ShowErrorMEssages is set to false. (Inherited from ShellBrowserBase.)
	HasAttributes	Checks if the given attributes apply to the current objects. (Inherited from ShellBrowserBase.)
	InvokeCommandOnSelected	Executes the given command on the selected items. (Overrides ShellBrowserBaseInvokeCommandOnSelected(ShellCommand).)
	InvokeContextMenuCommand	Invokes the given shell command to the active object or, if not empty, to the obejct in the MultiObjects property.
	InvokeContextMenuCommandOnMultiObjects	Invokes the given command on multiple objects. Multiobjects needs the fullpath of these objects, if the path is different from the folder of the called ShellBrowser instance.
	IsAdmin	Checks whether the user is admin or not. In Vista or later: Determines whether application is running with elevated rights (UAC) or not.
	IsColumnAvailable(Int32)	Checks whether the given column is available for the current folder.
	IsColumnAvailable(SHCOLUMNID)	Checks whether the given column is available for the current folder.
	IsCompressed	Checks if the currently active object is compressed. (Inherited from ShellBrowserBase.)
	IsEncrypted	Checks if the currently active object is encrypted. (Inherited from ShellBrowserBase.)
	IsFileSystemFolder	Checks if the currently active object is a file system object that can be accesses through a path.
	IsHidden	Checks if the currently active object is hidden. (Inherited from ShellBrowserBase.)
	IsLink	Checks if the currently active object is a link or shortcut. (Inherited from ShellBrowserBase.)
	IsLinkToFolder	Checks if the currently active object is a link to another folder and returns the path to it.
	MatchPattern	Returns true if the given string matched the wild card pattern
	Next	Moves on to next object in the active folder and makes it the active object. If Next has not been called before for the active folder, the first object is made active. (Inherited from ShellBrowserBase.)
	Next(IShellChangeNotifier)	Moves on to next object in the active folder and makes it the active object. If Next has not been called before for the active folder, the first object is made active. (Inherited from ShellBrowserBase.)
	OnAfterInvokeCommand	Is called after the command has been called. (Overrides ShellBrowserBaseOnAfterInvokeCommand(ShellCommandEventArgs).)
	OnBeforeInvokeCommand	This method is called to trigger the BeforeShellCommand event. (Overrides ShellBrowserBaseOnBeforeInvokeCommand(BeforeShellCommandEventArgs).)
	OnContextMenuItemSelected	Triggers the ContextMenuItemSelect event.
	OnRenameItemSelected	Fires the RenameItemSelected event
	RenameObject	Renames the current object.
	Reset	Resets the enumeration of the items in the active folder. It can be started again using Next (Inherited from ShellBrowserBase.)
	ResetFPU	Resets the floating point control register to what .NET expects.
	SelectParent	Moves up to the parent of the current shell object (Inherited from ShellBrowserBase.)
	SetThumbnailProvider	Allows to set a callback function that can supply a thumbnail image in case the system cannot provide one.
	ShowContextMenu(Point)	Shows the shell context menu for the files contained in MultiObjects or the active object.
	ShowContextMenu(Point, ContextMenuStrip)	Shows the shell context menu for the files contained in MultiObjects or the active object, adding the context menu entries contained in pContextMenuStrip

Top

	Name	Description
	BeforeShellCommand	This event is fired before a shell command is executed. It can be intercepted by setting Cancel to true in the event handler. (Inherited from ShellBrowserBase.)
	ContextMenuItemSelected	This event is fired when a context menu item is selected.
	RenameItemSelected	This event is fired when the context menu option "Rename" is selected.

Top

	Name	Description
	MAX_COLUMNS	Max number of columns.

Top

ShellBrowserBase 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. Use IsFolder to check if the current object is a folder. IconNumber contains the number of the corresponding icon of the current object in the system icon list. The method ShowContextMenu(Point) 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(ShellCommand) will execute a command of the context menu, for example 'properties', 'default' or 'delete'.

Reference

Jam.Shell Namespace