ShellObjectWrapper Class
Provides an abstract base class that wraps another IShellObject implementation, allowing for easy customization.
public abstract class ShellObjectWrapper : ShellObjectBase, IShellObject, IDisposable
- Inheritance:
- object DisposableObjectBase ShellObjectBase object
- Implements:
- IShellObject IDisposable
Constructors
ShellObjectWrapper(IShellService, IShellObject)
Initializes an instance of the class.
protected ShellObjectWrapper(IShellService shellService, IShellObject wrappedShellObject)
| Parameter | Type | Description |
|---|---|---|
| shellService | IShellService | The IShellService used to return this shell object's children. |
| wrappedShellObject | IShellObject | The IShellObject to be wrapped by this class. |
Properties
AreChildrenLoaded
Indicates whether the Children collection is loaded.
public override bool AreChildrenLoaded { get; }
Property Value
Remarks
Since the Children collection is lazy-loaded when called, this property returns whether it has been loaded without triggering a load.
CanCreateChildFolder
Indicates whether the shell object can create a child folder.
public override bool CanCreateChildFolder { get; }
Property Value
- bool:
trueif the shell object can create a child folder; otherwise,false.
Remarks
Only shell folders can create child folders.
CanHaveChildFolders
Indicates whether the shell object may have child folders.
public override bool CanHaveChildFolders { get; }
Property Value
- bool:
trueif the shell object may have child folders; otherwise,false.
Remarks
Some shell objects can immediately return that they don't have any child folders, whereas others might require a query to determine if there are any.
CanRename
Indicates whether the shell object may be renamed.
public override bool CanRename { get; }
Property Value
- bool:
trueif the shell object may be renamed; otherwise,false.
Children
The collection of child shell objects.
EditingName
The full user-friendly editing name of the shell object, if available.
public override string? EditingName { get; }
Property Value
Remarks
This value is usually the same as FileSystemPath, except that it can also return a special value to identify special shell objects.
ExtraLargeIcon
The extra-large icon.
ExtraLargeIconOverlay
The extra-large icon overlay.
FileSystemPath
The file system path of the shell object, if available.
IsFolder
Indicates whether the shell object is a folder, which is anything that can contain other shell objects.
public override bool IsFolder { get; }
Property Value
- bool:
trueif the shell object is a folder, which is anything that can contain other shell objects; otherwise,false.
IsLink
Indicates whether the shell object is a link, meaning a shortcut to another shell object.
public override bool IsLink { get; }
Property Value
- bool:
trueif the shell object is a link, meaning a shortcut to another shell object; otherwise,false.
IsRemovable
Indicates whether the shell object is on removable media or is a removable device.
public override bool IsRemovable { get; }
Property Value
- bool:
trueif the shell object is on removable media or is a removable device; otherwise,false.
IsVirtual
Indicates whether the shell object is not part of the file system (files, directories, or root directories).
public override bool IsVirtual { get; }
Property Value
- bool:
trueif the shell object is not part of the file system (files, directories, or root directories); otherwise,false.
IsWatching
Indicates whether the shell object's tree hierarchy is currently watching for change notifications.
public override bool IsWatching { get; }
Property Value
- bool:
trueif the shell object's tree hierarchy is currently watching for change notifications; otherwise,false.
Kind
A ShellObjectKind that specifies the kind of this shell object.
LargeIcon
The large icon.
LargeIconOverlay
The large icon overlay.
MediumIcon
The medium icon.
MediumIconOverlay
The medium icon overlay.
Name
The name of the shell object.
ParsingName
The full parsing name of the shell object, if available.
public override string? ParsingName { get; }
Property Value
Remarks
This value is usually the same as FileSystemPath, except that it can also return a special syntax to identify special shell objects.
RelativeParsingName
The parent-relative parsing name of the shell object, if available.
public override string? RelativeParsingName { get; }
Property Value
Remarks
This value is usually the same as Name, except that it can also return a special syntax to identify special shell objects.
SmallIcon
The small icon.
SmallIconOverlay
The small icon overlay.
SortOrder
A numeric sort order for sorting the shell object within other shell objects.
public override int SortOrder { get; set; }
Property Value
- int:
A numeric sort order for sorting the shell object within other shell objects. The default value is
0.
SpecialFolderKind
A SpecialFolderKind that specifies kind of special folder represented by this shell object, if applicable.
ToolTip
The tool-tip object that is displayed for this shell object in the user interface (UI).
WrappedShellObject
The IShellObject that is wrapped by this class.
Methods
CreateChildFolder(string)
Creates a child folder with the specified name.
public override bool CreateChildFolder(string name)
| Parameter | Type | Description |
|---|---|---|
| name | string | The name of the child folder. |
Returns
- bool:
trueif the child folder was created; otherwise,false.
Remarks
Only shell folders can create child folders.
Dispose(bool)
Releases the unmanaged resources used by the object and optionally releases the managed resources.
protected override void Dispose(bool disposing)
| Parameter | Type | Description |
|---|---|---|
| disposing | bool |
|
Remarks
This method is called by the public Dispose() method and the Finalize method.
Dispose invokes this method with the disposing parameter set to true.
Finalize invokes this method with disposing set to false.
RefreshChildren()
Refreshes the Children collection.
public override void RefreshChildren()
StartWatching()
Starts watching the shell object's tree hierarchy for change notifications.
public override bool StartWatching()
Returns
- bool:
trueif the shell object is watching its tree hierarchy; otherwise,false.
Remarks
The default implementation of this method does nothing, and returns false.
StopWatching()
Stops watching the shell object's tree hierarchy for change notifications.
public override void StopWatching()
Remarks
The default implementation of this method does nothing.
Inherited Members
- ShellObjectBase.GetChildComparisonKey(IShellObject)
- ShellObjectBase.NotifyPropertyChanged(string)
- ShellObjectBase.OnPropertyChanged(string)
- ShellObjectBase.OnPropertyChanged(PropertyChangedEventArgs)
- ShellObjectBase.RaiseChangedEvent(ShellObjectChangedEventArgs)
- ShellObjectBase.RaisePropertyChangedEvent(PropertyChangedEventArgs)
- ShellObjectBase.SetProperty<T>(ref T, T, string)
- ShellObjectBase.ToString()
- ShellObjectBase.ExtraLargeThumbnail
- ShellObjectBase.LargeThumbnail
- ShellObjectBase.MediumThumbnail
- ShellObjectBase.ShellService
- ShellObjectBase.Changed
- ShellObjectBase.PropertyChanged
- DisposableObjectBase.Dispose()
- object.GetType()
- object.MemberwiseClone()
- object.Equals(object)
- object.Equals(object, object)
- object.ReferenceEquals(object, object)
- object.GetHashCode()