Class IgbRowDirective

Inheritance
System.Object
BaseRendererElement
IgbRowDirective
IgbGridRow
Implements
Inherited Members
Namespace: IgniteUI.Blazor.Controls
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbRowDirective : BaseRendererElement, JsonSerializable

Constructors

IgbRowDirective()

Declaration
public IgbRowDirective()

Properties

Data

The data passed to the row component.

// get the row data for the first selected row
let selectedRowData = this.grid.selectedRows[0].data;
Declaration
public object Data { get; set; }
Property Value
Type Description
System.Object

Disabled

Sets whether this specific row has disabled functionality for editing and row selection. Default value is false.

this.grid.selectedRows[0].pinned = true;
Declaration
public bool Disabled { get; set; }
Property Value
Type Description
System.Boolean

Expanded

Gets the expanded state of the row.

let isExpanded = row.expanded;
Declaration
public bool Expanded { get; set; }
Property Value
Type Description
System.Boolean

Index

The index of the row.

// get the index of the second selected row
let selectedRowIndex = this.grid.selectedRows[1].index;
Declaration
public double Index { get; set; }
Property Value
Type Description
System.Double

Pinned

Sets whether the row is pinned. Default value is false.

this.grid.selectedRows[0].pinned = true;
Declaration
public bool Pinned { get; set; }
Property Value
Type Description
System.Boolean

Type

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

Methods

BeginAddRow()

Declaration
public void BeginAddRow()

BeginAddRowAsync()

Spawns the add row UI for the specific row. @example

const row = this.grid1.getRowByIndex(1);
row.beginAddRow();
Declaration
public Task BeginAddRowAsync()
Returns
Type Description
System.Threading.Tasks.Task

Del()

Declaration
public void Del()

DelAsync()

Removes the specified row from the grid's data source. This method emits rowDeleted event.

// delete the third selected row from the grid
this.grid.selectedRows[2].delete();
Declaration
public Task DelAsync()
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

IsCellActive(Object)

Declaration
public void IsCellActive(object visibleColumnIndex)
Parameters
Type Name Description
System.Object visibleColumnIndex

IsCellActiveAsync(Object)

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

Pin()

Declaration
public void Pin()

PinAsync()

Pins the specified row. This method emits rowPinning`rowPinned` event.

// pin the selected row from the grid
this.grid.selectedRows[0].pin();
Declaration
public Task PinAsync()
Returns
Type Description
System.Threading.Tasks.Task

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

Unpin()

Declaration
public void Unpin()

UnpinAsync()

Unpins the specified row. This method emits rowPinning`rowPinned` event.

// unpin the selected row from the grid
this.grid.selectedRows[0].unpin();
Declaration
public Task UnpinAsync()
Returns
Type Description
System.Threading.Tasks.Task

Update(Object)

Declaration
public void Update(object value)
Parameters
Type Name Description
System.Object value

UpdateAsync(Object)

Updates the specified row object and the data source record with the passed value.

// update the second selected row's value
let newValue = "Apple";
this.grid.selectedRows[1].update(newValue);
Declaration
public Task UpdateAsync(object value)
Parameters
Type Name Description
System.Object value
Returns
Type Description
System.Threading.Tasks.Task

Implements