Class RadTreeListView

A Grid-Like control that can display hierarchies like a TreeView.

Inheritance
System.Object
DataControl
BaseItemsControl
GridViewDataControl
RadTreeListView
Inherited Members
Namespace: Telerik.Windows.Controls
Assembly: Telerik.Windows.Controls.GridView.dll

Syntax

[TelerikToolboxCategory("Data")]
public class RadTreeListView : GridViewDataControl, INotifyPropertyChanged, ISelectorInternal, IGeneratorHost, IGroupsProvider, IScrollingServiceCore, IScrollingInfo, IDataControl, IWeakEventListener<DataErrorsChangedEventArgs>, IWeakEventListener<PropertyChangedEventArgs>, IThemable

Constructors

RadTreeListView()

Initializes a new instance of the RadTreeListView class.

Declaration
public RadTreeListView()

Fields

AutoExpandItemsAfterFilterProperty

Identifies the AutoLoadHierarchy property.

Declaration
public static readonly DependencyProperty AutoExpandItemsAfterFilterProperty
Field Value
System.Windows.DependencyProperty

AutoExpandItemsProperty

Identifies the AutoExpandItems property.

Declaration
public static readonly DependencyProperty AutoExpandItemsProperty
Field Value
System.Windows.DependencyProperty

AutoLoadHierarchyProperty

Identifies the AutoLoadHierarchy property.

Declaration
public static readonly DependencyProperty AutoLoadHierarchyProperty
Field Value
System.Windows.DependencyProperty

DragCueItemTemplateProperty

Identifies the DragCueItemTemplate dependency property.

Declaration
public static readonly DependencyProperty DragCueItemTemplateProperty
Field Value
System.Windows.DependencyProperty

DragEndedEvent

Identifies the DragEnded routed event.

Declaration
public static readonly RoutedEvent DragEndedEvent
Field Value
System.Windows.RoutedEvent

DragStartedEvent

Identifies the DragStarted routed event.

Declaration
public static readonly RoutedEvent DragStartedEvent
Field Value
System.Windows.RoutedEvent

DropPositionProperty

Identifies the DropPosition dependency property.

Declaration
public static readonly DependencyProperty DropPositionProperty
Field Value
System.Windows.DependencyProperty

HierarchyColumnIndexProperty

Identifies the HierarchyColumnIndex property.

Declaration
public static readonly DependencyProperty HierarchyColumnIndexProperty
Field Value
System.Windows.DependencyProperty

HierarchyIndentProperty

Identifies the HierarchyIndent dependency property.

Declaration
public static readonly DependencyProperty HierarchyIndentProperty
Field Value
System.Windows.DependencyProperty

IsDragDropEnabledProperty

Identifies the IsDragDropEnabled dependency property.

Declaration
public static readonly DependencyProperty IsDragDropEnabledProperty
Field Value
System.Windows.DependencyProperty

IsDragPreviewEnabledProperty

Identifies the IsDragPreviewEnabled dependency property.

Declaration
public static readonly DependencyProperty IsDragPreviewEnabledProperty
Field Value
System.Windows.DependencyProperty

IsDragTooltipEnabledProperty

Identifies the IsDragTooltipEnabled dependency property.

Declaration
public static readonly DependencyProperty IsDragTooltipEnabledProperty
Field Value
System.Windows.DependencyProperty

IsDropPreviewLineEnabledProperty

Identifies the IsDropPreviewLineEnabled dependency property.

Declaration
public static readonly DependencyProperty IsDropPreviewLineEnabledProperty
Field Value
System.Windows.DependencyProperty

PreviewDragEndedEvent

Identifies the PreviewDragEnded routed event.

Declaration
public static readonly RoutedEvent PreviewDragEndedEvent
Field Value
System.Windows.RoutedEvent

PreviewDragStartedEvent

Identifies the PreviewDragStarted routed event.

Declaration
public static readonly RoutedEvent PreviewDragStartedEvent
Field Value
System.Windows.RoutedEvent

TreeLinesBrushProperty

Identifies the TreeLinesBrush property.

Declaration
public static readonly DependencyProperty TreeLinesBrushProperty
Field Value
System.Windows.DependencyProperty

TreeLinesStrokeThicknessProperty

Identifies the TreeLinesStroke property.

Declaration
public static readonly DependencyProperty TreeLinesStrokeThicknessProperty
Field Value
System.Windows.DependencyProperty

TreeLinesVisibilityProperty

Identifies the TreeLinesVisibility property.

Declaration
public static readonly DependencyProperty TreeLinesVisibilityProperty
Field Value
System.Windows.DependencyProperty

Properties

AutoExpandItems

Gets or sets value indicating if the hierarchy items should be expanded initially or not.

Declaration
public bool AutoExpandItems { get; set; }
Property Value
System.Boolean

AutoExpandItemsAfterFilter

Gets or sets value which controls whether the hierarchy items should be expanded after filtering.

Declaration
public bool AutoExpandItemsAfterFilter { get; set; }
Property Value
System.Boolean

AutoLoadHierarchy

Gets or sets value indicating if the hierarchy should be loaded initially or not.

Declaration
public bool AutoLoadHierarchy { get; set; }
Property Value
System.Boolean

DragCueItemTemplate

Gets or sets the template for the drag cue.

Declaration
public DataTemplate DragCueItemTemplate { get; set; }
Property Value
System.Windows.DataTemplate

HierarchyColumnIndex

Gets or sets the display index of the column that will contain the hierarchy. This property takes effect only if assigned before ItemsSource.

Declaration
public int HierarchyColumnIndex { get; set; }
Property Value
System.Int32

HierarchyIndent

Gets or sets the indent of the hierarchy expand button.

Declaration
public double HierarchyIndent { get; set; }
Property Value
System.Double

IsDragDropEnabled

Gets or sets a value indicating whether drag and drop is enabled.

Declaration
public bool IsDragDropEnabled { get; set; }
Property Value
System.Boolean

IsDragPreviewEnabled

Gets or sets a value indicating whether drag feedback is shown while dragging.

Declaration
public bool IsDragPreviewEnabled { get; set; }
Property Value
System.Boolean

IsDragTooltipEnabled

Gets or sets a value indicating whether drag tooltip is shown while dragging.

Declaration
public bool IsDragTooltipEnabled { get; set; }
Property Value
System.Boolean

IsDropPreviewLineEnabled

Gets or sets a value indicating whether drag outline is shown while dragging.

Declaration
public bool IsDropPreviewLineEnabled { get; set; }
Property Value
System.Boolean

TreeLinesBrush

Gets or sets value indicating the TreeLinesBrush.

Declaration
public Brush TreeLinesBrush { get; set; }
Property Value
System.Windows.Media.Brush

TreeLinesStrokeThickness

Gets or sets value indicating the TreeLinesStroke thickness.

Declaration
public double TreeLinesStrokeThickness { get; set; }
Property Value
System.Double

TreeLinesVisibility

Gets or sets value indicating the TreeLinesVisibility.

Declaration
public TreeLinesVisibility TreeLinesVisibility { get; set; }
Property Value
TreeLinesVisibility

Methods

ClearContainerForItemOverride(DependencyObject, Object)

When overridden in a derived class, undoes the effects of the PrepareContainerForItemOverride method.

Declaration
protected override void ClearContainerForItemOverride(DependencyObject element, object item)
Parameters
System.Windows.DependencyObject element

The container element.
System.Object item

The item.
Overrides

GetContainerForItemOverride(Object)

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

Declaration
protected override DependencyObject GetContainerForItemOverride(object item)
Parameters
System.Object item

Returns
System.Windows.DependencyObject

The element that is used to display the given item.
Overrides

HideBetweenItemsDragCue()

Hides the drag cue that appears when a drop between two items is possible.

Declaration
public void HideBetweenItemsDragCue()

OnApplyTemplate()

Declaration
public override void OnApplyTemplate()
Overrides

OnCreateAutomationPeer()

Declaration
protected override AutomationPeer OnCreateAutomationPeer()
Returns
System.Windows.Automation.Peers.AutomationPeer

OnDragEnded(RadTreeListViewDragEndedEventArgs)

Raises the DragEnded event.

Declaration
protected virtual void OnDragEnded(RadTreeListViewDragEndedEventArgs e)
Parameters
RadTreeListViewDragEndedEventArgs e

The RadTreeListViewDragEndedEventArgs instance containing the event data.

OnDragStarted(RadTreeListViewDragEventArgs)

Raises the DragStarted event.

Declaration
protected virtual void OnDragStarted(RadTreeListViewDragEventArgs e)
Parameters
RadTreeListViewDragEventArgs e

The RadTreeListViewDragEventArgs instance containing the event data.

OnInitialized(EventArgs)

Declaration
protected override void OnInitialized(EventArgs e)
Parameters
System.EventArgs e

Overrides

OnItemsCollectionChanged(Object, NotifyCollectionChangedEventArgs)

Called when this.Items collection changes.

Declaration
protected override void OnItemsCollectionChanged(object sender, NotifyCollectionChangedEventArgs e)
Parameters
System.Object sender

The sender.
System.Collections.Specialized.NotifyCollectionChangedEventArgs e

The System.Collections.Specialized.NotifyCollectionChangedEventArgs instance containing the event data.
Overrides

OnPreviewDragEnded(RadTreeListViewDragEndedEventArgs)

Raises the PreviewDragEnded event.

Declaration
protected virtual bool OnPreviewDragEnded(RadTreeListViewDragEndedEventArgs e)
Parameters
RadTreeListViewDragEndedEventArgs e

The RadTreeListViewDragEndedEventArgs instance containing the event data.
Returns
System.Boolean

OnPreviewDragStarted(RadTreeListViewDragEventArgs)

Raises the PreviewDragStarted event.

Declaration
protected virtual bool OnPreviewDragStarted(RadTreeListViewDragEventArgs e)
Parameters
RadTreeListViewDragEventArgs e

The RadTreeListViewDragEventArgs instance containing the event data.
Returns
System.Boolean

PrepareContainerForItemOverride(DependencyObject, Object)

Prepares the specified element to display the specified item.

Declaration
protected override void PrepareContainerForItemOverride(DependencyObject element, object item)
Parameters
System.Windows.DependencyObject element

System.Object item

Overrides

ResetTheme()

Resets the theme of the RadTreeListView.

Declaration
public void ResetTheme()

ScrollIntoView(Object, Boolean)

Scrolls the row containing the data item into view.

Declaration
public void ScrollIntoView(object dataItem, bool expandItem)
Parameters
System.Object dataItem

The item to scroll into view.
System.Boolean expandItem

Indicates whether to expand the item or not.

ScrollIntoView(Object, GridViewColumn, Boolean)

Scrolls a cell into view.

Declaration
public void ScrollIntoView(object dataItem, GridViewColumn column, bool expandItem)
Parameters
System.Object dataItem

The item to scroll into view.
GridViewColumn column

The column to scroll into view.
System.Boolean expandItem

Indicates whether to expand the item or not.
Remarks

If the column parameter is null then only vertical scroll is performed. If the dataItem parameter is null then only horizontal scroll is performed.

ScrollIntoViewAsync(Object, Action<FrameworkElement>, Action, Boolean)

Scrolls the row containing the data item into view in an asynchronous manner.

Declaration
public void ScrollIntoViewAsync(object dataItem, Action<FrameworkElement> scrollFinishedCallback, Action scrollFailedCallback, bool expandItem)
Parameters
System.Object dataItem

The item to scroll into view.
System.Action<System.Windows.FrameworkElement> scrollFinishedCallback

The method to execute when scrolling has finished.
System.Action scrollFailedCallback

The method to execute when scrolling has failed.
System.Boolean expandItem

Indicates whether to expand the item or not.
Remarks

Since this method is asynchronous, calling it will return immediately. If you need to perform a certain action once the scrolling is done use the scrollFinishedCallback parameter to pass in a method to execute. The FrameworkElement parameter of this method will be the row that was just scrolled.

ScrollIntoViewAsync(Object, Action<FrameworkElement>, Boolean)

Scrolls the row containing the data item into view in an asynchronous manner.

Declaration
public void ScrollIntoViewAsync(object dataItem, Action<FrameworkElement> scrollFinishedCallback, bool expandItem)
Parameters
System.Object dataItem

The item to scroll into view.
System.Action<System.Windows.FrameworkElement> scrollFinishedCallback

The method to execute when scrolling has finished.
System.Boolean expandItem

Indicates whether to expand the item or not.
Remarks

Since this method is asynchronous, calling it will return immediately. If you need to perform a certain action once the scrolling is done use the scrollFinishedCallback parameter to pass in a method to execute. The FrameworkElement parameter of this method will be the row that was just scrolled.

ScrollIntoViewAsync(Object, GridViewColumn, Action<FrameworkElement>, Action, Boolean)

Scrolls the row containing the data item and GridViewColumn into view in an asynchronous manner.

Declaration
public void ScrollIntoViewAsync(object dataItem, GridViewColumn column, Action<FrameworkElement> scrollFinishedCallback, Action scrollFailedCallback, bool expandItem)
Parameters
System.Object dataItem

The data item to scroll into view.
GridViewColumn column

The column to scroll into view.
System.Action<System.Windows.FrameworkElement> scrollFinishedCallback

The method to execute when scrolling has finished.
System.Action scrollFailedCallback

The method to execute when scrolling has failed.
System.Boolean expandItem

Indicates whether to expand the item or not.

ScrollIntoViewAsync(Object, GridViewColumn, Action<FrameworkElement>, Boolean)

Scrolls the row containing the data item and GridViewColumn into view in an asynchronous manner.

Declaration
public void ScrollIntoViewAsync(object dataItem, GridViewColumn column, Action<FrameworkElement> scrollFinishedCallback, bool expandItem)
Parameters
System.Object dataItem

The item to scroll into view.
GridViewColumn column

The column to scroll into view.
System.Action<System.Windows.FrameworkElement> scrollFinishedCallback

The method to execute when scrolling has finished.
System.Boolean expandItem

Indicates whether to expand the item or not.
Remarks

Since this method is asynchronous, calling it will return immediately. If you need to perform a certain action once the scrolling is done use the scrollFinishedCallback parameter to pass in a method to execute. The FrameworkElement parameter of this method will be the row that was just scrolled.

ShowBetweenItemsDragCue(GridViewRow)

Shows the DragCue that appears when a drop between two items is possible.

Declaration
public void ShowBetweenItemsDragCue(GridViewRow dropDestination)
Parameters
GridViewRow dropDestination

The relative drop position. In this method only DropPosition.Before and DropPosition.After make sense.

Events

PreviewDragEnded

Occurs before the drag has been ended.

Declaration
public event RadTreeListViewDragEndedEventHandler PreviewDragEnded
Event Type
RadTreeListViewDragEndedEventHandler

Extension Methods