ShellUtilities Class |
A set of Windows Shell utilities.
Inheritance HierarchyNamespace: ShellBoost.Core.Utilities
Assembly: ShellBoost.Core (in ShellBoost.Core.dll) Version: 1.8.3.0
SyntaxC#
public static class ShellUtilities
The ShellUtilities type exposes the following members.
Methods| Name | Description | |
|---|---|---|
  | AddToBindCtx |
Adds a name-value pair to an IBindCtx's property bag.
|
| ChangeNotificationLock |
Locks the shared memory associated with a Shell change notification event.
|
| ChangeNotificationUnlock |
Unlocks shared memory for a change notification.
|
| ChangeNotify(SHCNE, SHCNF) |
Notifies the Shell of an event. Wraps Windows Shell's SHChangeNotify function.
|
| ChangeNotify(SHCNE, SHCNF, ShellItemIdList) |
Notifies the Shell of an event. Wraps Windows Shell's SHChangeNotify function.
|
| ChangeNotify(SHCNE, SHCNF, Int32) |
Notifies the Shell of an event. Wraps Windows Shell's SHChangeNotify function.
|
| ChangeNotify(SHCNE, SHCNF, IntPtr) |
Notifies the Shell of an event. Wraps Windows Shell's SHChangeNotify function.
|
| ChangeNotify(SHCNE, SHCNF, String) |
Notifies the Shell of an event. Wraps Windows Shell's SHChangeNotify function.
|
| ChangeNotify(SHCNE, SHCNF, ShellItemIdList, ShellItemIdList) |
Notifies the Shell of an event. Wraps Windows Shell's SHChangeNotify function.
|
| ChangeNotify(SHCNE, SHCNF, Int32, Int32) |
Notifies the Shell of an event. Wraps Windows Shell's SHChangeNotify function.
|
| ChangeNotify(SHCNE, SHCNF, IntPtr, IntPtr) |
Notifies the Shell of an event. Wraps Windows Shell's SHChangeNotify function.
|
| ChangeNotify(SHCNE, SHCNF, String, String) |
Notifies the Shell of an event. Wraps Windows Shell's SHChangeNotify function.
|
| ChangeNotifyAllEvents |
Notifies the Shell of the SHCNE_ALLEVENTS event. Wraps Windows Shell's SHChangeNotify function.
|
| ChangeNotifyAssocChanged |
Notifies the Shell of the SHCNE_ASSOCCHANGED event. Wraps Windows Shell's SHChangeNotify function.
|
| ChangeNotifyDeregister |
Unregisters the client's window process from receiving ChangeNotify messages.
|
| ChangeNotifyRegister |
Registers a window to receive notifications from the file system or Shell, if the file system supports notifications.
|
| ClearViewStatePropertyBag(IntPtr, String, Boolean) |
Clears a property bag in which the view state information for a folder was stored.
Note this method requires a STA thread to work.
|
| ClearViewStatePropertyBag(IWithIdList, String, Boolean) |
Clears a property bag in which the view state information for a folder was stored.
Note this method requires a STA thread to work.
|
| CoAllowSetForegroundWindow |
Passes the foreground privilege (the privilege to set the foreground window) from one process to another. Wraps Windows' CoAllowSetForegroundWindow function.
|
| CreateBindCtx(NullableSTGM, Boolean) |
Returns an implementation of IBindCtx (a bind context object). This object stores information about a particular moniker-binding operation.
|
| CreateBindCtx(FileMode, FileAccess, FileShare, Boolean) |
Returns an implementation of IBindCtx (a bind context object). This object stores information about a particular moniker-binding operation.
|
| CreateBindCtx(String, NullableSTGM, NullableInt64, NullableFileAttributes, NullableDateTime, NullableDateTime, NullableDateTime, Boolean) |
Returns an implementation of IBindCtx (a bind context object) that doesn't need a an existing Shell Item for binding operations.
Pass STGM_CREATE for mode parameter to create an item that doesn't necessarily exist.
|
| CreateDataObject(IEnumerableShellItemIdList, Boolean) |
Creates a data object from a list of pidls.
|
| CreateDataObject(IEnumerableIntPtr, Boolean) |
Creates a data object from a list of pidls.
|
| CreateDataObject(IEnumerableString, Boolean) |
Creates a data object from a list of paths.
|
| CreateDataObject(IntPtr, Boolean) |
Creates a data object from a pidl.
|
| CreateDataObject(ShellItemIdList, Boolean) |
Creates a data object from a pidl.
|
| CreateDataObject(String, Boolean) |
Creates a data object from a path.
|
| CreateInstance(Guid, Guid, CLSCTX, Boolean) |
Creates an instance of a COM object.
|
| CreateInstanceT(Guid, CLSCTX, Boolean) |
Creates an instance of a COM object.
|
| CreateMemoryStream |
Creates a native memory stream using the SHCreateMemStream API.
|
| CreateNativeMemoryStream |
Creates a native memory stream using the SHCreateMemStream native API.
|
| DestroyIcon |
Destroys an icon and frees any memory the icon occupied.
|
| EnsureBindCtxPropertyBag(IBindCtx, Boolean) |
Ensures an IBindCtx has a property bag.
|
| EnsureBindCtxPropertyBag(IBindCtx, Object, Boolean) |
Ensures an IBindCtx has a property bag.
|
| EnumerateItems(ShellItemIdList, Boolean) |
Enumerates child items of a given shell item.
|
| EnumerateItems(String, Boolean) |
Enumerates child items of a given shell item.
|
| ExtractIcon |
Extracts an icon from a file (.ico, .exe, etc.)
|
| ExtractIconsCount |
Extracts the count of icons from a file (.ico, .exe, etc.)
|
| ExtractMenu(IntPtr, Boolean) |
Extracts a Windows menu information.
|
| ExtractMenu(String, Boolean) |
Extracts all menu items from a shell item's context menu.
|
| ExtractMenu(String, ActionShellMenuItem, ShellMenuItem, Boolean) |
Runs an action on all menu items from a shell item's context menu.
|
| ExtractNewMenu(Boolean, Boolean) |
Extracts information from the Windows Shell 'New' menu. Uses the TEMP directory to build the content of the 'New' menu.
|
| ExtractNewMenu(ShellItemIdList, Boolean, Boolean) |
Extracts information from the Windows Shell 'New' menu.
|
| ExtractNewMenu(String, Boolean, Boolean) |
Extracts information from the Windows Shell 'New' menu.
|
| FormatByteSize |
Converts a numeric value into a string that represents the number expressed as a size value in bytes, kilobytes, megabytes, or gigabytes, depending on the size.
|
| FromAttributes |
Converts file attributes to SFGAO.
|
| GetApartmentState |
Determines the state of the current thread's COM apartment
|
| GetBindOptions(IBindCtx, BIND_OPTS2, Boolean) |
Returns the current binding options stored in a bind context.
|
| GetBindOptions(IBindCtx, BIND_OPTS3, Boolean) |
Returns the current binding options stored in a bind context.
|
| GetFileSystemPath |
Gets a corresponding file system path for a given PIDL.
|
| GetFolderLocation |
Gets a known folder location as a PIDL.
|
| GetIconHandle |
Gets an icon handle from a file path.
|
| GetIconHandleFromSystemImageList |
Gets an icon handle from the system image list.
|
| GetIconLocation(String, String, Int32) |
Gets the icon location from a shell item path.
|
| GetIconLocation(String, IBindCtx, GILIN, String, Int32, GILOUT) |
Gets the icon location from a shell item path.
|
| GetIconLocationFromExtension(String, String, Int32) |
Gets the icon location path and index from an extension.
|
| GetIconLocationFromExtension(String, IconMode, String, Int32) |
Gets the icon location path and index from a file extension.
|
| GetIdList(String, IBindCtx, Boolean) |
Gets the PIDL from a path.
|
| GetIdList(String, SFGAO, IBindCtx, Boolean) |
Gets the PIDL from a path.
|
| GetImage(IntPtr, Size, SIIGBF, Boolean) |
Gets a bitmap that represents a Shell Item.
The default behavior is to load a thumbnail. If there is no thumbnail for the current IShellItem, it retrieves an HBITMAP for the icon of the item. The thumbnail or icon is extracted if it is not currently cached.
|
| GetImage(IWithIdList, Size, SIIGBF, Boolean) |
Gets a bitmap that represents a Shell Item.
The default behavior is to load a thumbnail. If there is no thumbnail for the current IShellItem, it retrieves an HBITMAP for the icon of the item. The thumbnail or icon is extracted if it is not currently cached.
|
| GetImageForExtension |
Gets a bitmap that represents an extension.
|
| GetImageHandle(IntPtr, Size, SIIGBF, Boolean) |
Gets an HBITMAP handle that represents a Shell Item.
The default behavior is to load a thumbnail. If there is no thumbnail for the current IShellItem, it retrieves an HBITMAP for the icon of the item. The thumbnail or icon is extracted if it is not currently cached.
|
| GetImageHandle(IWithIdList, Size, SIIGBF, Boolean) |
Gets an HBITMAP handle that represents a Shell Item.
The default behavior is to load a thumbnail. If there is no thumbnail for the current IShellItem, it retrieves an HBITMAP for the icon of the item. The thumbnail or icon is extracted if it is not currently cached.
|
| GetKinds |
Gets the available shell kinds for a given file extension.
|
| GetName |
Gets the name of a shell item from its PIDL.
|
| GetPath |
Gets the path of a PIDL.
|
| GetPerceivedType(String) |
Gets the perceived type for a given file extension.
|
| GetPerceivedType(String, PERCEIVEDFLAG) |
Gets the perceived type for a given file extension.
|
| GetPerceivedType(String, String) |
Gets the perceived type for a given file extension.
|
| GetPerceivedType(String, PERCEIVEDFLAG, String) |
Gets the perceived type for a given file extension.
|
| GetStorageMode |
Gets COM storage mode from .NET constants.
|
| GetViewStatePropertyBagValue(IntPtr, String, String, SHGVSPB) |
Retrieves a property bag in which the view state information for a folder can be stored and subsequently retrieved and get a value by its name from it.
The user's settings are kept for the next time the user visits the folder.
|
| GetViewStatePropertyBagValue(IWithIdList, String, String, SHGVSPB) |
Retrieves a property bag in which the view state information for a folder can be stored and subsequently retrieved and get a value by its name from it.
The user's settings are kept for the next time the user visits the folder.
|
| InvokeMenuItem(String, FuncShellMenuItem, Boolean) |
Invokes a shell item's context menu item.
|
| InvokeMenuItem(String, IntPtr, FuncShellMenuItem, Boolean, Boolean) |
Invokes a shell item's context menu item.
|
| LoadIndirectString |
Extracts a specified text resource when given that resource in the form of an indirect string (a string that begins with the '@' symbol).
|
| NoStrCmpLogical |
If true, the system administrator has specified that filenames should be sorted with the StringCompare function instead of the StrCmpLogical function.
Applications that sort filenames should sort accordingly.
|
| OleInitialize |
Initializes the COM library on the current apartment, identifies the concurrency model as single-thread apartment (STA), and enables additional functionality such as Clipboard or Drag & Drop operations.
|
| OpenPropertySheet(IEnumerableShellItemIdList, String, Boolean) |
Opens the property sheet from a list of pidls.
|
| OpenPropertySheet(IEnumerableIntPtr, String, Boolean) |
Opens the property sheet from a list of pidls.
|
| OpenPropertySheet(IEnumerableString, String, Boolean) |
Opens the property sheet from a list of paths.
|
| OpenPropertySheet(IntPtr, String, Boolean) |
Opens the property sheet from a pidl.
|
| OpenPropertySheet(ShellItemIdList, String, Boolean) |
Opens the property sheet from a pidl.
|
| OpenPropertySheet(String, String, Boolean) |
Opens the property sheet from a path.
|
| OpenPropertySheet(IDataObject, String, IEnumerableIntPtr, NullableGuid, String) |
Opens the property sheet from a data object.
|
| ParseIconLocationPath |
Parses an icon location string to extract the icon file path and the icon index.
|
| RefreshShellViews |
Refreshes all Windows Shell views.
|
| ResetThumbnails |
Resets all Windows Shell thumbnails and wait for completion.
|
| ResetThumbnails(Boolean) |
Resets all Windows Shell thumbnails.
|
| SetAccessibleName |
Sets text that is retrieved by accessibility tools to obtain the Name Property of an object.
|
| SetBindOptions(IBindCtx, BIND_OPTS2, Boolean) |
Stores a block of parameters in a bind context. These parameters will apply to later UCOMIMoniker operations that use this bind context.
|
| SetBindOptions(IBindCtx, BIND_OPTS3, Boolean) |
Stores a block of parameters in a bind context. These parameters will apply to later UCOMIMoniker operations that use this bind context.
|
| SetViewStatePropertyBagValue(IntPtr, String, String, Object, SHGVSPB, Boolean) |
Retrieves a property bag in which the view state information for a folder can be stored and subsequently retrieved and write a value by its name to it.
The user's settings are kept for the next time the user visits the folder.
Note this method requires a STA thread to work.
|
| SetViewStatePropertyBagValue(IWithIdList, String, String, Object, SHGVSPB, Boolean) |
Retrieves a property bag in which the view state information for a folder can be stored and subsequently retrieved and write a value by its name to it.
The user's settings are kept for the next time the user visits the folder.
Note this method requires a STA thread to work.
|
| ShellStringCompare |
Compares two strings.
This test is not case-sensitive.
Depending on machine's configuration, the comparison can be using the StrCmpLogicalW (the default) or the StrCmpI native function.
|
| StringCompareLogical |
Compares two strings.
Digits in the strings are considered as numerical content rather than text.
This test is not case-sensitive.
|
| WithSite(Object, Object, Action, Boolean) |
Runs an action.
If the sited object implements IObjectWithSite, the site object will be set before the action and unset after the action.
|
| WithSiteT(Object, Object, FuncT, Boolean) |
Runs an function.
If the sited object implements IObjectWithSite, the site object will be set before the function and unset after the function.
|
Fields| Name | Description | |
|---|---|---|
 | E_ACCESSDENIED |
The Windows E_ACCESSDENIED error value (0x80070005).
|
| E_ALREADY_EXISTS |
The Windows E_ALREADY_EXISTS error value (0x800700B7).
|
| E_CANCELLED |
The Windows E_CANCELLED error value (0x800704C7).
|
| E_FAIL |
The Windows E_FAIL error value (0x80004005).
|
| E_FILE_NOT_FOUND |
The Windows E_FILE_NOT_FOUND error value (0x80070002).
|
| E_INVALIDARG |
The Windows E_INVALIDARG error value (0x80070057).
|
| E_NOINTERFACE |
The Windows E_NOINTERFACE error value (0x80004002).
|
| E_NOTFOUND |
The Windows E_NOTFOUND error value (0x80070490).
|
| E_NOTIMPL |
The Windows E_NOTIMPL error value (0x80004001).
|
| E_OUTOFMEMORY |
The Windows E_OUTOFMEMORY error value (0x8007000E).
|
| E_PATH_NOT_FOUND |
The Windows E_PATH_NOT_FOUND error value (0x80070003).
|
| E_PENDING |
The Windows E_PENDING error value (0x8000000A).
|
| ERROR_MORE_DATA |
The Windows ERROR_MORE_DATA error value (0x800700EA).
|
| ERROR_NOT_SUPPORTED |
The Windows ERROR_NOT_SUPPORTED error value (0x80070032).
|
| ERROR_RETRY |
The Windows ERROR_RETRY error value (0x800704D5).
|
| IID_IDispatch |
The IDispatch IID (00020400-0000-0000-c000-000000000046).
|
| IID_IInspectable |
The IInspectable IID (af86e2e0-b12d-4c6a-9c5a-d7aa65101e90).
|
| IID_IUnknown |
The IUnknown IID (00000000-0000-0000-c000-000000000046).
|
| S_FALSE |
The Windows S_FALSE value (1).
|
| S_OK |
The Windows S_OK value (0).
|
| STG_E_ACCESSDENIED |
The Windows STG_E_ACCESSDENIED error value (0x80030005).
|
See Also