ShellObjectViewModel Class

public class ShellObjectViewModel : ObservableObjectBase

public ShellObjectViewModel(IShellObject shellObject)

Parameter	Type	Description
shellObject	IShellObject	The IShellObject model wrapped by this view model.

public bool CanCreateChildFolder { get; }

Property Value

bool:

true if the shell object can create a child folder; otherwise, false.

Remarks

Only shell folders can create child folders.

public bool CanHaveChildFolders { get; }

Property Value

bool:

true if 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.

public bool CanRename { get; }

Property Value

bool:

true if the shell object may be renamed; otherwise, false.

public bool CanUseThumbnails { get; set; }

Property Value

bool:

true if thumbnail images can be used in place of icons when available; otherwise, false. The default value is false.

public IList<ShellObjectViewModel> Children { get; }

Property Value

IList<ShellObjectViewModel>:

The collection of child view-models, which is initialized by an item adapter.

public virtual ICommand CreateChildFolderCommand { get; }

Property Value

ICommand:

The ICommand used to add a new child into to an associated collection/parent.

public 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 ImageSource ExtraLargeIcon { get; }

Property Value

ImageSource:

The extra-large icon.

public ImageSource ExtraLargeIconOverlay { get; }

Property Value

ImageSource:

The extra-large icon overlay.

public ImageSource ExtraLargeThumbnail { get; }

Property Value

ImageSource:

The extra-large thumbnail.

public string FileSystemPath { get; }

Property Value

string:

The file system path of the shell object, if available.

public bool HasExtraLargeThumbnail { get; }

Property Value

bool:

true if a ExtraLargeThumbnail is available; otherwise, false.

public bool HasLargeThumbnail { get; }

Property Value

bool:

true if a LargeThumbnail is available; otherwise, false.

public bool HasMediumThumbnail { get; }

Property Value

bool:

true if a MediumThumbnail is available; otherwise, false.

public bool IsEditing { get; set; }

Property Value

bool:

true if the node is currently being edited; otherwise, false.

public bool IsExpanded { get; set; }

Property Value

bool:

true if the node is expanded; otherwise, false.

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

public bool IsLink { get; }

Property Value

bool:

true if the shell object is a link, meaning a shortcut to another shell object; otherwise, false.

public bool IsRemovable { get; }

Property Value

bool:

true if the shell object is on removable media or is a removable device; otherwise, false.

public bool IsSelected { get; set; }

Property Value

bool:

true if the node is selected; otherwise, false.

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

public bool IsWatching { get; }

Property Value

bool:

true if the shell object's tree hierarchy is currently watching for change notifications; otherwise, false.

public ShellObjectKind Kind { get; }

Property Value

ShellObjectKind:

A ShellObjectKind that specifies the kind of this shell object.

public ImageSource LargeIcon { get; }

Property Value

ImageSource:

The large icon.

public ImageSource LargeIconOverlay { get; }

Property Value

ImageSource:

The large icon overlay.

public ImageSource LargeThumbnail { get; }

Property Value

ImageSource:

The large thumbnail.

public ImageSource MediumIcon { get; }

Property Value

ImageSource:

The medium icon.

public ImageSource MediumIconOverlay { get; }

Property Value

ImageSource:

The medium icon overlay.

public ImageSource MediumThumbnail { get; }

Property Value

ImageSource:

The medium thumbnail.

public IShellObject Model { get; set; }

Property Value

IShellObject:

The IShellObject model wrapped by this view-model.

public string Name { get; set; }

Property Value

string:

The name of the shell object.

public string ParsingName { get; }

Property Value

string:

The full parsing name of the shell object, if available.

Remarks

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

public 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 ImageSource SmallIcon { get; }

Property Value

ImageSource:

The small icon.

public ImageSource SmallIconOverlay { get; }

Property Value

ImageSource:

The small icon overlay.

public int SortOrder { get; }

Property Value

int:

A numeric sort order for sorting the shell object within other shell objects. The default value is 0.

public SpecialFolderKind SpecialFolderKind { get; }

Property Value

SpecialFolderKind:

A SpecialFolderKind that specifies kind of special folder represented by this shell object, if applicable.

public object Tag { get; set; }

Property Value

object:

The custom data for the node.

public object ToolTip { get; }

Property Value

object:

The tool-tip object.

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

public bool StartWatching()

Returns

bool:

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

public void StopWatching()

public override string ToString()

Returns

string:

A string representation of this instance.