Class IgbCellType

Interface representing a cell in the grid. It is essentially the blueprint to a cell object. Contains definitions of properties and methods, relevant to a cell

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

Constructors

IgbCellType()

Declaration
public IgbCellType()

Properties

Active

Indicates whether the cell is currently active (focused).

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

CellID

Optional; The cellID is the unique key, used to identify the cell

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

Column

Represents the column that the cell belongs to.

Declaration
public IgbColumn Column { get; set; }
Property Value
Type Description
IgbColumn

Editable

Indicates whether the cell can be edited.

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

EditMode

Indicates whether the cell is currently in edit mode.

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

EditValue

The value to display when the cell is in edit mode.

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

Grid

Represents the grid instance containing the cell

Declaration
public IgbGridBaseDirective Grid { get; set; }
Property Value
Type Description
IgbGridBaseDirective

Id

Optional; An object identifying the cell. It contains rowID, columnID, and rowIndex of the cell.

Declaration
public IgbGridCellIdentifier Id { get; set; }
Property Value
Type Description
IgbGridCellIdentifier

Readonly

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

Selected

Indicates whether the cell is currently selected. It is false, if the sell is not selected, and true, if it is.

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

Title

An optional title to display for the cell

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

Type

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

Validation

Optional; An object representing the validation state of the cell. Whether it's valid or invalid, and if it has errors

Declaration
public IgbGridValidationState Validation { get; set; }
Property Value
Type Description
IgbGridValidationState

Value

The current value of the cell.

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

VisibleColumnIndex

The index of the column that the cell belongs to. It counts only the visible (not hidden) columns

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

Width

The CSS width of the cell as a string.

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

Methods

CalculateSizeToFit(Object)

Declaration
public double CalculateSizeToFit(object range)
Parameters
Type Name Description
System.Object range
Returns
Type Description
System.Double

CalculateSizeToFitAsync(Object)

Optional; A method definition to calculate the size of the cell to fit the content The method can be used to calculate the size of the cell with the longest content and resize all cells to that size

Declaration
public Task<double> CalculateSizeToFitAsync(object range)
Parameters
Type Name Description
System.Object range
Returns
Type Description
System.Threading.Tasks.Task<System.Double>

FindByName(String)

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

FromEventJson(BaseRendererControl, Dictionary<String, Object>)

Declaration
protected override void FromEventJson(BaseRendererControl control, Dictionary<string, object> args)
Parameters
Type Name Description
BaseRendererControl control
System.Collections.Generic.Dictionary<System.String, System.Object> args
Overrides

SetEditMode(Boolean)

Declaration
public void SetEditMode(bool value)
Parameters
Type Name Description
System.Boolean value

SetEditModeAsync(Boolean)

A method definition to start or end the edit mode of the cell. It takes a boolean value as an argument

Declaration
public Task SetEditModeAsync(bool value)
Parameters
Type Name Description
System.Boolean value
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

ToEventJson(BaseRendererControl, Dictionary<String, Object>)

Declaration
protected override void ToEventJson(BaseRendererControl control, Dictionary<string, object> args)
Parameters
Type Name Description
BaseRendererControl control
System.Collections.Generic.Dictionary<System.String, System.Object> args
Overrides

Update(Object)

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

UpdateAsync(Object)

A method definition to update the value of the cell.

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

Implements