ShellFolder Class

Represents a Windows Shell Folder.

Inheritance Hierarchy

SystemObject
  callback.ShellBoost.CoreShellItem
    callback.ShellBoost.CoreShellFolder
      callback.ShellBoost.CoreRootShellFolder

Namespace: callback.ShellBoost.Core
Assembly: callback.CBFSShell (in callback.CBFSShell.dll) Version: 22.0.0.0

Syntax

Copy

public class ShellFolder : ShellItem

The ShellFolder type exposes the following members.

Constructors

	Name	Description
	ShellFolder(ShellItemIdList)	Initializes a new instance of the ShellFolder class. This constructor is reserved for root shell folders.
	ShellFolder(ShellFolder, ShellItemId)	Initializes a new instance of the ShellFolder class.
	ShellFolder(ShellFolder, Guid)	Initializes a new instance of the ShellFolder class. This folders's PIDL will be constructed using the parent's root PIDL (instead of the parent pidl) plus the passed in uniqueGuid.
	ShellFolder(ShellFolder, DirectoryInfo)	Initializes a new instance of the ShellFolder class.
	ShellFolder(ShellFolder, ShellItemId, String)	Initializes a new instance of the ShellFolder class.

Top

Properties

	Name	Description
	AddNewMenuTemplatePath	Gets or sets the add 'New' menu template path.
	AssociationElementList	Gets the association element list of this item. (Inherited from ShellItem.)
	Attributes	Gets or sets the System.SFGAOFlags property value. (Inherited from ShellItem.)
	CanBeCached	Gets or sets a value indicating whether this instance can be cached. (Inherited from ShellItem.)
	CanCopy	Gets or sets a value indicating whether this instance can be copied. (Inherited from ShellItem.)
	CanDelete	Gets or sets a value indicating whether this instance can be deleted. (Inherited from ShellItem.)
	CanLink	Gets or sets a value indicating whether this instance supports shortcut creation. (Inherited from ShellItem.)
	CanMove	Gets or sets a value indicating whether this instance can be moved. (Inherited from ShellItem.)
	CanPaste	Gets or sets a value indicating whether this instance supports clipboard paste operations. This property value is the aggregation of CanMove, CanCopy and IsDropTarget values. (Inherited from ShellItem.)
	CanRename	Gets or sets a value indicating whether this instance can be renamed. (Inherited from ShellItem.)
	Columns	Gets this folder's columns.
	DateAccessed	Gets or sets the System.DateAccessed property value. (Inherited from ShellItem.)
	DateCreated	Gets or sets the System.DateCreated property value. (Inherited from ShellItem.)
	DateModified	Gets or sets the System.DateModified property value. (Inherited from ShellItem.)
	DisplayName	Gets or sets the System.ItemNameDisplay property value. (Inherited from ShellItem.)
	FileName	Gets or sets the System.FileName property value. (Inherited from ShellItem.)
	FileSystemPath	Gets or sets the physical file system path. A shell item does not need to have a corresponding file system path. (Inherited from ShellItem.)
	Flags	Gets or sets the folder flags.
	FolderServer	Gets the folder server. Will be automatically set after the folder has been requested by the ShellFolderServer.
	FullDisplayName	Gets this item's display name, that is, including the parent's full display name. The full disply name is also what is used in the Windows Explorer's Address Bar. (Overrides ShellItemFullDisplayName.)
	FullParsingName	Gets this item's parsing name, that is, including the parent's full parsing name. (Overrides ShellItemFullParsingName.)
	HasPropertySheet	Gets or sets a value indicating whether this instance supports the property sheet. (Inherited from ShellItem.)
	Id	Gets this item identifier, which is this item's PIDL last segment. (Inherited from ShellItem.)
	IdList	Gets this item's PIDL. (Inherited from ShellItem.)
	InitializeOptions	Gets or sets the options used when the folder instance is initialized.
	IsDropTarget	Gets or sets a value indicating whether this instance is a drop target. (Inherited from ShellItem.)
	IsFolder	Gets a value indicating whether this instance is a folder. (Inherited from ShellItem.)
	IsHidden	Gets or sets a value indicating whether this instance is hidden. (Inherited from ShellItem.)
	IsPlaceholder	Gets or sets a value indicating whether this instance is a placeholder. (Inherited from ShellItem.)
	IsRoot	Gets a value indicating whether this instance is the root folder.
	ItemType	Gets or sets the System.ItemType property value. (Inherited from ShellItem.)
	KindList	Gets the Windows KIND list of this item. (Inherited from ShellItem.)
	Parent	Gets the parent folder. (Inherited from ShellItem.)
	ParsingName	Gets this item's parsing name. (Inherited from ShellItem.)
	Perceived	Gets the System.PerceivedType property value. (Inherited from ShellItem.)
	PropertyStore	Gets the property store. (Inherited from ShellItem.)
	ReadPropertiesFromShell	Gets or sets a value indicating whether to read properties from shell, if FileSystemPath is not null, when they are not defined by this instance. (Inherited from ShellItem.)
	Root	Gets the root folder.
	Size	Gets or sets the System.Size property value. (Inherited from ShellItem.)
	Thumbnail	Gets or sets this item's thumbnail. (Inherited from ShellItem.)
	ViewMode	Gets or sets the folder view mode.

Top

Methods

	Name	Description
	AddColumn(ShellFolderColumn)	Adds a column to this folder. If a column with the same property key was already present in the Columns collection, it will be replaced.
	AddColumn(PropertyDescription, SHCOLSTATE)	Adds a column, defined as a property, to this folder. If a column with the same property key was already present in the Columns collection, it will be replaced.
	AddColumn(PropertyKey, SHCOLSTATE)	Adds a column, defined as a property key, to this folder. If a column with the same property key was already present in the Columns collection, it will be replaced.
	AddColumn(String, SHCOLSTATE)	Adds a column, using a property key canonical name, to this folder. If a column with the same property key was already present in the Columns collection, it will be replaced.
	AddNewMenuToMenu	Adds the New menu to a menu. It only works if the AddNewMenuTemplatePath value is not null nor empty. If this doesn't work, you can validate the path using Item.FromParsingName() method.
	CommitProperties	Commits the property store. (Inherited from ShellItem.)
	CreateFileSystemFolder(DirectoryInfo)	Creates a file system ShellItem instance for a folder under this folder. The info's full path must a direct child of this full path.
	CreateFileSystemFolder(ShellItemId, String)	Creates a file system ShellItem instance for a folder under this folder. The file system path must a direct child of this full path.
	CreateFileSystemItem(FileInfo)	Creates a file system ShellItem instance for a file under this folder. The info's full path must a direct child of this full path.
	CreateFileSystemItem(FileSystemInfo, ShellItemIdList)	Creates a file system ShellItem or ShellFolder instance for a file system entry. The file system entry path must be a child at any level of this full path.
	CreateFileSystemItem(ShellItemId, String)	Creates a file system ShellItem instance for a file under this folder The file system path must a direct child of this full path.
	CreateInformationBarMenu	Called when ShellBoost asks for an information bar menu. It expects items to be added as children of the menu instance. This implementation does not add any items to the menu instance.
	CreatePropertyStore	Creates the property store instance. (Inherited from ShellItem.)
	EnumerateFileSystemInfos(DirectoryInfo)	Enumerates file system files and folders.
	EnumerateFileSystemInfos(DirectoryInfo, SHCONTF)	Enumerates file system files and folders.
	EnumerateFileSystemInfos(DirectoryInfo, String)	Enumerates file system files and folders.
	EnumerateFileSystemInfos(DirectoryInfo, SHCONTF, String)	Enumerates file system files and folders.
	EnumFileSystemItems	Enumerates File System Shell Items
	EnumItems	Enumerates Shell Items. To maximize performance, the GetItem(ShellItemId) and GetItem(string) methods should be overriden.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	FreezePropertyStore	Freezes the property store. The property store can be frozen when a client asks for the property store as a whole. Overriding this method allows you to add properties to the frozen store. (Inherited from ShellItem.)
	GetContent	Gets the content of this item. (Inherited from ShellItem.)
	GetDefaultDisplayColumn	Gets the index of the default display column. The default implementation returns -1 (unspecified).
	GetDefaultSortedColumn	Gets the index of the default sorted column. The default implementation returns -1 (unspecified).
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetInformationBar	Called when ShellBoost asks for an information bar. This implementation returns null. To be valid, an information bar must have a non empty guid and a non null nor empty message.
	GetItem(ShellItemId)	Gets an item using its identifier. This method should be overriden for direct access as the current implementation uses the EnumItems method.
	GetItem(ShellItemIdList)	Gets a Shell Item using its full PIDL from the root. This method is only supported if this instance is the root folder.
	GetItem(String)	Gets an item using its display name. This method should be overriden for direct access as the current implementation uses the EnumItems method.
	GetItemT(ShellItemIdList)	Gets a typed Shell Item using its full PIDL from the root. This method is only supported if this instance is the root folder.
	GetNullifiedPropertyValue(PropertyKey)	Gets a string property key value. The string will be trimmed and converted to null if its length is 0. (Inherited from ShellItem.)
	GetNullifiedPropertyValue(PropertyKey, String)	Gets a string property key value. The string will be trimmed and converted to the default value if its length is 0. (Inherited from ShellItem.)
	GetNullifiedPropertyValue(PropertyKey, IFormatProvider, String)	Gets a string property key value. The string will be trimmed and converted to the default value if its length is 0. (Inherited from ShellItem.)
	GetPaneState	Gets the Windows Explorer pane state.
	GetPropertyIndex	Gets a property key index from this item's property store. (Inherited from ShellItem.)
	GetPropertyValue(PropertyKey, Object)	Gets a property key value. (Inherited from ShellItem.)
	GetPropertyValueT(PropertyKey, T)	Gets a typed property key value. (Inherited from ShellItem.)
	GetPropertyValueT(PropertyKey, FuncT)	Gets a typed property key value. (Inherited from ShellItem.)
	GetRootFullDisplayName	Gets this item's display name, that is, including the parent's full display name.
	GetRootFullParsingName	Gets this item's display name, that is, including the parent's full display name.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetUri	Gets the URI corresponding to this item. (Inherited from ShellItem.)
	HandleFileSystemSFGAO	Handles flags for File System Shell item. (Inherited from ShellItem.)
	HandleInformationBarMenu	Called when an information bar menu item has been clicked. This implementation does nothing.
	Initialize	Initializes this instance. (Overrides ShellItemInitialize.)
	InitializeFileSystem	Initializes the file system. Called when the FileSystemPath property is set. (Overrides ShellItemInitializeFileSystem.)
	IsPropertyWritable	Determines whether the specified property key value is writable, from this item's property store. (Inherited from ShellItem.)
	MapContextMenuCommand	Maps a context menu command. (Inherited from ShellItem.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	MergeContextMenu	Allows to add items to context menu. (Inherited from ShellItem.)
	MergeContextMenuBottom	Allows to add items to the bottom of the context menu. (Inherited from ShellItem.)
	MergeContextMenuTop	Allows to add items to the top of the context menu. (Inherited from ShellItem.)
	MergeViewMenu	Merges a view menu. (Inherited from ShellItem.)
	ModifyContextMenuFlags	The Shell is calling this method to ask for context menu flags modification. (Inherited from ShellItem.)
	NotifyAttributes	Notifies the Windows Shell that this item attributes have changed. (Inherited from ShellItem.)
	NotifyCreate	Notifies the Windows Shell that this item has been created. (Inherited from ShellItem.)
	NotifyDelete	Notifies the Windows Shell that this item has been deleted. (Inherited from ShellItem.)
	NotifyRename(ShellItemId)	Notifies the Windows Shell that this item has been renamed. (Inherited from ShellItem.)
	NotifyRename(ShellItemIdList)	Notifies the Windows Shell that this item has been renamed. (Inherited from ShellItem.)
	NotifyUpdate	Notifies the Windows Shell that this item has been updated. (Inherited from ShellItem.)
	OnAssociationElementListChanged	Called when the AssociationElementList changes. (Inherited from ShellItem.)
	OnCommandExec	Called when a specified command is executed.
	OnCommandQueryStatus	Called when the status of one or more commands, generated by user interface events, is queried for.
	OnDragDropTarget	Called on drag and drop events. (Inherited from ShellItem.)
	OnFileDialogEvent	Called when a notification is sent by a Dialog Box.
	OnGetDataObjectEvent	Called when a data object is requested for a shell item. This will not be called if OnGetOnDemandDataObjectEvent has set a valid OnDemandDataObject instance.
	OnGetDragDropParametersEvent	Called before a drag & drop operation is executed.
	OnGetDynamicColumnDetailsEvent	Called when the native proxy is asking for a dynamic column details.
	OnGetFileDialogPropertiesEvent	Called for determining what properties to gather for a future file dialog event.
	OnGetFolderSettingsEvent	Called when the native proxy is asking for the current view settings.
	OnGetNameMaxLengthEvent	Called for validating a Shell Item's name.
	OnGetNameValidCharactersEvent	Called for validating a Shell Item's name.
	OnGetOnDemandDataObjectEvent	Called when an on-demand data object is requested for a shell item. If this method is overriden and sets a valid OnDemandDataObject instance, OnGetDataObjectEvent will not be called.
	OnManageColumnsEvent	Called when the native proxy is asking for columns management.
	OnMenuInvoke	Called when a menu is invoked. (Inherited from ShellItem.)
	OnMergingContextMenu	Called when a context menu is merging. Overriding this or one of ShellItems's MergeContextMenuXXX methods is similar but this is recommended to support future enhancements.
	OnOperate	Called when a Shell Operation occurs.
	OnRefresh	Called when the view is refreshed, for example when the end-user presses the F5 key from the list view.
	OnSelectAndEditItemEvent	Called when a shell item has been created with the New menu.
	OnSetFolderServer	Called when the folder server is set.
	ParseItem(String)	Gets an item using its relative path from this folder. The path is a list of display names separated by the '\' character. If path is null or empty, this folder is returned.
	ParseItem(String, ShellItemIdList)	Gets an item using its relative path from this folder. The path is a list of display names separated by the '\' character. If path is null or empty, this folder is returned.
	RefreshShellViews	Refreshes all shell views. (Inherited from ShellItem.)
	RefreshShellViews(RefreshViewsOptions)	Refreshes the shell views with options. (Inherited from ShellItem.)
	RemoveAllColumns	Removes all columns.
	RemoveColumn(PropertyKey)	Removes a column using the related property's key.
	RemoveColumn(ShellFolderColumn)	Removes a column.
	RemoveColumn(String)	Removes a column using the related property's canonical name.
	ResetShellThumbnail	Resets the Windows Explorer thumbnail cache. (Inherited from ShellItem.)
	SetPropertyValue(PropertyDescription, Object)	Sets a property value to this item's property store. (Inherited from ShellItem.)
	SetPropertyValue(PropertyKey, Object)	Sets a property key value to this item's property store. (Inherited from ShellItem.)
	ShowDefaultContextMenu	Determines if the default context menu should be shown. (Inherited from ShellItem.)
	ToString	Returns a String that represents this instance. (Inherited from ShellItem.)
	TryCompare(ShellItem, ShellFolderColumn, CompareIdReturnValue)	Compares this instance column with another. (Inherited from ShellItem.)
	TryCompare(ShellItem, SHCIDS, CompareIdReturnValue)	Compares this instance with another. (Inherited from ShellItem.)
	TryCompareAllFields	Compares this instance all columns with another. (Inherited from ShellItem.)
	TryGetAttributes	Gets the attributes for a PIDL that may not represent an existing Shell Item. This method is only implemented for file system Shell Items with PIDLs created from the ShellItemIdList.FromFileSystem method. If you override it, make sure you also override TryParseItem, TryGetDisplayName and TryGetPropertyValue in a consistent manner.
	TryGetContent	Gets the content of this item. (Inherited from ShellItem.)
	TryGetDisplayName	Gets the display name for a PIDL that may not represent an existing Shell Item. This method is only implemented for file system Shell Items with PIDLs created from the ShellItemIdList.FromFileSystem method. If you override it, make sure you also override TryParseItem, TryGetAttributes and TryGetPropertyValue in a consistent manner.
	TryGetFileSystemValue	Gets a property key value in the case of a File System Shell item. (Inherited from ShellItem.)
	TryGetPropertyAt	Gets the property key at a given index, from this item's property store. (Inherited from ShellItem.)
	TryGetPropertyValue(PropertyKey, Object)	Gets a property key value. (Inherited from ShellItem.)
	TryGetPropertyValue(ShellItemIdList, PropertyKey, Object)	Gets a property key value. or a PIDL that may not represent an existing Shell Item. This method returns false. If you override it, make sure you also override TryParseItem and TryGetDisplayName and TryGetAttributesin a consistent manner.
	TryGetPropertyValueT(PropertyKey, T, IFormatProvider)	Gets a property key value and convert it to the expected type if needed. (Inherited from ShellItem.)
	TryParseItem	Parses a display name for a Shell Item that may not exist. This method is only implemented for file system Shell Items. It will use the CreateFileSystemItem and CreateFileSystemFolder that you can override if you want it to use your derived classes instead. If you override it, make sure you also override TryGetDisplayName, TryGetAttributes and TryGetPropertyValue in a consistent manner.
	UnmergeViewMenu	Unmerges the view menu. (Inherited from ShellItem.)

Top

Events

	Name	Description
	CommandExec	Occurs when a specified command is executed.
	CommandQueryStatus	Occurs when the status of one or more commands, generated by user interface events, is queried for.
	FileDialogEvent	Raised when event are received from a Dialog Box.
	GetDataObject	Raised when a data object for a Shell Item is requested.
	GetDragDropParameters	Raised when a Shell Item is preparing a drag & drop operation.
	GetDynamicColumnDetails	Raised when the shell asks for a dynamic column details.
	GetFileDialogProperties	Raised to determine what properties to gather for a future file dialog event.
	GetFolderSettings	Raised when a shell view window has been created.
	GetNameMaxLength	Raised to validate a Shell Item name.
	GetNameValidCharacters	Raised to validate a Shell Item name.
	GetOnDemandDataObject	Raised when an on-demand data object for a Shell Item is requested.
	ManageColumns	Raised when a shell view window has been created.
	MergingContextMenu	Raised when a context menu is merging.
	Refresh	Raised when the view is refreshed, for example when the end-user presses the F5 key from the list view.
	SelectAndEditItem	Raised when a Shell Item has been created with the New menu.

Top

Fields

	Name	Description
	DefaultFolderAttributes	The default folder attributes.

Top

Reference

callback.ShellBoost.Core Namespace

CBFS Shell 2022 .NET Edition

ShellFolder Class

Reference