The tree allows users to represent hierarchical data in a tree-view structure, maintaining parent-child relationships, as well as to define static tree-view structure without a corresponding data model.
Inheritance
object
ComponentBase
Implements
- IComponent
- IHandleEvent
- IHandleAfterRender
- JsonSerializable
- IDisposable
Constructors
Section titled "Constructors"constructor
public IgbTree()Returns IgbTree
Properties
Section titled "Properties"IgBlazor
Section titled "IgBlazor"Inherited from: BaseRendererControl
[Inject]
protected IIgniteUIBlazor IgBlazor { get; set; }Height
Section titled "Height"Inherited from: BaseRendererControl
[Parameter]
public string Height { get; set; }Width
Section titled "Width"Inherited from: BaseRendererControl
[Parameter]
public string Width { get; set; }Class
Section titled "Class"Inherited from: BaseRendererControl
[Parameter]
public string Class { get; set; }AdditionalAttributes
Section titled "AdditionalAttributes"Inherited from: BaseRendererControl
[Parameter(CaptureUnmatchedValues = true)]
public Dictionary<string, object> AdditionalAttributes { get; set; }EventBehavior
Section titled "EventBehavior"Inherited from: BaseRendererControl
Gets or sets how events are bubbled up from JavaScript to Blazor.
[Parameter]
public ControlEventBehavior EventBehavior { get; set; }ChildContent
Section titled "ChildContent"Inherited from: BaseRendererControl
[Parameter]
public RenderFragment ChildContent { get; set; }RoundTripDateConversion
Section titled "RoundTripDateConversion"Inherited from: BaseRendererControl
Gets or sets what type of date conversion to make when round tripping dates.
[Parameter]
public RoundTripDateConversion RoundTripDateConversion { get; set; }NeedsDynamicContent
Section titled "NeedsDynamicContent"Inherited from: BaseRendererControl
protected virtual bool NeedsDynamicContent { get; }UseCamelEnumValues
Section titled "UseCamelEnumValues"Inherited from: BaseRendererControl
protected virtual bool UseCamelEnumValues { get; }ContentItems
Section titled "ContentItems"public IgbTreeItemCollection ContentItems { get; }DefaultEventBehavior
Section titled "DefaultEventBehavior"Gets the components default event behavior.
protected override ControlEventBehavior DefaultEventBehavior { get; }DirectRenderElementName
Section titled "DirectRenderElementName"protected override string DirectRenderElementName { get; }ParentTypeName
Section titled "ParentTypeName"protected override string ParentTypeName { get; }Selection
Section titled "Selection"The selection state of the tree.
[Parameter]
public TreeSelection Selection { get; set; }SingleBranchExpand
Section titled "SingleBranchExpand"Whether a single or multiple of a parent's child items can be expanded.
[Parameter]
public bool SingleBranchExpand { get; set; }SupportsVisualChildren
Section titled "SupportsVisualChildren"protected override bool SupportsVisualChildren { get; }ToggleNodeOnClick
Section titled "ToggleNodeOnClick"Whether clicking over nodes will change their expanded state or not.
[Parameter]
public bool ToggleNodeOnClick { get; set; }public override string Type { get; }UseDirectRender
Section titled "UseDirectRender"protected override bool UseDirectRender { get; }Accessors
Section titled "Accessors"eventCallbacksCache
Section titled "eventCallbacksCache"Inherited from: BaseRendererControl
protected Dictionary<Type, Dictionary<string, FieldInfo>> eventCallbacksCache_cachedSerializedContent
Section titled "_cachedSerializedContent"Inherited from: BaseRendererControl
protected string _cachedSerializedContentMethods
Section titled "Methods"ResolveEventBehavior()
Section titled "ResolveEventBehavior()"Inherited from: BaseRendererControl
Resolves the components event behavior if Auto is selected.
protected ControlEventBehavior ResolveEventBehavior()Returns any
ToSpinal(string)
Section titled "ToSpinal(string)"Inherited from: BaseRendererControl
protected string ToSpinal(string value)Parameters
- value:
string
Returns any
TransformSimpleKey(string)
Section titled "TransformSimpleKey(string)"Inherited from: BaseRendererControl
protected virtual string TransformSimpleKey(string key)Parameters
- key:
string
Returns any
IsTransformedEnumValue(string)
Section titled "IsTransformedEnumValue(string)"Inherited from: BaseRendererControl
protected virtual bool IsTransformedEnumValue(string key)Parameters
- key:
string
Returns any
TransformPotentialEnumValue(string, object)
Section titled "TransformPotentialEnumValue(string, object)"Inherited from: BaseRendererControl
protected virtual object TransformPotentialEnumValue(string key, object value)Parameters
- key:
string - value:
object
Returns any
BuildSequenceInfo(int)
Section titled "BuildSequenceInfo(int)"Inherited from: BaseRendererControl
protected virtual SequenceInfo BuildSequenceInfo(int startSequence)Parameters
- startSequence:
int
Returns any
BuildRenderTree(RenderTreeBuilder)
Section titled "BuildRenderTree(RenderTreeBuilder)"Inherited from: BaseRendererControl
protected override void BuildRenderTree(RenderTreeBuilder builder)Parameters
- builder:
RenderTreeBuilder
Returns any
TemplateContentType(string)
Section titled "TemplateContentType(string)"Inherited from: BaseRendererControl
protected Type TemplateContentType(string templateId)Parameters
- templateId:
string
Returns any
OnAfterRenderAsync(bool)
Section titled "OnAfterRenderAsync(bool)"Inherited from: BaseRendererControl
protected override Task OnAfterRenderAsync(bool firstRender)Parameters
- firstRender:
bool
Returns any
EnsureReady()
Section titled "EnsureReady()"Inherited from: BaseRendererControl
public Task EnsureReady()Returns any
MarkPropDirty(string)
Section titled "MarkPropDirty(string)"Inherited from: BaseRendererControl
protected void MarkPropDirty(string propertyName)Parameters
- propertyName:
string
Returns any
IsPropDirty(string)
Section titled "IsPropDirty(string)"Inherited from: BaseRendererControl
protected bool IsPropDirty(string propertyName)Parameters
- propertyName:
string
Returns any
Serialize(SerializationContext, string)
Section titled "Serialize(SerializationContext, string)"Inherited from: BaseRendererControl
public void Serialize(SerializationContext context, string propertyName = null)Parameters
- context:
SerializationContext - propertyName:
string
Returns any
Serialize()
Section titled "Serialize()"Inherited from: BaseRendererControl
public string Serialize()Returns any
InvokeMethod(string, object[], string[], ElementReference[])
Section titled "InvokeMethod(string, object[], string[], ElementReference[])"Inherited from: BaseRendererControl
protected Task<object> InvokeMethod(string methodName, object[] arguments, string[] types, ElementReference[] nativeElements = null)Parameters
- methodName:
string - arguments:
object[] - types:
string[] - nativeElements:
ElementReference[]
Returns any
InvokeMethodSync(string, object[], string[], ElementReference[])
Section titled "InvokeMethodSync(string, object[], string[], ElementReference[])"Inherited from: BaseRendererControl
protected object InvokeMethodSync(string methodName, object[] arguments, string[] types, ElementReference[] nativeElements = null)Parameters
- methodName:
string - arguments:
object[] - types:
string[] - nativeElements:
ElementReference[]
Returns any
SuspendNotifications(object)
Section titled "SuspendNotifications(object)"Inherited from: BaseRendererControl
Prevents data change notifications from be propagated to the component.
public void SuspendNotifications(object dataSource)Parameters
- dataSource:
object
Returns any
ResumeNotifications(object, bool)
Section titled "ResumeNotifications(object, bool)"Inherited from: BaseRendererControl
Resumes data change notifications.
public void ResumeNotifications(object dataSource, bool notify = true)Parameters
- dataSource:
object - notify:
bool
Returns any
NotifyInsertItem(object, int, object)
Section titled "NotifyInsertItem(object, int, object)"Inherited from: BaseRendererControl
public void NotifyInsertItem(object dataSource, int index, object refItem)Parameters
- dataSource:
object - index:
int - refItem:
object
Returns any
NotifyRemoveItem(object, int, object)
Section titled "NotifyRemoveItem(object, int, object)"Inherited from: BaseRendererControl
public void NotifyRemoveItem(object dataSource, int index, object oldItem)Parameters
- dataSource:
object - index:
int - oldItem:
object
Returns any
NotifyClearItems(object)
Section titled "NotifyClearItems(object)"Inherited from: BaseRendererControl
public void NotifyClearItems(object dataSource)Parameters
- dataSource:
object
Returns any
NotifySetItem(object, int, object, object)
Section titled "NotifySetItem(object, int, object, object)"Inherited from: BaseRendererControl
public void NotifySetItem(object dataSource, int index, object oldItem, object newItem)Parameters
- dataSource:
object - index:
int - oldItem:
object - newItem:
object
Returns any
NotifyUpdateItem(object, int, object, bool)
Section titled "NotifyUpdateItem(object, int, object, bool)"Inherited from: BaseRendererControl
public void NotifyUpdateItem(object dataSource, int index, object refItem, bool syncDataOnly = false)Parameters
- dataSource:
object - index:
int - refItem:
object - syncDataOnly:
bool
Returns any
OnRefChanged(string, object)
Section titled "OnRefChanged(string, object)"Inherited from: BaseRendererControl
public void OnRefChanged(string refName, object refValue)Parameters
- refName:
string - refValue:
object
Returns any
OnInvokeReturn(long, object)
Section titled "OnInvokeReturn(long, object)"Inherited from: BaseRendererControl
public void OnInvokeReturn(long invokeId, object returnValue)Parameters
- invokeId:
long - returnValue:
object
Returns any
Camelize(string)
Section titled "Camelize(string)"Inherited from: BaseRendererControl
protected string Camelize(string value)Parameters
- value:
string
Returns any
ToPascal(string)
Section titled "ToPascal(string)"Inherited from: BaseRendererControl
protected string ToPascal(string value)Parameters
- value:
string
Returns any
OnElementNameChanged(BaseRendererElement, string, string)
Section titled "OnElementNameChanged(BaseRendererElement, string, string)"Inherited from: BaseRendererControl
protected void OnElementNameChanged(BaseRendererElement element, string oldName, string newName)Parameters
- element:
BaseRendererElement - oldName:
string - newName:
string
Returns any
Dispose(bool)
Section titled "Dispose(bool)"Inherited from: BaseRendererControl
protected virtual void Dispose(bool disposing)Parameters
- disposing:
bool
Returns any
SetResourceStringAsync(string, string, string)
Section titled "SetResourceStringAsync(string, string, string)"Inherited from: BaseRendererControl
public Task<object> SetResourceStringAsync(string grouping, string id, string value)Parameters
- grouping:
string - id:
string - value:
string
Returns any
SetResourceStringAsync(string, string)
Section titled "SetResourceStringAsync(string, string)"Inherited from: BaseRendererControl
public Task<object> SetResourceStringAsync(string grouping, string json)Parameters
- grouping:
string - json:
string
Returns any
SetPropertyValue(object, PropertyInfo, JsonElement)
Section titled "SetPropertyValue(object, PropertyInfo, JsonElement)"Inherited from: BaseRendererControl
protected void SetPropertyValue(object item, PropertyInfo property, JsonElement jsonElement)Parameters
- item:
object - property:
PropertyInfo - jsonElement:
JsonElement
Returns any
SetPropertyValue(object, PropertyInfo, object)
Section titled "SetPropertyValue(object, PropertyInfo, object)"Inherited from: BaseRendererControl
protected void SetPropertyValue(object item, PropertyInfo property, object value)Parameters
- item:
object - property:
PropertyInfo - value:
object
Returns any
Dispose()
Section titled "Dispose()"Inherited from: BaseRendererControl
public void Dispose()Returns any
ConnectedCallback()
Section titled "ConnectedCallback()"public void ConnectedCallback()Returns any
ConnectedCallbackAsync()
Section titled "ConnectedCallbackAsync()"public Task ConnectedCallbackAsync()Returns any
EnsureModulesLoaded()
Section titled "EnsureModulesLoaded()"protected override void EnsureModulesLoaded()Returns any
FindByName(string)
Section titled "FindByName(string)"public override object FindByName(string name)Parameters
- name:
string
Returns any
ResolveDisplay()
Section titled "ResolveDisplay()"protected override string ResolveDisplay()Returns any
SetNativeElement(object)
Section titled "SetNativeElement(object)"public void SetNativeElement(object element)Parameters
- element:
object
Returns any
SetNativeElementAsync(object)
Section titled "SetNativeElementAsync(object)"public Task SetNativeElementAsync(object element)Parameters
- element:
object
Returns any
Events
Section titled "Events"ActiveItem
Section titled "ActiveItem"[Parameter]
public EventCallback<IgbTreeItemComponentEventArgs> ActiveItem { get; set; }ItemCollapsed
Section titled "ItemCollapsed"[Parameter]
public EventCallback<IgbTreeItemComponentEventArgs> ItemCollapsed { get; set; }ItemCollapsing
Section titled "ItemCollapsing"[Parameter]
public EventCallback<IgbTreeItemComponentEventArgs> ItemCollapsing { get; set; }ItemExpanded
Section titled "ItemExpanded"[Parameter]
public EventCallback<IgbTreeItemComponentEventArgs> ItemExpanded { get; set; }ItemExpanding
Section titled "ItemExpanding"[Parameter]
public EventCallback<IgbTreeItemComponentEventArgs> ItemExpanding { get; set; }SelectionChanged
Section titled "SelectionChanged"[Parameter]
public EventCallback<IgbTreeSelectionEventArgs> SelectionChanged { get; set; }ActiveItemScript
Section titled "ActiveItemScript"[Parameter]
public string ActiveItemScript { get; set; }ItemCollapsedScript
Section titled "ItemCollapsedScript"[Parameter]
public string ItemCollapsedScript { get; set; }ItemCollapsingScript
Section titled "ItemCollapsingScript"[Parameter]
public string ItemCollapsingScript { get; set; }ItemExpandedScript
Section titled "ItemExpandedScript"[Parameter]
public string ItemExpandedScript { get; set; }ItemExpandingScript
Section titled "ItemExpandingScript"[Parameter]
public string ItemExpandingScript { get; set; }SelectionChangedScript
Section titled "SelectionChangedScript"[Parameter]
public string SelectionChangedScript { get; set; }