ShellBrowserBase 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.

Inheritance Hierarchy

SystemObject
  SystemMarshalByRefObject
    System.ComponentModelComponent
      Jam.ShellShellBrowserBase
        Jam.ShellShellBrowser

Namespace: Jam.Shell
Assembly: ShellBrowser.Core (in ShellBrowser.Core.dll) Version: 6.3.1

Syntax

C++

Copy

public class ShellBrowserBase : Component, 
	IShellCommandInvokable

Public Class ShellBrowserBase
	Inherits Component
	Implements IShellCommandInvokable

public ref class ShellBrowserBase : public Component, 
	IShellCommandInvokable

type ShellBrowserBase =  
    class
        inherit Component
        interface IShellCommandInvokable
    end

The ShellBrowserBase type exposes the following members.

Constructors

	Name	Description
	ShellBrowserBase	Default constructor.
	ShellBrowserBase(ShellBrowserBase)	Copy constructor. Creates a clone of the passed ShellBrowser instance.
	ShellBrowserBase(ShellFolder)	Initializes a new instance of the ShellBrowserBase class and assigns its SpecialFolder property

Top

Properties

	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.
	FileNameFormat	Specifies, whether filename are presented with file extensions or not. By default, this depends on the respective setting in Windows Explorer.
	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'
	Filter	You can use a single pattern, e.g. '.doc' or concatenate several patterns using semicolons to separate them, e.g. '.exe;*.com'.
	FilterFilesOnly	Gets or sets a value indicating whether the Filter property applies to files only, but all folders are listed.
	Folder	Use Folder to specify the path of the folder, which should be browsed or to get the path that is currently active.
	FolderIdList	This property should only be used by advanced users. The returned ItemIdList has to be freed when it is not needed any more.
	FullPath	Gets or set the full path of the active object.
	HasSubFolders	Checks if the currently active object has subfolders.
	IsEnumerable	True if the currently active object is a folder and can be browsed.
	IsFolder	Can be used to query if the currently active object is a folder or not.
	IsVistaOrLater	Returns true if the system runs the windows vista operating system or later.
	IsWindows10OrLater	Returns true if the system runs the Windows 10 operating system or later.
	IsWindows7OrLater	Returns true if the system runs the Windows 7 operating system or later.
	IsWindows8OrLater	Returns true if the system runs the Windows 8 operating system or later.
	IsXpOrLater	Returns true if the system runs the windows xp operating system or later.
	ItemIdList	Returns the relative ItemIdList of the current element in this instance.
	MultiObjects	Holds a list of files that serves as selection for some operations like showing the context menu.
	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
	ShowErrorMessages	If set to to 'true', error messages will be shown to the user. If set to 'false', error messages will be suppressed.
	SpecialFolder	Get or set a special folder as the currently active folder
	SpecialObject	Get or set a special object as the currently active object

Top

Methods

	Name	Description
	BrowseObject	Makes the currently active shell object the current folder.
	CanRename	Checks if the currently active object can be renamed.
	CheckIfValid(Boolean)	Checks if the current object is in a valid state for performing operations
	CheckIfValid(Boolean, Boolean)	Checks if the current object is in a valid state for performing operations
	Dispose	Releases all resources held by this instance. (Overrides ComponentDispose(Boolean).)
	Filter2Regex(String)	Converts a semicolon separated file filter i.e. ".txt;.doc" to a case-insensitve regular expression
	Filter2Regex(String, RegexOptions)	Converts a semicolon separated file filter i.e. ".txt;.doc" to a regular expression
	FilterMatch	Checks if the currently active object matches the filter that is set.
	GetAttributes	Checks if the given attributes apply to the current objects
	GetDesktopName	Returns the name of the root of the Windows shell namespace, which is "Desktop" in English Windows versions.
	GetDomain	Returns the domain name of the currently active object.
	GetEnumerator	Implemetation of IEnumerable.GetEnumerator
	GetIShellDetails	Tests if ShellFolder1.CreateViewObject succeeds. This is a prerequisite for other methods to work successfully.
	GetSelectedItemIdLists	Gets the items the command will be executed upon.
	GetShellObjectName	Returns the Windows shell display name of the currently active object.
	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.
	GetUIObject(Guid, ItemIdList)	Queries and returns COM interfaces from the currently active Folder and the given ItemIdLists.
	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.
	HasAttributes	Checks if the given attributes apply to the current objects.
	HasFileExtension	Checks whether the given fullpath or filename has the given extension.
	InvokeCommandOnSelected	Executes the given command on the selected items.
	IsCompressed	Checks if the currently active object is compressed.
	IsEncrypted	Checks if the currently active object is encrypted.
	IsHidden	Checks if the currently active object is hidden.
	IsLink	Checks if the currently active object is a link or shortcut.
	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.
	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.
	OnAfterInvokeCommand	Is called after the command has been called.
	OnBeforeInvokeCommand	Is called before the command is called.
	Reset	Resets the enumeration of the items in the active folder. It can be started again using Next
	SelectParent	Moves up to the parent of the current shell object

Top

Events

	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.

Top

Remarks

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.

Reference

Jam.Shell Namespace