Class IgbTreeItem

The tree-item component represents a child item of the tree component or another tree item.

Inheritance
System.Object
BaseRendererControl
IgbTreeItem
Implements
System.IDisposable
Inherited Members
Namespace: IgniteUI.Blazor.Controls
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbTreeItem : BaseRendererControl, RefSink, JsonSerializable, IDisposable

Constructors

IgbTreeItem()

Declaration
public IgbTreeItem()

Properties

Active

Marks the item as the tree's active item.

Declaration
public bool Active { get; set; }
Property Value
Type Description
System.Boolean

DefaultEventBehavior

Declaration
protected override ControlEventBehavior DefaultEventBehavior { get; }
Property Value
Type Description
ControlEventBehavior
Overrides

DirectRenderElementName

Declaration
protected override string DirectRenderElementName { get; }
Property Value
Type Description
System.String
Overrides

Disabled

Get/Set whether the tree item is disabled. Disabled items are ignored for user interactions.

Declaration
public bool Disabled { get; set; }
Property Value
Type Description
System.Boolean

Expanded

The tree item expansion state.

Declaration
public bool Expanded { get; set; }
Property Value
Type Description
System.Boolean

Label

The tree item label.

Declaration
public string Label { get; set; }
Property Value
Type Description
System.String

Level

The depth of the item, relative to the root.

Declaration
public double Level { get; set; }
Property Value
Type Description
System.Double

Loading

To be used for load-on-demand scenarios in order to specify whether the item is loading data.

Declaration
public bool Loading { get; set; }
Property Value
Type Description
System.Boolean

Parent

The parent item of the current tree item (if any)

Declaration
public IgbTreeItem Parent { get; set; }
Property Value
Type Description
IgbTreeItem

Selected

The tree item selection state.

Declaration
public bool Selected { get; set; }
Property Value
Type Description
System.Boolean

SupportsVisualChildren

Declaration
protected override bool SupportsVisualChildren { get; }
Property Value
Type Description
System.Boolean
Overrides

TreeParent

Declaration
protected BaseRendererControl TreeParent { get; set; }
Property Value
Type Description
BaseRendererControl

Type

Declaration
public override string Type { get; }
Property Value
Type Description
System.String
Overrides

UseDirectRender

Declaration
protected override bool UseDirectRender { get; }
Property Value
Type Description
System.Boolean
Overrides

Value

The value entry that the tree item is visualizing. Required for searching through items. @type any

Declaration
public object Value { get; set; }
Property Value
Type Description
System.Object

Methods

Collapse()

Declaration
public void Collapse()

CollapseAsync()

Collapses the tree item.

Declaration
public Task CollapseAsync()
Returns
Type Description
System.Threading.Tasks.Task

CollapseWithEvent()

Declaration
public void CollapseWithEvent()

CollapseWithEventAsync()

@private Collapses the tree item.

Declaration
public Task CollapseWithEventAsync()
Returns
Type Description
System.Threading.Tasks.Task

ConnectedCallback()

Declaration
public void ConnectedCallback()

ConnectedCallbackAsync()

Declaration
public Task ConnectedCallbackAsync()
Returns
Type Description
System.Threading.Tasks.Task

DisconnectedCallback()

Declaration
public void DisconnectedCallback()

DisconnectedCallbackAsync()

Declaration
public Task DisconnectedCallbackAsync()
Returns
Type Description
System.Threading.Tasks.Task

Dispose()

Declaration
public void Dispose()

EnsureModulesLoaded()

Declaration
protected override void EnsureModulesLoaded()
Overrides

Expand()

Declaration
public void Expand()

ExpandAsync()

Expands the tree item.

Declaration
public Task ExpandAsync()
Returns
Type Description
System.Threading.Tasks.Task

ExpandWithEvent()

Declaration
public void ExpandWithEvent()

ExpandWithEventAsync()

@private Expands the tree item.

Declaration
public Task ExpandWithEventAsync()
Returns
Type Description
System.Threading.Tasks.Task

FindByName(String)

Declaration
public override object FindByName(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
System.Object
Overrides

GetPath()

Declaration
public IgbTreeItem[] GetPath()
Returns
Type Description
IgbTreeItem[]

GetPathAsync()

Declaration
public Task<IgbTreeItem[]> GetPathAsync()
Returns
Type Description
System.Threading.Tasks.Task<IgbTreeItem[]>

OnInitializedAsync()

Declaration
protected override Task OnInitializedAsync()
Returns
Type Description
System.Threading.Tasks.Task

ResolveDisplay()

Declaration
protected override string ResolveDisplay()
Returns
Type Description
System.String
Overrides

SetNativeElement(Object)

Declaration
public void SetNativeElement(object element)
Parameters
Type Name Description
System.Object element

SetNativeElementAsync(Object)

Declaration
public Task SetNativeElementAsync(object element)
Parameters
Type Name Description
System.Object element
Returns
Type Description
System.Threading.Tasks.Task

Toggle()

Declaration
public void Toggle()

ToggleAsync()

Toggles tree item expansion state.

Declaration
public Task ToggleAsync()
Returns
Type Description
System.Threading.Tasks.Task

Implements

System.IDisposable