ClassRadTreeView
Represents a hierarchical collection of items. Supports expand and collapse, single and multiple selection, item styles and templates. Use the Descriptors property to specify a descriptor for each item type that you want displayed. In the TreeViewDescriptor you must set the TargetType to the corresponding item type.
Definition
Namespace:Telerik.Maui.Controls
Assembly:Telerik.Maui.Controls.dll
Syntax:
public class RadTreeView : RadSelectableItemsView, IRadContentView, IContentView, IView, IElement, ITransform, IPadding, ICrossPlatformLayoutInheritance: objectRadContentViewRadCompositeContentViewRadBorderContentViewRadItemsViewRadSelectableItemsViewRadTreeView
Implements:
Inherited Members
Constructors
RadTreeView()
Initializes a new instance of the RadTreeView class.
Declaration
public RadTreeView()Fields
CheckBoxModeProperty
Identifies the CheckBoxMode property.
Declaration
public static readonly BindableProperty CheckBoxModePropertyField Value
BindableProperty
CheckedItemsProperty
Identifies the CheckedItems property.
Declaration
public static readonly BindableProperty CheckedItemsPropertyField Value
BindableProperty
DescriptorsProperty
Identifies the Descriptors property.
Declaration
public static readonly BindableProperty DescriptorsPropertyField Value
BindableProperty
IsLoadChildrenOnDemandEnabledProperty
Identifies the IsLoadChildrenOnDemandEnabled property.
Declaration
public static readonly BindableProperty IsLoadChildrenOnDemandEnabledPropertyField Value
BindableProperty
ItemCheckedCommandProperty
Identifies the ItemCheckedCommand property.
Declaration
public static readonly BindableProperty ItemCheckedCommandPropertyField Value
BindableProperty
ItemCollapsedCommandProperty
Identifies the ItemCollapsedCommand property.
Declaration
public static readonly BindableProperty ItemCollapsedCommandPropertyField Value
BindableProperty
ItemExpandedCommandProperty
Identifies the ItemExpandedCommand property.
Declaration
public static readonly BindableProperty ItemExpandedCommandPropertyField Value
BindableProperty
ItemUncheckedCommandProperty
Identifies the ItemUncheckedCommand property.
Declaration
public static readonly BindableProperty ItemUncheckedCommandPropertyField Value
BindableProperty
LevelIndentationProperty
Identifies the LevelIndentation property.
Declaration
public static readonly BindableProperty LevelIndentationPropertyField Value
BindableProperty
LoadChildrenOnDemandCommandProperty
Identifies the LoadChildrenOnDemandCommand property.
Declaration
public static readonly BindableProperty LoadChildrenOnDemandCommandPropertyField Value
BindableProperty
ScrollOrientationProperty
Identifies the ScrollOrientation property.
Declaration
public static readonly BindableProperty ScrollOrientationPropertyField Value
BindableProperty
Properties
CheckAllCommand
Gets a command to check all items in the control.
CheckBoxMode
Gets or sets the mode of the check boxes in the control. For more information see the TreeViewCheckBoxMode type.
Declaration
public TreeViewCheckBoxMode CheckBoxMode { get; set; }Property Value
CheckCommand
Gets a command to check a specific item in the control. The command accepts a parameter specifying the path to the item. The path is a collection if unique identifiers of items. The first element of the path identifies an item at the root level. The second element of the path identifies a child of the root item etc. The IdentityMemberPath property can be used to specify the unique identifier at each level of the hierarchy.
CheckedItems
Gets or sets the collection of items, which are currently checked in the control.
CollapseAllCommand
Gets a command to collapse all items in the control.
CollapseCommand
Gets a command to collapse a specific item in the control. The command accepts a parameter specifying the path to the item. The path is a collection if unique identifiers of items. The first element of the path identifies an item at the root level. The second element of the path identifies a child of the root item etc. The IdentityMemberPath property can be used to specify the unique identifier at each level of the hierarchy.
Descriptors
Gets or sets a collection of TreeViewDescriptors describing the hierarchical data.
Declaration
public IList<TreeViewDescriptor> Descriptors { get; set; }Property Value
ExpandAllCommand
Gets a command to expand all items in the control.
ExpandCommand
Gets a command to expand a specific item in the control. The command accepts a parameter specifying the path to the item. The path is a collection if unique identifiers of items. The first element of the path identifies an item at the root level. The second element of the path identifies a child of the root item etc. The IdentityMemberPath property can be used to specify the unique identifier at each level of the hierarchy.
IsLoadChildrenOnDemandEnabled
Gets or sets a value indicating whether load on demand is enabled.
Declaration
public bool IsLoadChildrenOnDemandEnabled { get; set; }Property Value
ItemCheckedCommand
Gets or sets a command to execute when an item is checked after a user interaction. The command should accept a single parameter with the checked item.
Declaration
public ICommand ItemCheckedCommand { get; set; }Property Value
ItemCollapsedCommand
Gets or sets a command to execute when an item is collapsed after a user interaction. The command should accept a single parameter with the collapsed item.
Declaration
public ICommand ItemCollapsedCommand { get; set; }Property Value
ItemExpandedCommand
Gets or sets a command to execute when an item is expanded after a user interaction. The command should accept a single parameter with the expanded item.
Declaration
public ICommand ItemExpandedCommand { get; set; }Property Value
ItemUncheckedCommand
Gets or sets a command to execute when an item is unchecked after a user interaction. The command should accept a single parameter with the unchecked item.
Declaration
public ICommand ItemUncheckedCommand { get; set; }Property Value
LevelIndentation
Gets or sets the indentation in pixels between a parent item and its child items.
LoadChildrenOnDemandCommand
Gets or sets a command to execute when loading an item on demand. The command should accept a single parameter of type TreeViewLoadChildrenOnDemandCommandContext.
Declaration
public ICommand LoadChildrenOnDemandCommand { get; set; }Property Value
ScrollOrientation
Gets or sets the current scroll orientation of the control. Form ore information see the TreeViewScrollOrientation type.
Declaration
public TreeViewScrollOrientation ScrollOrientation { get; set; }Property Value
UncheckAllCommand
Gets a command to uncheck all items in the control.
UncheckCommand
Gets a command to uncheck a specific item in the control. The command accepts a parameter specifying the path to the item. The path is a collection if unique identifiers of items. The first element of the path identifies an item at the root level. The second element of the path identifies a child of the root item etc. The IdentityMemberPath property can be used to specify the unique identifier at each level of the hierarchy.
Methods
Check(IEnumerable)
Checks the item in hierarchy with the specified path.
Declaration
public bool Check(IEnumerable itemPath)Parameters
itemPath
Specifies the path to an item in the hierarchy to checked. The path is a collection if unique identifiers of items. The first element of the path identifies an item at the root level. The second element of the path identifies a child of the root item etc. The IdentityMemberPath property can be used to specify the unique identifier at each level of the hierarchy.
Returns
true if the item was found and checked successfully, false otherwise.
Check(params object[])
Checks the item in hierarchy with the specified path.
Declaration
public bool Check(params object[] itemPath)Parameters
itemPath
object[]
Specifies the path to an item in the hierarchy to checked. The path is a collection if unique identifiers of items. The first element of the path identifies an item at the root level. The second element of the path identifies a child of the root item etc. The IdentityMemberPath property can be used to specify the unique identifier at each level of the hierarchy.
Returns
true if the item was found and checked successfully, false otherwise.
Collapse(IEnumerable)
Collapses the item in hierarchy with the specified path.
Declaration
public bool Collapse(IEnumerable itemPath)Parameters
itemPath
Specifies the path to an item in the hierarchy to collapse. The path is a collection if unique identifiers of items. The first element of the path identifies an item at the root level. The second element of the path identifies a child of the root item etc. The IdentityMemberPath property can be used to specify the unique identifier at each level of the hierarchy.
Returns
true if the item was found and collapsed successfully, false otherwise.
Collapse(params object[])
Collapses the item in hierarchy with the specified path.
Declaration
public bool Collapse(params object[] itemPath)Parameters
itemPath
object[]
Specifies the path to an item in the hierarchy to collapse. The path is a collection if unique identifiers of items. The first element of the path identifies an item at the root level. The second element of the path identifies a child of the root item etc. The IdentityMemberPath property can be used to specify the unique identifier at each level of the hierarchy.
Returns
true if the item was found and collapsed successfully, false otherwise.
CollapseAll()
Collapses all items in the control.
Declaration
public void CollapseAll()Expand(IEnumerable)
Expands the item in hierarchy with the specified path.
Declaration
public bool Expand(IEnumerable itemPath)Parameters
itemPath
Specifies the path to an item in the hierarchy to expand. The path is a collection if unique identifiers of items. The first element of the path identifies an item at the root level. The second element of the path identifies a child of the root item etc. The IdentityMemberPath property can be used to specify the unique identifier at each level of the hierarchy.
Returns
true if the item was found and expanded successfully, false otherwise.
Expand(params object[])
Expands the item in hierarchy with the specified path.
Declaration
public bool Expand(params object[] itemPath)Parameters
itemPath
object[]
Specifies the path to an item in the hierarchy to expand. The path is a collection if unique identifiers of items. The first element of the path identifies an item at the root level. The second element of the path identifies a child of the root item etc. The IdentityMemberPath property can be used to specify the unique identifier at each level of the hierarchy.
Returns
true if the item was found and expanded successfully, false otherwise.
Uncheck(IEnumerable)
Unchecks the item in hierarchy with the specified path.
Declaration
public bool Uncheck(IEnumerable itemPath)Parameters
itemPath
Specifies the path to an item in the hierarchy to unchecked. The path is a collection if unique identifiers of items. The first element of the path identifies an item at the root level. The second element of the path identifies a child of the root item etc. The IdentityMemberPath property can be used to specify the unique identifier at each level of the hierarchy.
Returns
true if the item was found and unchecked successfully, false otherwise.
Uncheck(params object[])
Unchecks the item in hierarchy with the specified path.
Declaration
public bool Uncheck(params object[] itemPath)Parameters
itemPath
object[]
Specifies the path to an item in the hierarchy to unchecked. The path is a collection if unique identifiers of items. The first element of the path identifies an item at the root level. The second element of the path identifies a child of the root item etc. The IdentityMemberPath property can be used to specify the unique identifier at each level of the hierarchy.
Returns
true if the item was found and unchecked successfully, false otherwise.
UncheckAll()
Unchecks all items in the control.
Declaration
public void UncheckAll()Events
ItemChecked
Raised when an item is checked after a user interaction. For more information see the TreeViewItemViewInteractionEventArgs type.
Declaration
public event EventHandler<TreeViewItemViewInteractionEventArgs> ItemCheckedEvent Value
ItemCollapsed
Raised when an item is collapsed after a user interaction. For more information see the TreeViewItemViewInteractionEventArgs type.
Declaration
public event EventHandler<TreeViewItemViewInteractionEventArgs> ItemCollapsedEvent Value
ItemExpanded
Raised when an item is expanded after a user interaction. For more information see the TreeViewItemViewInteractionEventArgs type.
Declaration
public event EventHandler<TreeViewItemViewInteractionEventArgs> ItemExpandedEvent Value
ItemUnchecked
Raised when an item is unchecked after a user interaction. For more information see the TreeViewItemViewInteractionEventArgs type.
Declaration
public event EventHandler<TreeViewItemViewInteractionEventArgs> ItemUncheckedEvent Value
LoadChildrenOnDemand
Raised when loading an item on demand. For more information see the TreeViewLoadChildrenOnDemandEventArgs type.
Declaration
public event EventHandler<TreeViewLoadChildrenOnDemandEventArgs> LoadChildrenOnDemandEvent Value