Class IgbHierarchicalGrid

Hierarchical grid @igxModule IgxHierarchicalGridModule

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

Constructors

IgbHierarchicalGrid()

Declaration
public IgbHierarchicalGrid()

Properties

ActualChildLayoutList

Declaration
public IgbRowIslandCollection ActualChildLayoutList { get; }
Property Value
Type Description
IgbRowIslandCollection

ChildLayoutList

@hidden

Declaration
public IgbRowIslandCollection ChildLayoutList { get; protected set; }
Property Value
Type Description
IgbRowIslandCollection

ContentChildLayoutList

Declaration
public IgbRowIslandCollection ContentChildLayoutList { get; }
Property Value
Type Description
IgbRowIslandCollection

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

ExpandChildren

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

Id

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

ParentTypeName

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

TotalItemCount

Gets/Sets the total number of records in the data source. @remarks This property is required for remote grid virtualization to function when it is bound to remote data. @example

const itemCount = this.grid1.totalItemCount;
this.grid1.totalItemCount = 55;
Declaration
public double TotalItemCount { get; set; }
Property Value
Type Description
System.Double

Type

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

Methods

EnsureModulesLoaded()

Declaration
protected override void EnsureModulesLoaded()
Overrides

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
Type Description
IgbCellType

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
Type Description
IgbCellType

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>

GetDefaultExpandState(Object)

Declaration
public void GetDefaultExpandState(object record)
Parameters
Type Name Description
System.Object record

GetDefaultExpandStateAsync(Object)

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

GetForeignKey()

Declaration
public object GetForeignKey()
Returns
Type Description
System.Object

GetForeignKeyAsync()

Declaration
public Task<object> GetForeignKeyAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Object>

GetRowByIndex(Double)

Declaration
public IgbRowType GetRowByIndex(double index)
Parameters
Type Name Description
System.Double index
Returns
Type Description
IgbRowType

GetRowByIndexAsync(Double)

Returns the RowType by index. @example

const myRow = this.grid1.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
Type Description
IgbRowType

GetRowByKeyAsync(Object)

Returns the RowType by key. @example

const myRow = this.grid1.getRowByKey(1);

key

Declaration
public Task<IgbRowType> GetRowByKeyAsync(object key)
Parameters
Type Name Description
System.Object key
Returns
Type Description
System.Threading.Tasks.Task<IgbRowType>

GetSelectedCells()

Declaration
public IgbCellType[] GetSelectedCells()
Returns
Type Description
IgbCellType[]

GetSelectedCellsAsync()

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

PinRow(Object, Double)

Declaration
public bool PinRow(object rowID, double index = -1)
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 = -1)
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