Click or drag to resize

ShellFolderServer Class

Represents the server that will provide information to the Windows Shell, though the ShellBoost native proxy assembly. This class must be running for the corresponding Shell Folder to work and be visible in the Windows Explorer.
Inheritance Hierarchy
SystemObject
  ShellBoost.CoreShellFolderServer

Namespace:  ShellBoost.Core
Assembly:  ShellBoost.Core (in ShellBoost.Core.dll) Version: 1.8.3.0
Syntax
C#
public abstract class ShellFolderServer : IDisposable

The ShellFolderServer type exposes the following members.

Constructors
  NameDescription
Protected methodShellFolderServer
Initializes a new instance of the ShellFolderServer class.
Top
Properties
  NameDescription
Public propertyStatic memberAttributes
Gets the Shell Namespace Extension root attributes for the default native proxy. Don't use this member if you are hosting multiple ShellBoost native proxies, but use the NativeProxy instance member instead.
Public propertyStatic memberBuildConfiguration
Gets the Shell Namespace Extension build configuration for the default native proxy. Don't use this member if you are hosting multiple ShellBoost native proxies, but use the NativeProxy instance member instead.
Protected propertyCache
Gets the cache by PIDL instance.
Public propertyConfiguration
Gets or sets the configuration.
Public propertyStatic memberContextMenuId
Gets the ShellBoost context menu identifier for the default native proxy. Don't use this member if you are hosting multiple ShellBoost native proxies, but use the NativeProxy instance member instead.
Public propertyStatic memberDefaultFolderInitializationOptions
Gets or sets the default folder initialization options.
Public propertyStatic memberDisplayName
Gets the Shell Namespace Extension display name for the default native proxy. Don't use this member if you are hosting multiple ShellBoost native proxies, but use the NativeProxy instance member instead.
Public propertyStatic memberFolderId
Gets the Shell Namespace Extension folder identifier for the default native proxy. Don't use this member if you are hosting multiple ShellBoost native proxies, but use the NativeProxy instance member instead.
Public propertyStatic memberFolderParsingName
Gets the Shell Namespace Extension folder absolute parsing path for the default native proxy. Don't use this member if you are hosting multiple ShellBoost native proxies, but use the NativeProxy instance member instead.
Public propertyStatic memberGenericHandlerId
Gets the ShellBoost generic handler identifier for the default native proxy. Don't use this member if you are hosting multiple ShellBoost native proxies, but use the NativeProxy instance member instead.
Public propertyStatic memberInterfaceId
Gets the ShellBoost IPC interface identifier for the default native proxy. Don't use this member if you are hosting multiple ShellBoost native proxies, but use the NativeProxy instance member instead.
Public propertyStatic memberIpcErrorText
Gets the Shell Namespace Extension error text for the default native proxy. Don't use this member if you are hosting multiple ShellBoost native proxies, but use the NativeProxy instance member instead.
Protected propertyIsCacheEnabled
Gets or sets a value indicating whether the IPC cache is enabled. If set to false, the cache will be cleared.
Public propertyIsDisposed
Gets a value indicating whether this instance is disposed.
Public propertyStatic memberIsImpersonatingClient
Gets a value indicating if ShellBoost is configured to impersonate the Windows Shell user for the default native proxy. Don't use this member if you are hosting multiple ShellBoost native proxies, but use the NativeProxy instance member instead.
Public propertyLastProxyCacheCount
Gets the last proxy cache count.
Public propertyStatic memberLibId
Gets the ShellBoost library identifier for the default native proxy. Don't use this member if you are hosting multiple ShellBoost native proxies, but use the NativeProxy instance member instead.
Public propertyStatic memberLicenseDataIsValid
Gets a value indicating whether license data is valid for the default native proxy Don't use this member if you are hosting multiple ShellBoost native proxies, but use the NativeProxy instance member instead.
Public propertyStatic memberLicenseExpirationDate
Gets the license expiration date for the default native proxy. Don't use this member if you are hosting multiple ShellBoost native proxies, but use the NativeProxy instance member instead.
Public propertyStatic memberLicenseHasExpired
Gets a value indicating whether license has expired for the default native proxy Don't use this member if you are hosting multiple ShellBoost native proxies, but use the NativeProxy instance member instead.
Public propertyStatic memberLicenseRegisteredCompany
Gets the license registered company for the default native proxy. Don't use this member if you are hosting multiple ShellBoost native proxies, but use the NativeProxy instance member instead.
Public propertyStatic memberLoadedNativeDllPath
Gets the loaded native DLL path for the default native proxy. Don't use this member if you are hosting multiple ShellBoost native proxies, but use the NativeProxy instance member instead.
Public propertyStatic memberLocation
Gets the Shell Namespace Extension location for the default native proxy. Don't use this member if you are hosting multiple ShellBoost native proxies, but use the NativeProxy instance member instead.
Public propertyStatic memberLocationFolderId
Gets the Shell Namespace Extension location folder identifier for the default native proxy. Don't use this member if you are hosting multiple ShellBoost native proxies, but use the NativeProxy instance member instead.
Public propertyStatic memberLocationFolderParsingName
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 ShellBoost native proxies, but use the NativeProxy instance member instead.
Public propertyNativeProxy
Gets or sets the native proxy instance. This will be null until the server is started.
Public propertyStatic memberOptions
Gets Shell Namespace Extension options for the default native proxy. Don't use this member if you are hosting multiple ShellBoost native proxies, but use the NativeProxy instance member instead.
Public propertyStatic memberProgId
Gets the Shell Namespace Extension ProgID for the default native proxy. Don't use this member if you are hosting multiple ShellBoost native proxies, but use the NativeProxy instance member instead.
Public propertyProxyCacheOptions
Gets or sets the proxy cache options.
Public propertyProxyCacheTimeout
Gets or sets the IPC cache timeout in milliseconds. The maximum value is 65535.
Public propertyStatic memberProxyId
Gets the ShellBoost proxy identifier for the default native proxy. Don't use this member if you are hosting multiple ShellBoost native proxies, but use the NativeProxy instance member instead.
Public propertyStatic memberRefreshButtonText
Gets the Shell Namespace Extension refresh button text for the default native proxy. Don't use this member if you are hosting multiple ShellBoost native proxies, but use the NativeProxy instance member instead.
Public propertyStatic memberRootIdList
Gets the Shell Namespace Extension root PIDL for the default native proxy. Don't use this member if you are hosting multiple ShellBoost native proxies, but use the NativeProxy instance member instead.
Public propertyStatic memberRootPath
Gets the Shell Namespace Extension root path for the default native proxy. Don't use this member if you are hosting multiple ShellBoost native proxies, but use the NativeProxy instance member instead.
Protected propertyRootPropertyStore
Gets the root property store.
Public propertyStatic memberTraceId
Gets the ShellBoost trace identifier for the default native proxy. Don't use this member if you are hosting multiple ShellBoost native proxies, but use the NativeProxy instance member instead.
Top
Methods
  NameDescription
Protected methodAddToCache
Adds a Shell Item to the cache.
Public methodClearProxyCache
Clears the proxy cache.
Protected methodCreatePropertyStore
Creates the property store instance.
Public methodDispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Protected methodDispose(Boolean)
Releases unmanaged and - optionally - managed resources.
Public methodStatic memberEnumerateItems
Enumerates Shell Items from a Shell Folder instance.
Protected methodFinalize
Finalizes an instance of the ShellFolderServer class.
(Overrides ObjectFinalize.)
Protected methodGetFolder
Gets a Shell Folder using its PIDL.
Protected methodGetFolderAsRoot
Gets the root folder.
Protected methodGetFromCache
Gets a Shell Item from the cache using its PIDL.
Protected methodGetItem
Gets a Shell Item using its PIDL.
Protected methodGetItemIconLocation
Gets an icon location for a Shell Item.
Protected methodGetRootFolder
Gets the root folder. Note this method has been superseded by GetFolderAsRoot that avoids a dead-end specialization of the ShellFolder class.
Protected methodLog
Logs the value with a specified trace level. This method does nothing by default and must be overriden.
Protected methodLogInfo
Logs the value as an information.
Protected methodLogNotFound
Called when a pidl was not found.
Protected methodOnDragDropTarget
Called when a drag and drop event occurs.
Protected methodOnFolderInit
Called when a ShellFolder is initialized by the Windows Shell.
Protected methodOnLicensing
Handles the Licensing event.
Protected methodOnNotify
Called when a notification is sent by Windows Explorer.
Protected methodPreviewOnNotify
Called when a notification is sent by Windows Explorer, before the OnNotify method.
Public methodStatic memberRegisterNativeDll(RegistrationMode)
Registers the ShellBoost native proxy assembly. Don't use this member if you are hosting multiple ShellBoost native proxies, but use the NativeProxy instance member instead.
Public methodStatic memberRegisterNativeDll(ShellFolderRegistration)
Registers the ShellBoost native proxy assembly. Don't use this member if you are hosting multiple ShellBoost native proxies, but use the NativeProxy instance member instead.
Protected methodRemoveFromCache
Removes a Shell Item from the cache using its PIDL.
Protected methodSelectAndEditItem
Select and/or edit a Shell Item using its path.
Public methodStart
Starts this instance.
Public methodStart(ShellFolderConfiguration)
Starts this instance with the specified configuration.
Public methodStop
Stops this instance.
Public methodStop(ServerStopOptions)
Stops this instance.
Public methodStatic memberStopListening
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 ShellBoost native proxies, but use the NativeProxy instance member instead.
Public methodStatic memberTrace
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 ShellBoost native proxies, but use the NativeProxy instance member instead.
Protected methodTryCompareIdLists
Compares two PIDls. This method currently returns false. Comparison is delegated to ShellItem's TryCompare method.
Protected methodTryConvertForPropVariantWrapping
Convert a value for PropVariant wrapping.
Public methodTryGetRootPropertyValue
Gets a property key value from the root property store.
Public methodStatic memberUnregisterNativeDll
Unregisters the ShellBoost native proxy assembly. Don't use this member if you are hosting multiple ShellBoost native proxies, but use the NativeProxy instance member instead.
Top
Events
  NameDescription
Public eventFolderInit
Raised when a ShellFolder is initialized by the Windows Shell.
Public eventLicensing
Raised when licensing is computed.
Public eventNotify
Raised when notification are received from the Windows Shell.
Top
See Also