ShellBrowser .Net Edition
ShellBrowser Class
NamespacesJam.ShellShellBrowser
This class is used as a wrapper around the Win32 shell API.
Declaration Syntax
C#Visual BasicVisual C++
public class ShellBrowser : Component
Public Class ShellBrowser _
	Inherits Component
public ref class ShellBrowser : public Component
Members
All MembersConstructorsMethodsPropertiesFieldsEvents



IconMemberDescription
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(ShellFolder)
Initializes a new instance of the ShellBrowser class and assigns its SpecialFolder property

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.

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.

BeforeShellCommand
This event is fired before a shell command is executed. It can be intercepted by setting ExecuteShellCommand to false in the event handler.

BrowseObject()()()
Makes the currently active shell object the current folder.

CanRaiseEvents
Gets a value indicating whether the component can raise an event.
(Inherited from Component.)
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

ConnectToServer(String)
Connects to a remote computer.

Container
Gets the IContainer that contains the Component.
(Inherited from Component.)
ContextMenuItemSelected
This event is fired when context menu item is selected.

CopyMenuItem(MenuItem)
Copies a menu item of the class MenuItem.

CopySubMenu(Menu, Menu)
Creates a copy of a menu or submenu.

CreateObjRef(Type)
Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
(Inherited from MarshalByRefObject.)
DesignMode
Gets a value that indicates whether the Component is currently in design mode.
(Inherited from Component.)
Dispose(Boolean)
Releases all resources held by this instance of the ShellBrowser class.
(Overrides Component.Dispose(Boolean).)
Dispose()()()
Releases all resources used by the Component.
(Inherited from Component.)
Disposed
Occurs when the component is disposed by a call to the Dispose()()() method.
(Inherited from Component.)
Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Events
Gets the list of event handlers that are attached to this Component.
(Inherited from Component.)
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'.

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.

Finalize()()()
Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection.
(Inherited from Component.)
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.

FromHbitmap(IntPtr, Size)
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.

GetColumnInfo(Int32, Int32%)
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.

GetDataObject()()()
Returns the Windows Shell IDataObject interface for the currently active object wrapped into an instance of type DataObject.

GetDataObject(array<ItemIdList>[]()[])
Returns the Windows Shell IDataObject interface for the passed relative ItemIdLists wrapped into an instance of type DataObject.

GetDefaultSortColumn()()()
Get the default sort column of the currently selected ShellFolder.

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.

GetDragEffects()()()
Returns which drag effects are possible for the currently active object.

GetEnumerator()()()
Implemetation of IEnumerable.GetEnumerator

GetFirstItemIDListFromDataObject(IDataObject)
Returns the first item id list from the data object passed as a parameter.

GetHashCode()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetIndexOfShColumnID(SHCOLUMNID)
Gets the 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()()()

GetItemIDListsFromDataObject(IDataObject)
Returns all absolute item id lists from the data object passed as a parameter.

GetLastChangeDate()()()
Returns the last modified date of the currently active object.

GetLifetimeService()()()
Retrieves the current lifetime service object that controls the lifetime policy for this instance.
(Inherited from MarshalByRefObject.)
GetLinkTarget(String)
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.

GetRelativeItemIDListsFromDataObject(IDataObject, ItemIdList%)
Returns all relative item id lists from the data object passed as a parameter

GetService(Type)
Returns an object that represents a service provided by the Component or by its Container.
(Inherited from Component.)
GetShColumnIdFromColumnNumber(Int32)
Returns the ShColumnID for the given shell column number.

GetShellObjectName()()()
Returns the Windows shell display name of the currently active object.

GetThumbnailBitmap(Size)
Returns the thumbnail image of the currently active shell object in the requested size.

GetThumbnailBitmap(Size, ShellBrowser..::.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, ShellBrowser..::.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

GetType()()()
Gets the Type of the current instance.
(Inherited from 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, array<ItemIdList>[]()[])
Queries and returns COM interfaces from the currently active Folder and the given ItemIdLists.

GetWindowHandle(Boolean)
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(SFGAOF)
Checks if the given attributes apply to the current objects.

HasFileExtension(String, String)
Checks whether the given fullpath or filename has the given extension.

HasSubFolders
Checks if the currently active object has subfolders.

IconNumber
Use IconNumber to get the number of the icon for the current object.

InitializeLifetimeService()()()
Obtains a lifetime service object to control the lifetime policy for this instance.
(Inherited from MarshalByRefObject.)
InvokeContextMenuCommand(String)
Invokes the given shell command to the active object or, if not empty, to the obejct in the MultiObjects property.

InvokeContextMenuCommandOnMultiObjects(String)
Invokes the given command on multiple objects. Multiobjects needs the fullpath of these objects.

IsAdmin()()()
Checks whether the user is admin or not. In Vista or later: Determines whether application is running with elevated rights (UAC) or not.

IsCompressed()()()
Checks if the currently active object is compressed.

IsEncrypted()()()
Checks if the currently active object is encrypted.

IsFileSystemFolder()()()
Checks if the currently active object is a file system object that can be accesses through a path.

IsFolder
Can be used to query if the currently active object is a folder or not.

IsHidden()()()
Checks if the currently active object is hidden.

IsLink()()()
Checks if the currently active object is a link or shortcut.

IsLinkToFolder()()()
Checks if the currently active object is a link to another folder and returns the path to it.

IsVistaOrLater
Returns true if the system runs the windows vista operating system or better

IsWindows7OrLater
Returns true if the system runs the windows 7 operating system or better

IsXpOrLater
Returns true if the system runs the windows xp operating system or better

ItemIdList
This property should only be used by advanced users. It returns a copy of the ItemIdList of the current object. Important: The returned ItemIdList has to be freed using CoTaskMemFree when it is not needed any more.

MatchPattern(String, String)
Returns true if the given string matched the wild card pattern

MAX_COLUMNS
Max number of columns.

MemberwiseClone(Boolean)
Creates a shallow copy of the current MarshalByRefObject object.
(Inherited from MarshalByRefObject.)
MemberwiseClone()()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
MultiObjects
Full path of one or more file system objects to show the context menu or invoke context menu commands for multiple files or folders.

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.

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 Path and SpecialFolder

OnBeforeShellCommand(String)
This method is called to trigger the BeforeShellCommand event.

OnContextMenuItemSelected(String)
Triggers the ContextMenuItemSelect event.

OnRenameItemSelected()()()
Fires the RenameItemSelected event

ReadOnly
If set to 'true', context menu operations that make changes to the file system will not be executed.

RenameItemSelected
This event is fired when the context menu option "Rename" is selected.

RenameObject(String)
Renames the current object.

Reset()()()
Resets the enumeration of the items in the active folder. It can be started again using Next()()()

SelectedIconNumber
Use SelectedIconNumber to get the number of the 'opened' icon for the current object.

SelectParent()()()
Moves up to the parent of the current shell object

ShowContextMenu(Point, ContextMenuStrip)
shows the shell context menu for the active object or, if not empty, to the obejcts in the MultiObjects property.

ShowContextMenu(Point, Menu)
shows the shell context menu for the active object or, if not empty, to the objects in the MultiObjects property.

ShowErrorMessages
If set to to 'true', error messages will be shown to the user. If set to 'false', error messages will be suppressed.

Site
Gets or sets the ISite of the Component.
(Inherited from Component.)
SpecialFolder
Get or set a special folder as the currently active folder

SpecialObject
Get or set a special object as the currently active object

ToString()()()
Returns a String containing the name of the Component, if any. This method should not be overridden.
(Inherited from Component.)
Inheritance Hierarchy

Assembly: ShellBrowser (Module: ShellBrowser) Version: 4.2.1.45 (4.2.1.45)