ClassRadTreeListView
A Grid-Like control that can display hierarchies like a TreeView.
Definition
Namespace:Telerik.Windows.Controls
Assembly:Telerik.Windows.Controls.GridView.dll
Syntax:
[TelerikToolboxCategory("Data")]
public class RadTreeListView : GridViewDataControl, INotifyPropertyChanged, IScrollingServiceCore, IScrollingInfo
Inheritance: objectDataControlBaseItemsControlGridViewDataControlRadTreeListView
Implements:
Inherited Members
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
DependencyProperty
AutoExpandItemsProperty
Identifies the AutoExpandItems property.
Declaration
public static readonly DependencyProperty AutoExpandItemsProperty
Field Value
DependencyProperty
AutoLoadHierarchyProperty
Identifies the AutoLoadHierarchy property.
Declaration
public static readonly DependencyProperty AutoLoadHierarchyProperty
Field Value
DependencyProperty
DragCueItemTemplateProperty
Identifies the DragCueItemTemplate dependency property.
Declaration
public static readonly DependencyProperty DragCueItemTemplateProperty
Field Value
DependencyProperty
DragEndedEvent
Identifies the DragEnded routed event.
Declaration
public static readonly RoutedEvent DragEndedEvent
Field Value
RoutedEvent
DragStartedEvent
Identifies the DragStarted routed event.
Declaration
public static readonly RoutedEvent DragStartedEvent
Field Value
RoutedEvent
DropPositionProperty
Identifies the DropPosition dependency property.
Declaration
public static readonly DependencyProperty DropPositionProperty
Field Value
DependencyProperty
HierarchyColumnIndexProperty
Identifies the HierarchyColumnIndex property.
Declaration
public static readonly DependencyProperty HierarchyColumnIndexProperty
Field Value
DependencyProperty
HierarchyIndentProperty
Identifies the HierarchyIndent dependency property.
Declaration
public static readonly DependencyProperty HierarchyIndentProperty
Field Value
DependencyProperty
IsDragDropEnabledProperty
Identifies the IsDragDropEnabled dependency property.
Declaration
public static readonly DependencyProperty IsDragDropEnabledProperty
Field Value
DependencyProperty
IsDragPreviewEnabledProperty
Identifies the IsDragPreviewEnabled dependency property.
Declaration
public static readonly DependencyProperty IsDragPreviewEnabledProperty
Field Value
DependencyProperty
IsDragTooltipEnabledProperty
Identifies the IsDragTooltipEnabled dependency property.
Declaration
public static readonly DependencyProperty IsDragTooltipEnabledProperty
Field Value
DependencyProperty
IsDropPreviewLineEnabledProperty
Identifies the IsDropPreviewLineEnabled dependency property.
Declaration
public static readonly DependencyProperty IsDropPreviewLineEnabledProperty
Field Value
DependencyProperty
PreviewDragEndedEvent
Identifies the PreviewDragEnded routed event.
Declaration
public static readonly RoutedEvent PreviewDragEndedEvent
Field Value
RoutedEvent
PreviewDragStartedEvent
Identifies the PreviewDragStarted routed event.
Declaration
public static readonly RoutedEvent PreviewDragStartedEvent
Field Value
RoutedEvent
TreeLinesBrushProperty
Identifies the TreeLinesBrush property.
Declaration
public static readonly DependencyProperty TreeLinesBrushProperty
Field Value
DependencyProperty
TreeLinesStrokeThicknessProperty
Identifies the TreeLinesStroke property.
Declaration
public static readonly DependencyProperty TreeLinesStrokeThicknessProperty
Field Value
DependencyProperty
TreeLinesVisibilityProperty
Identifies the TreeLinesVisibility property.
Declaration
public static readonly DependencyProperty TreeLinesVisibilityProperty
Field Value
DependencyProperty
Properties
AutoExpandItems
Gets or sets value indicating if the hierarchy items should be expanded initially or not.
AutoExpandItemsAfterFilter
Gets or sets value which controls whether the hierarchy items should be expanded after filtering.
Declaration
public bool AutoExpandItemsAfterFilter { get; set; }
Property Value
AutoLoadHierarchy
Gets or sets value indicating if the hierarchy should be loaded initially or not.
DragCueItemTemplate
Gets or sets the template for the drag cue.
Declaration
public DataTemplate DragCueItemTemplate { get; set; }
Property Value
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.
HierarchyIndent
Gets or sets the indent of the hierarchy expand button.
IsDragDropEnabled
Gets or sets a value indicating whether drag and drop is enabled.
IsDragPreviewEnabled
Gets or sets a value indicating whether drag feedback is shown while dragging.
IsDragTooltipEnabled
Gets or sets a value indicating whether drag tooltip is shown while dragging.
IsDropPreviewLineEnabled
Gets or sets a value indicating whether drag outline is shown while dragging.
Declaration
public bool IsDropPreviewLineEnabled { get; set; }
Property Value
TreeLinesBrush
Gets or sets value indicating the TreeLinesBrush.
Declaration
public Brush TreeLinesBrush { get; set; }
Property Value
Brush
TreeLinesStrokeThickness
Gets or sets value indicating the TreeLinesStroke thickness.
Declaration
public double TreeLinesStrokeThickness { get; set; }
Property Value
TreeLinesVisibility
Gets or sets value indicating the TreeLinesVisibility.
Declaration
public TreeLinesVisibility TreeLinesVisibility { get; set; }
Property Value
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
element
DependencyObject
The container element.
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
item
Returns
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
AutomationPeer
OnDragEnded(RadTreeListViewDragEndedEventArgs)
Raises the event.
Declaration
protected virtual void OnDragEnded(RadTreeListViewDragEndedEventArgs e)
Parameters
e
RadTreeListViewDragEndedEventArgs
The RadTreeListViewDragEndedEventArgs instance containing the event data.
OnDragStarted(RadTreeListViewDragEventArgs)
Raises the event.
Declaration
protected virtual void OnDragStarted(RadTreeListViewDragEventArgs e)
Parameters
e
The RadTreeListViewDragEventArgs instance containing the event data.
OnInitialized(EventArgs)
Declaration
protected override void OnInitialized(EventArgs e)
Parameters
e
Overrides
OnItemsCollectionChanged(object, NotifyCollectionChangedEventArgs)
Called when this.Items collection changes.
Declaration
protected override void OnItemsCollectionChanged(object sender, NotifyCollectionChangedEventArgs e)
Parameters
sender
The sender.
e
NotifyCollectionChangedEventArgs
The NotifyCollectionChangedEventArgs instance containing the event data.
Overrides
OnPreviewDragEnded(RadTreeListViewDragEndedEventArgs)
Raises the event.
Declaration
protected virtual bool OnPreviewDragEnded(RadTreeListViewDragEndedEventArgs e)
Parameters
e
RadTreeListViewDragEndedEventArgs
The RadTreeListViewDragEndedEventArgs instance containing the event data.
Returns
OnPreviewDragStarted(RadTreeListViewDragEventArgs)
Raises the event.
Declaration
protected virtual bool OnPreviewDragStarted(RadTreeListViewDragEventArgs e)
Parameters
e
The RadTreeListViewDragEventArgs instance containing the event data.
Returns
PrepareContainerForItemOverride(DependencyObject, object)
Prepares the specified element to display the specified item.
Declaration
protected override void PrepareContainerForItemOverride(DependencyObject element, object item)
Parameters
element
DependencyObject
item
Overrides
ResetTheme()
Resets the theme of the RadTreeListView.
Declaration
public void ResetTheme()
ScrollIntoView(object, GridViewColumn, bool)
Scrolls a cell into view.
Declaration
public void ScrollIntoView(object dataItem, GridViewColumn column, bool expandItem)
Parameters
dataItem
The item to scroll into view.
column
The column to scroll into view.
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.
ScrollIntoView(object, bool)
Scrolls the row containing the data item into view.
ScrollIntoViewAsync(object, Action<FrameworkElement>, Action, bool)
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
dataItem
The item to scroll into view.
scrollFinishedCallback
Action<FrameworkElement>
The method to execute when scrolling has finished.
scrollFailedCallback
The method to execute when scrolling has failed.
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>, bool)
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
dataItem
The item to scroll into view.
scrollFinishedCallback
Action<FrameworkElement>
The method to execute when scrolling has finished.
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, bool)
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
dataItem
The data item to scroll into view.
column
The column to scroll into view.
scrollFinishedCallback
Action<FrameworkElement>
The method to execute when scrolling has finished.
scrollFailedCallback
The method to execute when scrolling has failed.
expandItem
Indicates whether to expand the item or not.
ScrollIntoViewAsync(object, GridViewColumn, Action<FrameworkElement>, bool)
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
dataItem
The item to scroll into view.
column
The column to scroll into view.
scrollFinishedCallback
Action<FrameworkElement>
The method to execute when scrolling has finished.
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
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 Value