Click or drag to resize

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

Namespace:  Jam.Shell
Assembly:  ShellBrowser.Core (in ShellBrowser.Core.dll) Version: 6.2
Syntax
public class ShellBrowserBase : Component, 
	IShellCommandInvokable

The ShellBrowserBase type exposes the following members.

Constructors
  NameDescription
Public methodShellBrowserBase
Default constructor.
Public methodShellBrowserBase(ShellBrowserBase)
Copy constructor. Creates a clone of the passed ShellBrowser instance.
Public methodShellBrowserBase(ShellFolder)
Initializes a new instance of the ShellBrowserBase class and assigns its SpecialFolder property
Top
Properties
  NameDescription
Public propertyAbsoluteItemIdList
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.
Public propertyFileNameFormat
Specifies, whether filename are presented with file extensions or not. By default, this depends on the respective setting in Windows Explorer.
Public propertyFileSystemOnly
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'
Public propertyFilter
You can use a single pattern, e.g. '*.doc' or concatenate several patterns using semicolons to separate them, e.g. '*.exe;*.com'.
Public propertyFilterFilesOnly
Gets or sets a value indicating whether the Filter property applies to files only, but all folders are listed.
Public propertyFolder
Use Folder to specify the path of the folder, which should be browsed or to get the path that is currently active.
Public propertyFolderIdList
This property should only be used by advanced users. The returned ItemIdList has to be freed when it is not needed any more.
Public propertyFullPath
Gets or set the full path of the active object.
Public propertyHasSubFolders
Checks if the currently active object has subfolders.
Public propertyIsEnumerable
True if the currently active object is a folder and can be browsed.
Public propertyIsFolder
Can be used to query if the currently active object is a folder or not.
Public propertyStatic memberIsVistaOrLater
Returns true if the system runs the windows vista operating system or later.
Public propertyStatic memberIsWindows10OrLater
Returns true if the system runs the Windows 10 operating system or later.
Public propertyStatic memberIsWindows7OrLater
Returns true if the system runs the Windows 7 operating system or later.
Public propertyStatic memberIsWindows8OrLater
Returns true if the system runs the Windows 8 operating system or later.
Public propertyStatic memberIsXpOrLater
Returns true if the system runs the windows xp operating system or later.
Public propertyItemIdList
Returns the relative ItemIdList of the current element in this instance.
Public propertyMultiObjects
Holds a list of files that serves as selection for some operations like showing the context menu.
Public propertyObjectName
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
Public propertyShowErrorMessages
If set to to 'true', error messages will be shown to the user. If set to 'false', error messages will be suppressed.
Public propertySpecialFolder
Get or set a special folder as the currently active folder
Public propertySpecialObject
Get or set a special object as the currently active object
Top
Methods
  NameDescription
Public methodBrowseObject
Makes the currently active shell object the current folder.
Public methodCanRename
Checks if the currently active object can be renamed.
Protected methodCheckIfValid(Boolean)
Checks if the current object is in a valid state for performing operations
Protected methodCheckIfValid(Boolean, Boolean)
Checks if the current object is in a valid state for performing operations
Protected methodDispose
Releases all resources held by this instance.
(Overrides ComponentDispose(Boolean).)
Protected methodStatic memberFilter2Regex(String)
Converts a semicolon separated file filter i.e. "*.txt;*.doc" to a case-insensitve regular expression
Protected methodStatic memberFilter2Regex(String, RegexOptions)
Converts a semicolon separated file filter i.e. "*.txt;*.doc" to a regular expression
Public methodFilterMatch
Checks if the currently active object matches the filter that is set.
Protected methodGetAttributes
Checks if the given attributes apply to the current objects
Public methodStatic memberGetDesktopName
Returns the name of the root of the Windows shell namespace, which is "Desktop" in English Windows versions.
Public methodGetDomain
Returns the domain name of the currently active object.
Public methodGetEnumerator
Implemetation of IEnumerable.GetEnumerator
Protected methodGetIShellDetails
Tests if ShellFolder1.CreateViewObject succeeds. This is a prerequisite for other methods to work successfully.
Public methodGetSelectedItemIdLists
Gets the items the command will be executed upon.
Public methodGetShellObjectName
Returns the Windows shell display name of the currently active object.
Public methodGetUIObject(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.
Public methodGetUIObject(Guid, ItemIdList)
Queries and returns COM interfaces from the currently active Folder and the given ItemIdLists.
Protected methodGetWindowHandle
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.
Public methodHasAttributes
Checks if the given attributes apply to the current objects.
Public methodStatic memberHasFileExtension
Checks whether the given fullpath or filename has the given extension.
Public methodInvokeCommandOnSelected
Executes the given command on the selected items.
Public methodIsCompressed
Checks if the currently active object is compressed.
Public methodIsEncrypted
Checks if the currently active object is encrypted.
Public methodIsHidden
Checks if the currently active object is hidden.
Public methodIsLink
Checks if the currently active object is a link or shortcut.
Public methodNext
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.
Public methodNext(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.
Public methodOnAfterInvokeCommand
Is called after the command has been called.
Public methodOnBeforeInvokeCommand
Is called before the command is called.
Protected methodReset
Resets the enumeration of the items in the active folder. It can be started again using Next
Public methodSelectParent
Moves up to the parent of the current shell object
Top
Events
  NameDescription
Public eventBeforeShellCommand
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.
See Also