Class IgbTreeGrid
Inheritance
System.Object
IgbTreeGrid
Implements
System.IDisposable
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbTreeGrid : IgbGridBaseDirective, JsonSerializable
Constructors
IgbTreeGrid()
Declaration
Properties
CascadeOnDelete
Declaration
public bool CascadeOnDelete { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
ChildDataKey
Declaration
public string ChildDataKey { get; set; }
Property Value
Type |
Description |
System.String |
|
Data
Declaration
public object Data { get; set; }
Property Value
Type |
Description |
System.Object |
|
DataScript
Provides a means of setting Data in the JavaScript environment.
Declaration
public string DataScript { get; set; }
Property Value
Type |
Description |
System.String |
|
ExpansionDepth
Declaration
public double ExpansionDepth { get; set; }
Property Value
Type |
Description |
System.Double |
|
ForeignKey
Declaration
public string ForeignKey { get; set; }
Property Value
Type |
Description |
System.String |
|
HasChildrenKey
Declaration
public string HasChildrenKey { get; set; }
Property Value
Type |
Description |
System.String |
|
Id
Declaration
public string Id { get; set; }
Property Value
Type |
Description |
System.String |
|
ProcessedRootRecords
Returns an array of processed (filtered and sorted) root ITreeGridRecord
s.
// gets the processed root record with index=2
const states = this.grid.processedRootRecords[2];
@memberof IgxTreeGridComponent
Declaration
public IgbTreeGridRecord[] ProcessedRootRecords { get; set; }
Property Value
RootRecords
Returns an array of the root level ITreeGridRecord
s.
// gets the root record with index=2
const states = this.grid.rootRecords[2];
@memberof IgxTreeGridComponent
Declaration
public IgbTreeGridRecord[] RootRecords { get; set; }
Property Value
RowLoadingIndicatorTemplate
Declaration
public RenderFragment<object> RowLoadingIndicatorTemplate { get; set; }
Property Value
Type |
Description |
Microsoft.AspNetCore.Components.RenderFragment<System.Object> |
|
RowLoadingIndicatorTemplateScript
Provides a means of setting RowLoadingIndicatorTemplate in the JavaScript environment.
Declaration
public string RowLoadingIndicatorTemplateScript { get; set; }
Property Value
Type |
Description |
System.String |
|
Type
Declaration
public override string Type { get; }
Property Value
Type |
Description |
System.String |
|
Overrides
Methods
AddRow(Object, Object)
Declaration
public void AddRow(object item, object parentRowID)
Parameters
Type |
Name |
Description |
System.Object |
item |
|
System.Object |
parentRowID |
|
AddRowAsync(Object, Object)
Declaration
public Task AddRowAsync(object item, object parentRowID)
Parameters
Type |
Name |
Description |
System.Object |
item |
|
System.Object |
parentRowID |
|
Returns
Type |
Description |
System.Threading.Tasks.Task |
|
BeginAddRowByIndex(Double, Boolean)
Declaration
public void BeginAddRowByIndex(double index, bool asChild)
Parameters
Type |
Name |
Description |
System.Double |
index |
|
System.Boolean |
asChild |
|
BeginAddRowByIndexAsync(Double, Boolean)
Declaration
public Task BeginAddRowByIndexAsync(double index, bool asChild)
Parameters
Type |
Name |
Description |
System.Double |
index |
|
System.Boolean |
asChild |
|
Returns
Type |
Description |
System.Threading.Tasks.Task |
|
CollapseAll()
Declaration
public void CollapseAll()
CollapseAllAsync()
Collapses all rows.
this.grid.collapseAll();
@memberof IgxTreeGridComponent
Declaration
public Task CollapseAllAsync()
Returns
Type |
Description |
System.Threading.Tasks.Task |
|
EnsureModulesLoaded()
Declaration
protected override void EnsureModulesLoaded()
Overrides
ExpandAll()
Declaration
ExpandAllAsync()
Expands all rows.
this.grid.expandAll();
@memberof IgxTreeGridComponent
Declaration
public Task ExpandAllAsync()
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
GetCellByColumn(Double, String)
Declaration
public IgbCellType GetCellByColumn(double rowIndex, string columnField)
Parameters
Type |
Name |
Description |
System.Double |
rowIndex |
|
System.String |
columnField |
|
Returns
GetCellByColumnAsync(Double, String)
Declaration
public Task<IgbCellType> GetCellByColumnAsync(double rowIndex, string columnField)
Parameters
Type |
Name |
Description |
System.Double |
rowIndex |
|
System.String |
columnField |
|
Returns
Type |
Description |
System.Threading.Tasks.Task<IgbCellType> |
|
GetCellByKey(Object, String)
Declaration
public IgbCellType GetCellByKey(object rowSelector, string columnField)
Parameters
Type |
Name |
Description |
System.Object |
rowSelector |
|
System.String |
columnField |
|
Returns
GetCellByKeyAsync(Object, String)
Declaration
public Task<IgbCellType> GetCellByKeyAsync(object rowSelector, string columnField)
Parameters
Type |
Name |
Description |
System.Object |
rowSelector |
|
System.String |
columnField |
|
Returns
Type |
Description |
System.Threading.Tasks.Task<IgbCellType> |
|
GetData()
Declaration
protected override object GetData()
Returns
Type |
Description |
System.Object |
|
Overrides
GetDefaultExpandState(IgbTreeGridRecord)
Declaration
public void GetDefaultExpandState(IgbTreeGridRecord record)
Parameters
GetDefaultExpandStateAsync(IgbTreeGridRecord)
Declaration
public Task GetDefaultExpandStateAsync(IgbTreeGridRecord record)
Parameters
Returns
Type |
Description |
System.Threading.Tasks.Task |
|
GetRowByIndex(Double)
Declaration
public IgbRowType GetRowByIndex(double index)
Parameters
Type |
Name |
Description |
System.Double |
index |
|
Returns
GetRowByIndexAsync(Double)
Returns the IgxTreeGridRow
by index.
@example
const myRow = treeGrid.getRowByIndex(1);
index
Declaration
public Task<IgbRowType> GetRowByIndexAsync(double index)
Parameters
Type |
Name |
Description |
System.Double |
index |
|
Returns
Type |
Description |
System.Threading.Tasks.Task<IgbRowType> |
|
GetRowByKey(Object)
Declaration
public IgbRowType GetRowByKey(object key)
Parameters
Type |
Name |
Description |
System.Object |
key |
|
Returns
GetRowByKeyAsync(Object)
Returns the RowType
object by the specified primary key.
@example
const myRow = this.treeGrid.getRowByIndex(1);
index
Declaration
public Task<IgbRowType> GetRowByKeyAsync(object key)
Parameters
Type |
Name |
Description |
System.Object |
key |
|
Returns
Type |
Description |
System.Threading.Tasks.Task<IgbRowType> |
|
GetSelectedData(Boolean, Boolean)
Declaration
public object[] GetSelectedData(bool formatters, bool headers)
Parameters
Type |
Name |
Description |
System.Boolean |
formatters |
|
System.Boolean |
headers |
|
Returns
Type |
Description |
System.Object[] |
|
GetSelectedDataAsync(Boolean, Boolean)
Declaration
public Task<object[]> GetSelectedDataAsync(bool formatters, bool headers)
Parameters
Type |
Name |
Description |
System.Boolean |
formatters |
|
System.Boolean |
headers |
|
Returns
Type |
Description |
System.Threading.Tasks.Task<System.Object[]> |
|
PinRow(Object, Double)
Declaration
public bool PinRow(object rowID, double index)
Parameters
Type |
Name |
Description |
System.Object |
rowID |
|
System.Double |
index |
|
Returns
Type |
Description |
System.Boolean |
|
PinRowAsync(Object, Double)
Declaration
public Task<bool> PinRowAsync(object rowID, double index)
Parameters
Type |
Name |
Description |
System.Object |
rowID |
|
System.Double |
index |
|
Returns
Type |
Description |
System.Threading.Tasks.Task<System.Boolean> |
|
UnpinRow(Object)
Declaration
public bool UnpinRow(object rowID)
Parameters
Type |
Name |
Description |
System.Object |
rowID |
|
Returns
Type |
Description |
System.Boolean |
|
UnpinRowAsync(Object)
Declaration
public Task<bool> UnpinRowAsync(object rowID)
Parameters
Type |
Name |
Description |
System.Object |
rowID |
|
Returns
Type |
Description |
System.Threading.Tasks.Task<System.Boolean> |
|
Implements
System.IDisposable