TreeListView Class

Namespace:: ActiproSoftware.Windows.Controls.Grids

Assembly:: ActiproSoftware.Grids.Wpf.dll

Represents an advanced multi-column tree view control.

public class TreeListView : TreeListBox

Inheritance:: object Visual UIElement FrameworkElement Control ItemsControl TreeListBox object

Derived:: PropertyGrid ShellListView

Constructors

TreeListView()

Initializes an instance of the class.

public TreeListView()

Properties

AreColumnHeadersVisible

Indicates whether column headers are visible.

public bool AreColumnHeadersVisible { get; set; }

Property Value

bool:: true if column headers are visible; otherwise, false. The default value is true.

CanColumnsReorder

Indicates whether columns can be reordered by the end user.

public bool CanColumnsReorder { get; set; }

Property Value

bool:: true if columns can be reordered by the end user; otherwise, false. The default value is false.

CanColumnsResize

Indicates whether columns can be resized by the end user.

public bool CanColumnsResize { get; set; }

Property Value

bool:: true if columns can be resized by the end user; otherwise, false. The default value is true.

CanColumnsToggleVisibility

Indicates whether columns can have their visibility toggled by the end user.

public bool CanColumnsToggleVisibility { get; set; }

Property Value

bool:: true if columns can have their visibility toggled by the end user; otherwise, false. The default value is false.

ColumnHeaderHeight

The height of the column header.

public double ColumnHeaderHeight { get; }

Property Value

double

Columns

The collection of columns in the control.

public ObservableCollection<TreeListViewColumn> Columns { get; }

Property Value

ObservableCollection<TreeListViewColumn>

ExpansionColumnIndex

The index of the columns that contains the indentation and expander button.

public int ExpansionColumnIndex { get; set; }

Property Value

int:: The default value is 0.

FrozenColumnCount

The number of non-scrolling columns, that are always displayed left-most and cannot be scrolled out of visibility.

public int FrozenColumnCount { get; set; }

Property Value

int:: The default value is 0.

IsDefaultColumnHeaderContextMenuEnabled

Indicates whether the default column header context menu is enabled.

public bool IsDefaultColumnHeaderContextMenuEnabled { get; set; }

Property Value

bool:: true if the default column header context menu is enabled; otherwise, false. The default value is true.

IsKeyboardFocusWithinContent

Indicates whether keyboard focus is within the content area, and not in any header area.

protected override bool IsKeyboardFocusWithinContent { get; }

Property Value

bool:: true if keyboard focus is within the content area; otherwise, false.

SizeAllColumnsToFitCommand

The ICommand that sizes all non-star width columns to fit.

public ICommand SizeAllColumnsToFitCommand { get; }

Property Value

ICommand

Methods

ArrangeOverride(Size)

Called to arrange and size the content of a Control object.

protected override Size ArrangeOverride(Size finalSize)

Parameter	Type	Description
finalSize	Size

Returns

Size:: The size of the control.

ClearContainerForItemOverride(DependencyObject, object)

When overridden in a derived class, undoes the effects of the PrepareContainerForItemOverride(DependencyObject, object) method.

protected override void ClearContainerForItemOverride(DependencyObject element, object item)

Parameter	Type	Description
element	DependencyObject	The container element.
item	object	The item.

GetColumnHeaderVisibility(ScrollViewer)

Gets the value of the ColumnHeaderVisibility attached property for the specified object.

public static Visibility GetColumnHeaderVisibility(ScrollViewer obj)

Parameter	Type	Description
obj	ScrollViewer	The object from which the property value is read.

Returns

Visibility

GetContainerForItemOverride()

Creates or identifies the element that is used to display the given item.

protected override DependencyObject GetContainerForItemOverride()

Returns

DependencyObject:: The element that is used to display the given item.

GetFrozenColumnsWidth(ScrollViewer)

Gets the value of the FrozenColumnsWidth attached property for the specified object.

public static double GetFrozenColumnsWidth(ScrollViewer obj)

Parameter	Type	Description
obj	ScrollViewer	The object from which the property value is read.

Returns

double

IsItemItsOwnContainerOverride(object)

Determines if the specified item is (or is eligible to be) its own container.

protected override bool IsItemItsOwnContainerOverride(object item)

Parameter	Type	Description
item	object	The item to check.

Returns

bool:: true if the item is (or is eligible to be) its own container; otherwise, false.

MeasureOverride(Size)

Called to remeasure a control.

protected override Size MeasureOverride(Size availableSize)

Parameter	Type	Description
availableSize	Size

Returns

Size:: The size of the control, up to the maximum specified by constraint.

OnApplyTemplate()

When overridden in a derived class, is invoked whenever application code or internal processes call ApplyTemplate().

public override void OnApplyTemplate()

OnColumnHeaderMenuRequested(TreeListViewColumnMenuEventArgs)

Occurs when a column header requests a context menu.

protected virtual void OnColumnHeaderMenuRequested(TreeListViewColumnMenuEventArgs e)

Parameter	Type	Description
e	TreeListViewColumnMenuEventArgs	The event data.