ShellObjectBase Class

public abstract class ShellObjectBase : DisposableObjectBase, IShellObject, IDisposable

protected ShellObjectBase(IShellService shellService)

Parameter	Type	Description
shellService	IShellService	The IShellService used to return this shell object's children.

public virtual bool AreChildrenLoaded { get; }

Property Value

bool:

true if the Children collection is loaded; otherwise, false.

Remarks

Since the Children collection is lazy-loaded when called, this property returns whether it has been loaded without triggering a load.

public virtual bool CanCreateChildFolder { get; }

Property Value

bool:

true if the shell object can create a child folder; otherwise, false. The default implementation of this property returns false.

Remarks

Only shell folders can create child folders.

public virtual bool CanHaveChildFolders { get; }

Property Value

bool:

true if the shell object may have child folders; otherwise, false. The default implementation of this property returns the IsFolder property value.

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.

public virtual bool CanRename { get; }

Property Value

bool:

true if the shell object may be renamed; otherwise, false. The default implementation of this property returns false.

public virtual IList<IShellObject> Children { get; }

Property Value

IList<IShellObject>:

The collection of child shell objects using lazy-loading.

public virtual string EditingName { get; }

Property Value

string:

The full user-friendly editing name of the shell object, if available.

Remarks

This value is usually the same as FileSystemPath, except that it can also return a special value to identify special shell objects.

public abstract ImageSource ExtraLargeIcon { get; set; }

Property Value

ImageSource:

The extra-large icon.

public abstract ImageSource ExtraLargeIconOverlay { get; set; }

Property Value

ImageSource:

The extra-large icon overlay.

public abstract ImageSource ExtraLargeThumbnail { get; set; }

Property Value

ImageSource:

The extra-large thumbnail.

public virtual string FileSystemPath { get; }

Property Value

string:

The file system path of the shell object, if available. The default implementation of this property returns null.

public virtual bool IsFolder { get; }

Property Value

bool:

true if the shell object is a folder, which is anything that can contain other shell objects; otherwise, false. The default implementation of this property returns true based on an applicable Kind property value.

public virtual bool IsLink { get; }

Property Value

bool:

true if the shell object is a link, meaning a shortcut to another shell object; otherwise, false. The default implementation of this property returns true based on an applicable Kind property value.

public virtual bool IsRemovable { get; }

Property Value

bool:

true if the shell object is on removable media or is a removable device; otherwise, false. The default implementation of this property returns false.

public virtual bool IsVirtual { get; }

Property Value

bool:

true if the shell object is not part of the file system (files, directories, or root directories); otherwise, false. The default implementation of this property returns true.

public virtual bool IsWatching { get; }

Property Value

bool:

true if the shell object's tree hierarchy is currently watching for change notifications; otherwise, false. The default implementation of this property returns false.

public abstract ShellObjectKind Kind { get; }

Property Value

ShellObjectKind:

A ShellObjectKind that specifies the kind of this shell object.

public abstract ImageSource LargeIcon { get; set; }

Property Value

ImageSource:

The large icon.

public abstract ImageSource LargeIconOverlay { get; set; }

Property Value

ImageSource:

The large icon overlay.

public abstract ImageSource LargeThumbnail { get; set; }

Property Value

ImageSource:

The large thumbnail.

public abstract ImageSource MediumIcon { get; set; }

Property Value

ImageSource:

The medium icon.

public abstract ImageSource MediumIconOverlay { get; set; }

Property Value

ImageSource:

The medium icon overlay.

public abstract ImageSource MediumThumbnail { get; set; }

Property Value

ImageSource:

The medium thumbnail.

public abstract string Name { get; set; }

Property Value

string:

The name of the shell object.

public virtual string ParsingName { get; }

Property Value

string:

The full parsing name of the shell object, if available. The default implementation of this property returns the FileSystemPath 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.

public virtual string RelativeParsingName { get; }

Property Value

string:

The parent-relative parsing name of the shell object, if available.

Remarks

This value is usually the same as Name, except that it can also return a special syntax to identify special shell objects.

public IShellService ShellService { get; }

Property Value

IShellService:

The IShellService used to return this shell object's children.

public abstract ImageSource SmallIcon { get; set; }

Property Value

ImageSource:

The small icon.

public abstract ImageSource SmallIconOverlay { get; set; }

Property Value

ImageSource:

The small icon overlay.

public virtual 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.

public virtual SpecialFolderKind SpecialFolderKind { get; }

Property Value

SpecialFolderKind:

A SpecialFolderKind that specifies kind of special folder represented by this shell object, if applicable. The default implementation of this property returns None.

public abstract object ToolTip { get; set; }

Property Value

object:

The tool-tip object.

public virtual bool CreateChildFolder(string name)

Parameter	Type	Description
name	string	The name of the child folder.

Returns

bool:

true if the child folder was created; otherwise, false.

Remarks

Only shell folders can create child folders. The default implementation of this method does nothing and returns false.

protected override void Dispose(bool disposing)

Parameter	Type	Description
disposing	bool	true to release both managed and unmanaged resources; false to release only unmanaged resources.

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.

protected virtual object GetChildComparisonKey(IShellObject shellObject)

Parameter	Type	Description
shellObject	IShellObject	The IShellObject to examine.

Returns

object:

The comparison key object to use.

protected void NotifyPropertyChanged(string propertyName)

Parameter	Type	Description
propertyName	string	The name of the property that was changed.

protected void RaiseChangedEvent(ShellObjectChangedEventArgs e)

Parameter	Type	Description
e	ShellObjectChangedEventArgs	The ShellObjectChangedEventArgs that contains the event data.

protected void RaisePropertyChangedEvent(PropertyChangedEventArgs e)

Parameter	Type	Description
e	PropertyChangedEventArgs	The PropertyChangedEventArgs that contains the event data.

public virtual void RefreshChildren()

public virtual bool StartWatching()

Returns

bool:

true if the shell object is watching its tree hierarchy; otherwise, false.

Remarks

The default implementation of this method does nothing, and returns false.

public virtual void StopWatching()

Remarks

The default implementation of this method does nothing.

public override string ToString()

Returns

string:

A String that represents the current Object.

public event EventHandler<ShellObjectChangedEventArgs> Changed

Event Type

EventHandler<ShellObjectChangedEventArgs>

public event PropertyChangedEventHandler PropertyChanged

Event Type

PropertyChangedEventHandler