ShellObjectItemAdapter Class

public class ShellObjectItemAdapter : TreeListBoxItemAdapter

public ShellObjectItemAdapter()

public override bool CanHaveChildren(TreeListBox ownerControl, object item)

Parameter	Type	Description
ownerControl	TreeListBox	The owner control.
item	object	The item to examine.

Returns

bool:

true if the specified item is capable of having child items; otherwise, false.

Remarks

The default implementation of this method returns true. This method should only return false if an item is not capable of having child items and is always a 'leaf' node in the tree. It should not return false if the item can have child items, but doesn't at the current time.

Optimizations are in place to not call GetChildren(TreeListBox, object) when this method returns true. This method should be overridden if OnExpansion is used and certain items are known to be 'leaf' nodes.

protected virtual ShellObjectViewModel? CreateShellObjectViewModel(TreeListBox ownerControl, IShellObject shellObject)

Parameter	Type	Description
ownerControl	TreeListBox	The owner control.
shellObject	IShellObject	The IShellObject to wrap.

Returns

ShellObjectViewModel:

The ShellObjectViewModel that was created.

Remarks

Override this method to customize the IShellObject before it is added to the user interface. Return null to prevent the IShellObject from being added.

public override string? GetAbsolutePath(TreeListBox ownerControl, object item)

Parameter	Type	Description
ownerControl	TreeListBox	The owner control.
item	object	The item to examine.

Returns

string

Remarks

The absolute path can be used to improve performance when searching for an item in a large tree since it allows for a path-based search instead of an exhaustive breadth-first search through the tree. A null string should be returned for items that don't know their absolute path.

public virtual ContextMenu? GetBackgroundContextMenu(TreeListBox ownerControl, ShellObjectViewModel? rootViewModel)

Parameter	Type	Description
ownerControl	TreeListBox	The owner control.
rootViewModel	ShellObjectViewModel	The root view-model.

Returns

ContextMenu

public override IEnumerable? GetChildren(TreeListBox ownerControl, object item)

Parameter	Type	Description
ownerControl	TreeListBox	The owner control.
item	object	The item to examine.

Returns

IEnumerable

Remarks

The ChildrenBinding property can be set for a pure XAML-based implementation of this method. Please note that bindings aren't as performant as code, so for large trees or if you see performance issues, it is recommended to override this method instead with custom logic to retrieve the appropriate value.

public override bool GetIsEditable(TreeListBox ownerControl, object item)

Parameter	Type	Description
ownerControl	TreeListBox	The owner control.
item	object	The item to examine.

Returns

bool:

true if the specified item is editable; otherwise, false.

Remarks

The IsEditableBinding binding property can be set for a pure XAML-based implementation of this method. Please note that bindings aren't as performant as code, so for large trees or if you see performance issues, it is recommended to override this method instead with custom logic to retrieve the appropriate value. The IsEditableDefault property can also be set (if IsEditableBinding is not used) to designate the default return value of this method, and that can be set in XAML.

public override bool GetIsEditing(TreeListBox ownerControl, object item)

Parameter	Type	Description
ownerControl	TreeListBox	The owner control.
item	object	The item to examine.

Returns

bool:

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

Remarks

The IsEditingBinding binding property can be set for a pure XAML-based implementation of this method. Please note that bindings aren't as performant as code, so for large trees or if you see performance issues, it is recommended to override this method instead with custom logic to retrieve the appropriate value.

public override bool GetIsExpanded(TreeListBox ownerControl, object item)

Parameter	Type	Description
ownerControl	TreeListBox	The owner control.
item	object	The item to examine.

Returns

bool:

true if the specified item is expanded; otherwise, false.

Remarks

The IsExpandedBinding binding property can be set for a pure XAML-based implementation of this method. Please note that bindings aren't as performant as code, so for large trees or if you see performance issues, it is recommended to override this method instead with custom logic to retrieve the appropriate value. The IsExpandedDefault property can also be set (if IsExpandedBinding is not used) to designate the default return value of this method, and that can be set in XAML.

public override bool GetIsSelected(TreeListBox ownerControl, object item)

Parameter	Type	Description
ownerControl	TreeListBox	The owner control.
item	object	The item to examine.

Returns

bool:

true if the specified item is selected; otherwise, false.

Remarks

The IsSelectedBinding binding property can be set for a pure XAML-based implementation of this method. Please note that bindings aren't as performant as code, so for large trees or if you see performance issues, it is recommended to override this method instead with custom logic to retrieve the appropriate value.

public virtual ContextMenu? GetItemContextMenu(TreeListBox ownerControl, IList<ShellObjectViewModel> viewModels)

Parameter	Type	Description
ownerControl	TreeListBox	The owner control.
viewModels	IList<ShellObjectViewModel>	The view-models to examine.

Returns

ContextMenu

public override string? GetPath(TreeListBox ownerControl, object item)

Parameter	Type	Description
ownerControl	TreeListBox	The owner control.
item	object	The item to examine.

Returns

string:

The item's string path, relative to its parent.

Remarks

The PathBinding property can be set for a pure XAML-based implementation of this method. Please note that bindings aren't as performant as code, so for large trees or if you see performance issues, it is recommended to override this method instead with custom logic to retrieve the appropriate value.

public override void SetIsEditing(TreeListBox ownerControl, object item, bool value)

Parameter	Type	Description
ownerControl	TreeListBox	The owner control.
item	object	The item to update.
value	bool	The new value.

Remarks

The IsEditingBinding binding property can be set to a two-way binding for a pure XAML-based implementation of this method. Please note that bindings aren't as performant as code, so for large trees or if you see performance issues, it is recommended to override this method instead with custom logic to set the appropriate value.

public override void SetIsExpanded(TreeListBox ownerControl, object item, bool value)

Parameter	Type	Description
ownerControl	TreeListBox	The owner control.
item	object	The item to update.
value	bool	The new value.

Remarks

The IsExpandedBinding binding property can be set to a two-way binding for a pure XAML-based implementation of this method. Please note that bindings aren't as performant as code, so for large trees or if you see performance issues, it is recommended to override this method instead with custom logic to set the appropriate value.

public override void SetIsSelected(TreeListBox ownerControl, object item, bool value)

Parameter	Type	Description
ownerControl	TreeListBox	The owner control.
item	object	The item to update.
value	bool	The new value.

Remarks

The IsSelectedBinding binding property can be set to a two-way binding for a pure XAML-based implementation of this method. Please note that bindings aren't as performant as code, so for large trees or if you see performance issues, it is recommended to override this method instead with custom logic to set the appropriate value.