ShellFolderServer Class |
Represents the server that will provide information to the Windows Shell, though the CBFS Shell native proxy DLL.
This class must be running for the corresponding Shell Folder to work and be visible in the Windows Explorer.
Inheritance HierarchyNamespace: callback.ShellBoost.Core
Assembly: callback.CBFSShell (in callback.CBFSShell.dll) Version: 22.0.0.0
SyntaxC#
public abstract class ShellFolderServer : IDisposable
The ShellFolderServer type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ShellFolderServer |
Initializes a new instance of the ShellFolderServer class.
|
Properties| Name | Description | |
|---|---|---|
  | Attributes |
Gets the Shell Namespace Extension root attributes for the default native proxy.
Don't use this member if you are hosting multiple CBFS Shell native proxies, but use the NativeProxy instance member instead.
|
| BuildConfiguration |
Gets the Shell Namespace Extension build configuration for the default native proxy.
Don't use this member if you are hosting multiple CBFS Shell native proxies, but use the NativeProxy instance member instead.
|
 | Cache |
Gets the cache by PIDL instance.
|
| Configuration |
Gets or sets the configuration.
|
| ContextMenuId |
Gets the CBFS Shell context menu identifier for the default native proxy.
Don't use this member if you are hosting multiple CBFS Shell native proxies, but use the NativeProxy instance member instead.
|
| DefaultFolderInitializationOptions |
Gets or sets the default folder initialization options.
|
| DisplayName |
Gets the Shell Namespace Extension display name for the default native proxy.
Don't use this member if you are hosting multiple CBFS Shell native proxies, but use the NativeProxy instance member instead.
|
| FolderId |
Gets the Shell Namespace Extension folder identifier for the default native proxy.
Don't use this member if you are hosting multiple CBFS Shell native proxies, but use the NativeProxy instance member instead.
|
| FolderParsingName |
Gets the Shell Namespace Extension folder absolute parsing path for the default native proxy.
Don't use this member if you are hosting multiple CBFS Shell native proxies, but use the NativeProxy instance member instead.
|
| GenericHandlerId |
Gets the CBFS Shell generic handler identifier for the default native proxy.
Don't use this member if you are hosting multiple CBFS Shell native proxies, but use the NativeProxy instance member instead.
|
| InterfaceId |
Gets the CBFS Shell IPC interface identifier for the default native proxy.
Don't use this member if you are hosting multiple CBFS Shell native proxies, but use the NativeProxy instance member instead.
|
| IpcErrorText |
Gets the Shell Namespace Extension error text for the default native proxy.
Don't use this member if you are hosting multiple CBFS Shell native proxies, but use the NativeProxy instance member instead.
|
| IsCacheEnabled |
Gets or sets a value indicating whether the IPC cache is enabled.
If set to false, the cache will be cleared.
|
| IsDisposed |
Gets a value indicating whether this instance is disposed.
|
| IsImpersonatingClient |
Gets a value indicating if CBFS Shell is configured to impersonate the Windows Shell user for the default native proxy.
Don't use this member if you are hosting multiple CBFS Shell native proxies, but use the NativeProxy instance member instead.
|
| LastProxyCacheCount |
Gets the last proxy cache count.
|
| LibId |
Gets the CBFS Shell library identifier for the default native proxy.
Don't use this member if you are hosting multiple CBFS Shell native proxies, but use the NativeProxy instance member instead.
|
| LicenseDataIsValid |
Gets a value indicating whether license data is valid for the default native proxy
Don't use this member if you are hosting multiple CBFS Shell native proxies, but use the NativeProxy instance member instead.
|
| LicenseHasExpired |
Gets a value indicating whether license has expired for the default native proxy
Don't use this member if you are hosting multiple CBFS Shell native proxies, but use the NativeProxy instance member instead.
|
| LicenseRegisteredCompany |
Gets the license registered company for the default native proxy.
Don't use this member if you are hosting multiple CBFS Shell native proxies, but use the NativeProxy instance member instead.
|
| LoadedNativeDllPath |
Gets the loaded native DLL path for the default native proxy.
Don't use this member if you are hosting multiple CBFS Shell native proxies, but use the NativeProxy instance member instead.
|
| Location |
Gets the Shell Namespace Extension location for the default native proxy.
Don't use this member if you are hosting multiple CBFS Shell native proxies, but use the NativeProxy instance member instead.
|
| LocationFolderId |
Gets the Shell Namespace Extension location folder identifier for the default native proxy.
Don't use this member if you are hosting multiple CBFS Shell native proxies, but use the NativeProxy instance member instead.
|
| LocationFolderParsingName |
Gets the Shell Namespace Extension location folder absolute parsing path for the default native proxy.
Don't use this member if you are hosting multiple CBFS Shell native proxies, but use the NativeProxy instance member instead.
|
| NativeProxy |
Gets or sets the native proxy instance.
This will be null until the server is started.
|
| ProxyCacheOptions |
Gets or sets the proxy cache options.
|
| ProxyCacheTimeout |
Gets or sets the IPC cache timeout in milliseconds. The maximum value is 65535.
|
| ProxyId |
Gets the CBFS Shell proxy identifier for the default native proxy.
Don't use this member if you are hosting multiple CBFS Shell native proxies, but use the NativeProxy instance member instead.
|
| RefreshButtonText |
Gets the Shell Namespace Extension refresh button text for the default native proxy.
Don't use this member if you are hosting multiple CBFS Shell native proxies, but use the NativeProxy instance member instead.
|
| RootIdList |
Gets the Shell Namespace Extension root PIDL for the default native proxy.
Don't use this member if you are hosting multiple CBFS Shell native proxies, but use the NativeProxy instance member instead.
|
| RootPath |
Gets the Shell Namespace Extension root path for the default native proxy.
Don't use this member if you are hosting multiple CBFS Shell native proxies, but use the NativeProxy instance member instead.
|
| RootPropertyStore |
Gets the root property store.
|
| TraceId |
Gets the CBFS Shell trace identifier for the default native proxy.
Don't use this member if you are hosting multiple CBFS Shell native proxies, but use the NativeProxy instance member instead.
|
Methods| Name | Description | |
|---|---|---|
| AddToCache |
Adds a Shell Item to the cache.
|
 | ClearProxyCache |
Clears the proxy cache.
|
| CreatePropertyStore |
Creates the property store instance.
|
| Dispose |
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
|
| Dispose(Boolean) |
Releases unmanaged and - optionally - managed resources.
|
| EnumerateItems |
Enumerates Shell Items from a Shell Folder instance.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize |
Finalizes an instance of the ShellFolderServer class.
(Overrides ObjectFinalize.) |
| GetFolder |
Gets a Shell Folder using its PIDL.
|
| GetFolderAsRoot |
Gets the root folder.
|
| GetFromCache |
Gets a Shell Item from the cache using its PIDL.
|
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetItem |
Gets a Shell Item using its PIDL.
|
| GetItemIconLocation |
Gets an icon location for a Shell Item.
|
| GetRootFolder |
Gets the root folder.
Note this method has been superseded by GetFolderAsRoot that avoids a dead-end specialization of the ShellFolder class.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| Log |
Logs the value with a specified trace level. This method does nothing by default and must be overriden.
|
| LogInfo |
Logs the value as an information.
|
| LogNotFound |
Called when a pidl was not found.
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| OnDragDropTarget |
Called when a drag and drop event occurs.
|
| OnFolderInit |
Called when a ShellFolder is initialized by the Windows Shell.
|
| OnNotify |
Called when a notification is sent by Windows Explorer.
|
| PreviewOnNotify |
Called when a notification is sent by Windows Explorer, before the OnNotify method.
|
| RemoveFromCache |
Removes a Shell Item from the cache using its PIDL.
|
| SelectAndEditItem |
Select and/or edit a Shell Item using its path.
|
| Start |
Starts this instance.
|
| Start(ShellFolderConfiguration) |
Starts this instance with the specified configuration.
|
| Stop |
Stops this instance.
|
| Stop(ServerStopOptions) |
Stops this instance.
|
| StopListening |
Stops all instances of ShellFolderServer from listening.
This should only be used after all instances have stopped listening.
Provided for multiple AppDomains support.
Don't use this member if you are hosting multiple CBFS Shell native proxies, but use the NativeProxy instance member instead.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Trace |
Sends a string value trace using ETW, with the specified level.
The ETW provider guid is given in the TraceId static property of this class.
Don't use this member if you are hosting multiple CBFS Shell native proxies, but use the NativeProxy instance member instead.
|
| TryCompareIdLists |
Compares two PIDls.
This method currently returns false. Comparison is delegated to ShellItem's TryCompare method.
|
| TryConvertForPropVariantWrapping |
Convert a value for PropVariant wrapping.
|
| TryGetRootPropertyValue |
Gets a property key value from the root property store.
|
Events| Name | Description | |
|---|---|---|
 | FolderInit |
Raised when a ShellFolder is initialized by the Windows Shell.
|
| Notify |
Raised when notification are received from the Windows Shell.
|
See Also