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
object
ComponentBase
- IComponent
- IHandleEvent
- IHandleAfterRender
- JsonSerializable
Constructors
Section titled "Constructors"constructor
public IgbCellType()Returns IgbCellType
Properties
Section titled "Properties"IgBlazor
Section titled "IgBlazor"Inherited from: BaseRendererElement
[Inject]
protected IIgniteUIBlazor IgBlazor { get; set; }IsComponentRooted
Section titled "IsComponentRooted"Inherited from: BaseRendererElement
public bool IsComponentRooted { get; }ParentTypeName
Section titled "ParentTypeName"Inherited from: BaseRendererElement
protected virtual string ParentTypeName { get; }UseDirectRender
Section titled "UseDirectRender"Inherited from: BaseRendererElement
protected virtual bool UseDirectRender { get; }ChildContent
Section titled "ChildContent"Inherited from: BaseRendererElement
[Parameter]
public RenderFragment ChildContent { get; set; }SupportsVisualChildren
Section titled "SupportsVisualChildren"Inherited from: BaseRendererElement
protected virtual bool SupportsVisualChildren { get; }Inherited from: BaseRendererElement
[Parameter]
public string Name { get; set; }Parent
Section titled "Parent"Inherited from: BaseRendererElement
public object Parent { get; }MethodTarget
Section titled "MethodTarget"Inherited from: BaseRendererElement
protected virtual string MethodTarget { get; }CurrParent
Section titled "CurrParent"Inherited from: BaseRendererElement
protected object CurrParent { get; }Active
Section titled "Active"Indicates whether the cell is currently active (focused).
[Parameter]
public bool Active { get; set; }CellID
Section titled "CellID"Optional; The cellID is the unique key, used to identify the cell
[Parameter]
public object CellID { get; set; }Column
Section titled "Column"Represents the column that the cell belongs to.
[Parameter]
public IgbColumn Column { get; set; }EditMode
Section titled "EditMode"Indicates whether the cell is currently in edit mode.
[Parameter]
public bool EditMode { get; set; }EditValue
Section titled "EditValue"The value to display when the cell is in edit mode.
[Parameter]
public object EditValue { get; set; }Editable
Section titled "Editable"Indicates whether the cell can be edited.
[Parameter]
public bool Editable { get; set; }Represents the grid instance containing the cell
[Parameter]
public IgbGridBaseDirective Grid { get; set; }Optional; An object identifying the cell. It contains rowID, columnID, and rowIndex of the cell.
[Parameter]
public IgbGridCellIdentifier Id { get; set; }Readonly
Section titled "Readonly"[Parameter]
public bool Readonly { get; set; }Selected
Section titled "Selected"Indicates whether the cell is currently selected. It is false, if the sell is not selected, and true, if it is.
[Parameter]
public bool Selected { get; set; }Title
Section titled "Title"An optional title to display for the cell
[Parameter]
public object Title { get; set; }public override string Type { get; }Validation
Section titled "Validation"Optional; An object representing the validation state of the cell. Whether it's valid or invalid, and if it has errors
[Parameter]
public IgbGridValidationState Validation { get; set; }Value
Section titled "Value"The current value of the cell.
[Parameter]
public object Value { get; set; }VisibleColumnIndex
Section titled "VisibleColumnIndex"The index of the column that the cell belongs to. It counts only the visible (not hidden) columns
[Parameter]
public double VisibleColumnIndex { get; set; }Width
Section titled "Width"The CSS width of the cell as a string.
[Parameter]
public string Width { get; set; }Accessors
Section titled "Accessors"_name
Section titled "_name"Inherited from: BaseRendererElement
protected string _nameeventCallbacksCache
Section titled "eventCallbacksCache"Inherited from: BaseRendererElement
protected Dictionary<Type, Dictionary<string, FieldInfo>> eventCallbacksCache_cachedSerializedContent
Section titled "_cachedSerializedContent"Inherited from: BaseRendererElement
protected string _cachedSerializedContentMethods
Section titled "Methods"EnsureModulesLoaded()
Section titled "EnsureModulesLoaded()"Inherited from: BaseRendererElement
protected virtual void EnsureModulesLoaded()Returns any
BuildRenderTree(RenderTreeBuilder)
Section titled "BuildRenderTree(RenderTreeBuilder)"Inherited from: BaseRendererElement
protected override void BuildRenderTree(RenderTreeBuilder builder)Parameters
- builder:
RenderTreeBuilder
Returns any
OnElementNameChanged(BaseRendererElement, string, string)
Section titled "OnElementNameChanged(BaseRendererElement, string, string)"Inherited from: BaseRendererElement
protected void OnElementNameChanged(BaseRendererElement element, string oldName, string newName)Parameters
- element:
BaseRendererElement - oldName:
string - newName:
string
Returns any
InvokeMethod(string, object[], string[], ElementReference[])
Section titled "InvokeMethod(string, object[], string[], ElementReference[])"Inherited from: BaseRendererElement
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: BaseRendererElement
protected object InvokeMethodSync(string methodName, object[] arguments, string[] types, ElementReference[] nativeElements = null)Parameters
- methodName:
string - arguments:
object[] - types:
string[] - nativeElements:
ElementReference[]
Returns any
InvokeMethodHelper(string, string, object[], string[], ElementReference[])
Section titled "InvokeMethodHelper(string, string, object[], string[], ElementReference[])"Inherited from: BaseRendererElement
protected Task<object> InvokeMethodHelper(string target, string methodName, object[] arguments, string[] types, ElementReference[] nativeElements)Parameters
- target:
string - methodName:
string - arguments:
object[] - types:
string[] - nativeElements:
ElementReference[]
Returns any
InvokeMethodHelperSync(string, string, object[], string[], ElementReference[])
Section titled "InvokeMethodHelperSync(string, string, object[], string[], ElementReference[])"Inherited from: BaseRendererElement
protected object InvokeMethodHelperSync(string target, string methodName, object[] arguments, string[] types, ElementReference[] nativeElements)Parameters
- target:
string - methodName:
string - arguments:
object[] - types:
string[] - nativeElements:
ElementReference[]
Returns any
IsPropDirty(string)
Section titled "IsPropDirty(string)"Inherited from: BaseRendererElement
protected bool IsPropDirty(string propertyName)Parameters
- propertyName:
string
Returns any
Serialize(SerializationContext, string)
Section titled "Serialize(SerializationContext, string)"Inherited from: BaseRendererElement
public void Serialize(SerializationContext context, string propertyName = null)Parameters
- context:
SerializationContext - propertyName:
string
Returns any
Serialize()
Section titled "Serialize()"Inherited from: BaseRendererElement
public string Serialize()Returns any
EnsureValid()
Section titled "EnsureValid()"Inherited from: BaseRendererElement
protected void EnsureValid()Returns any
SetResourceStringAsync(string, string, string)
Section titled "SetResourceStringAsync(string, string, string)"Inherited from: BaseRendererElement
protected 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: BaseRendererElement
protected Task<object> SetResourceStringAsync(string grouping, string json)Parameters
- grouping:
string - json:
string
Returns any
CalculateSizeToFit(object)
Section titled "CalculateSizeToFit(object)"public double CalculateSizeToFit(object range)Parameters
- range:
object
Returns any
CalculateSizeToFitAsync(object)
Section titled "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
public Task<double> CalculateSizeToFitAsync(object range)Parameters
- range:
object
Returns any
FindByName(string)
Section titled "FindByName(string)"public override object FindByName(string name)Parameters
- name:
string
Returns any
FromEventJson(BaseRendererControl, Dictionary<string, object>)
Section titled "FromEventJson(BaseRendererControl, Dictionary<string, object>)"protected override void FromEventJson(BaseRendererControl control, Dictionary<string, object> args)Parameters
- control:
BaseRendererControl - args:
Dictionary
Returns any
SetEditMode(bool)
Section titled "SetEditMode(bool)"public void SetEditMode(bool value)Parameters
- value:
bool
Returns any
SetEditModeAsync(bool)
Section titled "SetEditModeAsync(bool)"A method definition to start or end the edit mode of the cell. It takes a boolean value as an argument
public Task SetEditModeAsync(bool value)Parameters
- value:
bool
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
ToEventJson(BaseRendererControl, Dictionary<string, object>)
Section titled "ToEventJson(BaseRendererControl, Dictionary<string, object>)"protected override void ToEventJson(BaseRendererControl control, Dictionary<string, object> args)Parameters
- control:
BaseRendererControl - args:
Dictionary
Returns any
Update(object)
Section titled "Update(object)"public void Update(object value)Parameters
- value:
object
Returns any
UpdateAsync(object)
Section titled "UpdateAsync(object)"A method definition to update the value of the cell.
public Task UpdateAsync(object value)Parameters
- value:
object