Class IgbCellInfo

Represents info about the current cell.

Inheritance

System.Object

BaseRendererElement

IgbCellInfo

IgbDateTimeCellInfo

IgbEditorCellInfo

IgbEditorRowCellInfo

IgbFilterCellInfo

IgbImageCellInfo

IgbNumericCellInfo

IgbRowSeparatorInfo

IgbSectionHeaderCellInfo

IgbSummaryCellInfo

IgbTemplateCellInfo

IgbTextCellInfo

IgbVerticalSeparatorCellInfo

Implements

JsonSerializable

Inherited Members

BaseRendererElement._name

BaseRendererElement.eventCallbacksCache

BaseRendererElement._cachedSerializedContent

BaseRendererElement.EnsureModulesLoaded()

BaseRendererElement.BuildRenderTree(RenderTreeBuilder)

BaseRendererElement.OnElementNameChanged(BaseRendererElement, String, String)

BaseRendererElement.InvokeMethod(String, Object[], String[], ElementReference[])

BaseRendererElement.InvokeMethodSync(String, Object[], String[], ElementReference[])

BaseRendererElement.InvokeMethodHelper(String, String, Object[], String[], ElementReference[])

BaseRendererElement.InvokeMethodHelperSync(String, String, Object[], String[], ElementReference[])

BaseRendererElement.IsPropDirty(String)

BaseRendererElement.Serialize(SerializationContext, String)

BaseRendererElement.Serialize()

BaseRendererElement.EnsureValid()

BaseRendererElement.SetResourceStringAsync(String, String, String)

BaseRendererElement.SetResourceStringAsync(String, String)

BaseRendererElement.CompareEventCallbacks<T>(T, T, Dictionary<Type, Dictionary<String, FieldInfo>>)

BaseRendererElement.IgBlazor

BaseRendererElement.IsComponentRooted

BaseRendererElement.ParentTypeName

BaseRendererElement.UseDirectRender

BaseRendererElement.ChildContent

BaseRendererElement.SupportsVisualChildren

BaseRendererElement.Name

BaseRendererElement.Parent

BaseRendererElement.MethodTarget

BaseRendererElement.CurrParent

Namespace: IgniteUI.Blazor.Controls

Assembly: IgniteUI.Blazor.dll

Syntax

public class IgbCellInfo : BaseRendererElement, JsonSerializable

Constructors

IgbCellInfo()

Declaration

public IgbCellInfo()

Properties

ActionManager

Gets the action manager to propagate actions back to the grid.

Declaration

public CellActionManager ActionManager { get; set; }

Property Value

Type	Description
CellActionManager

ActivationBorder

Gets the actual background color of the cell

Declaration

public string ActivationBorder { get; set; }

Property Value

Type	Description
System.String

ActivationBorderBottomWidth

Gets or sets the bottom activation border to use for the content.

Declaration

public int ActivationBorderBottomWidth { get; set; }

Property Value

Type	Description
System.Int32

ActivationBorderLeftWidth

Gets or sets the left activation border to use for the content.

Declaration

public int ActivationBorderLeftWidth { get; set; }

Property Value

Type	Description
System.Int32

ActivationBorderRightWidth

Gets or sets the right activation border to use for the content.

Declaration

public int ActivationBorderRightWidth { get; set; }

Property Value

Type	Description
System.Int32

ActivationBorderTopWidth

Gets or sets the top activation border to use for the content.

Declaration

public int ActivationBorderTopWidth { get; set; }

Property Value

Type	Description
System.Int32

ActivationStatus

Gets the amount that the cell is activated. This is a value between 0 and 1.

Declaration

public double ActivationStatus { get; set; }

Property Value

Type	Description
System.Double

ActualBackground

Gets the actual background color of the cell

Declaration

public string ActualBackground { get; set; }

Property Value

Type	Description
System.String

ActualBorder

Gets the actual background color of the cell

Declaration

public string ActualBorder { get; set; }

Property Value

Type	Description
System.String

ActualBorderBottomWidth

Gets or sets the actual bottom border to use for the content.

Declaration

public int ActualBorderBottomWidth { get; set; }

Property Value

Type	Description
System.Int32

ActualBorderLeftWidth

Gets or sets the actual left border to use for the content.

Declaration

public int ActualBorderLeftWidth { get; set; }

Property Value

Type	Description
System.Int32

ActualBorderRightWidth

Gets or sets the actual right border to use for the content.

Declaration

public int ActualBorderRightWidth { get; set; }

Property Value

Type	Description
System.Int32

ActualBorderTopWidth

Gets or sets the actual top border to use for the content.

Declaration

public int ActualBorderTopWidth { get; set; }

Property Value

Type	Description
System.Int32

ActualContentOpacity

Gets the actual content opacity of the cell.

Declaration

public double ActualContentOpacity { get; set; }

Property Value

Type	Description
System.Double

ActualFontFamily

Declaration

public string ActualFontFamily { get; set; }

Property Value

Type	Description
System.String

ActualFontSize

Declaration

public double ActualFontSize { get; set; }

Property Value

Type	Description
System.Double

ActualFontStyle

Declaration

public string ActualFontStyle { get; set; }

Property Value

Type	Description
System.String

ActualFontWeight

Declaration

public string ActualFontWeight { get; set; }

Property Value

Type	Description
System.String

ActualOpacity

Gets the actual opacity of the cell.

Declaration

public double ActualOpacity { get; set; }

Property Value

Type	Description
System.Double

ActualPaddingBottom

Gets or sets the bottom padding to use for the content.

Declaration

public int ActualPaddingBottom { get; set; }

Property Value

Type	Description
System.Int32

ActualPaddingLeft

Gets or sets the left padding to use for the content.

Declaration

public int ActualPaddingLeft { get; set; }

Property Value

Type	Description
System.Int32

ActualPaddingRight

Gets or sets the right padding to use for the content.

Declaration

public int ActualPaddingRight { get; set; }

Property Value

Type	Description
System.Int32

ActualPaddingTop

Gets or sets the top padding to use for the content.

Declaration

public int ActualPaddingTop { get; set; }

Property Value

Type	Description
System.Int32

ActualTextColor

Gets the actual color of the text for the cell, if any.

Declaration

public string ActualTextColor { get; set; }

Property Value

Type	Description
System.String

Background

Gets or sets the background color of the cell.

Declaration

public string Background { get; set; }

Property Value

Type	Description
System.String

Border

Gets or sets the border color of the cell.

Declaration

public string Border { get; set; }

Property Value

Type	Description
System.String

BorderBottomWidth

Gets or sets the bottom border to use for the content.

Declaration

public int BorderBottomWidth { get; set; }

Property Value

Type	Description
System.Int32

BorderLeftWidth

Gets or sets the left border to use for the content.

Declaration

public int BorderLeftWidth { get; set; }

Property Value

Type	Description
System.Int32

BorderRightWidth

Gets or sets the right border to use for the content.

Declaration

public int BorderRightWidth { get; set; }

Property Value

Type	Description
System.Int32

BorderTopWidth

Gets or sets the top border to use for the content.

Declaration

public int BorderTopWidth { get; set; }

Property Value

Type	Description
System.Int32

ContentOpacity

Gets or sets the opacity of the content of the cell.

Declaration

public double ContentOpacity { get; set; }

Property Value

Type	Description
System.Double

DataRow

Gets the absolute data row for the current cell.

Declaration

public int DataRow { get; set; }

Property Value

Type	Description
System.Int32

DeletedTextColor

Gets or sets the text color for cells in deleted rows.

Declaration

public string DeletedTextColor { get; set; }

Property Value

Type	Description
System.String

EditError

Gets or sets the error message for the cell.

Declaration

public string EditError { get; set; }

Property Value

Type	Description
System.String

EditFontFamily

Declaration

public string EditFontFamily { get; set; }

Property Value

Type	Description
System.String

EditFontSize

Declaration

public double EditFontSize { get; set; }

Property Value

Type	Description
System.Double

EditFontStyle

Declaration

public string EditFontStyle { get; set; }

Property Value

Type	Description
System.String

EditFontWeight

Declaration

public string EditFontWeight { get; set; }

Property Value

Type	Description
System.String

EditID

Declaration

public int EditID { get; set; }

Property Value

Type	Description
System.Int32

EditOpacity

Gets or sets the opacity for cells that have unsaved edits.

Declaration

public double EditOpacity { get; set; }

Property Value

Type	Description
System.Double

ErrorBorder

Gets or sets the error border color of the cell.

Declaration

public string ErrorBorder { get; set; }

Property Value

Type	Description
System.String

ErrorBorderBottomWidth

Gets or sets the bottom error border to use for the content.

Declaration

public int ErrorBorderBottomWidth { get; set; }

Property Value

Type	Description
System.Int32

ErrorBorderLeftWidth

Gets or sets the left error border to use for the content.

Declaration

public int ErrorBorderLeftWidth { get; set; }

Property Value

Type	Description
System.Int32

ErrorBorderRightWidth

Gets or sets the right error border to use for the content.

Declaration

public int ErrorBorderRightWidth { get; set; }

Property Value

Type	Description
System.Int32

ErrorBorderTopWidth

Gets or sets the top error border to use for the content.

Declaration

public int ErrorBorderTopWidth { get; set; }

Property Value

Type	Description
System.Int32

FilterRowBackground

Gets or sets the background color for filter row.

Declaration

public string FilterRowBackground { get; set; }

Property Value

Type	Description
System.String

FontFamily

Declaration

public string FontFamily { get; set; }

Property Value

Type	Description
System.String

FontSize

Declaration

public double FontSize { get; set; }

Property Value

Type	Description
System.Double

FontStyle

Declaration

public string FontStyle { get; set; }

Property Value

Type	Description
System.String

FontWeight

Declaration

public string FontWeight { get; set; }

Property Value

Type	Description
System.String

Height

Gets the height of the cell.

Declaration

public int Height { get; set; }

Property Value

Type	Description
System.Int32

HorizontalAlignment

Gets or sets the horiztonal alignment of the cell content.

Declaration

public CellContentHorizontalAlignment HorizontalAlignment { get; set; }

Property Value

Type	Description
CellContentHorizontalAlignment

HoverBackground

Gets or sets the hover background color of the cell.

Declaration

public string HoverBackground { get; set; }

Property Value

Type	Description
System.String

HoverStatus

Gets the amount that the cell is hovered. This is a value between 0 and 1.

Declaration

public double HoverStatus { get; set; }

Property Value

Type	Description
System.Double

HoverTextColor

Gets or sets the hover text color of the cell.

Declaration

public string HoverTextColor { get; set; }

Property Value

Type	Description
System.String

Indent

Gets the indent level of the cell.

Declaration

public int Indent { get; set; }

Property Value

Type	Description
System.Int32

IsBorderDirty

Gets if the content of the cell is dirty.

Declaration

public bool IsBorderDirty { get; set; }

Property Value

Type	Description
System.Boolean

IsCollapsable

Gets if the cell needs to display an expansion indicator.

Declaration

public bool IsCollapsable { get; set; }

Property Value

Type	Description
System.Boolean

IsContentDirty

Gets if the content of the cell is dirty.

Declaration

public bool IsContentDirty { get; set; }

Property Value

Type	Description
System.Boolean

IsDataDirty

Gets if the data of the cell is dirty.

Declaration

public bool IsDataDirty { get; set; }

Property Value

Type	Description
System.Boolean

IsDeleted

Gets whether the cell is part of a deleted row.

Declaration

public bool IsDeleted { get; set; }

Property Value

Type	Description
System.Boolean

IsEdited

Gets whether the cell has been edited.

Declaration

public bool IsEdited { get; set; }

Property Value

Type	Description
System.Boolean

IsExpanded

Gets the expansion state of the cell.

Declaration

public bool IsExpanded { get; set; }

Property Value

Type	Description
System.Boolean

IsFilterRow

Gets if this cell is in the filter row.

Declaration

public bool IsFilterRow { get; set; }

Property Value

Type	Description
System.Boolean

IsHitTestVisible

Gets or sets whether the cell is hit test visible.

Declaration

public bool IsHitTestVisible { get; set; }

Property Value

Type	Description
System.Boolean

IsHoverable

Gets whether the cell is hoverable or not.

Declaration

public bool IsHoverable { get; set; }

Property Value

Type	Description
System.Boolean

IsInEditMode

Gets whether the cell is in edit mode.

Declaration

public bool IsInEditMode { get; set; }

Property Value

Type	Description
System.Boolean

IsLastStickyRow

Gets if this cell is the last row that can stick to the top of the grid.

Declaration

public bool IsLastStickyRow { get; set; }

Property Value

Type	Description
System.Boolean

IsLayerDirty

Gets if the layer of the cell is dirty.

Declaration

public bool IsLayerDirty { get; set; }

Property Value

Type	Description
System.Boolean

IsPlaceholdContentNeeded

Gets if placeholder content is needed when virtualized.

Declaration

public bool IsPlaceholdContentNeeded { get; set; }

Property Value

Type	Description
System.Boolean

IsPositionDirty

Gets if the position of the cell is dirty.

Declaration

public bool IsPositionDirty { get; set; }

Property Value

Type	Description
System.Boolean

IsRowPinned

Gets if this cell belongs to a row that has been marked as pinned.

Declaration

public bool IsRowPinned { get; set; }

Property Value

Type	Description
System.Boolean

IsRowSticky

Gets if this cell belongs to a row that will stick to the top of the grid.

Declaration

public bool IsRowSticky { get; set; }

Property Value

Type	Description
System.Boolean

IsSelected

Gets if the cell is selected.

Declaration

public bool IsSelected { get; set; }

Property Value

Type	Description
System.Boolean

IsSizeDirty

Gets if the size of the cell is dirty.

Declaration

public bool IsSizeDirty { get; set; }

Property Value

Type	Description
System.Boolean

IsStateDirty

Gets if the layer of the cell is dirty.

Declaration

public bool IsStateDirty { get; set; }

Property Value

Type	Description
System.Boolean

LastStickyRowBackground

Gets or sets the color for the last row in the sticky row area.

Declaration

public string LastStickyRowBackground { get; set; }

Property Value

Type	Description
System.String

LineBreakMode

Gets or sets the line break mode to use if text is present in the cell.

Declaration

public TextCellLineBreakMode LineBreakMode { get; set; }

Property Value

Type	Description
TextCellLineBreakMode

Opacity

Gets or sets the opacity of the cell.

Declaration

public double Opacity { get; set; }

Property Value

Type	Description
System.Double

OriginalValue

Gets or sets the original value for the cell, before processing.

Declaration

public object OriginalValue { get; set; }

Property Value

Type	Description
System.Object

OriginalValueScript

Provides a means of setting OriginalValue in the JavaScript environment.

Declaration

public string OriginalValueScript { get; set; }

Property Value

Type	Description
System.String

PaddingBottom

Gets or sets the bottom padding to use for the content.

Declaration

public int PaddingBottom { get; set; }

Property Value

Type	Description
System.Int32

PaddingLeft

Gets or sets the left padding to use for the content.

Declaration

public int PaddingLeft { get; set; }

Property Value

Type	Description
System.Int32

PaddingRight

Gets or sets the right padding to use for the content.

Declaration

public int PaddingRight { get; set; }

Property Value

Type	Description
System.Int32

PaddingTop

Gets or sets the top padding to use for the content.

Declaration

public int PaddingTop { get; set; }

Property Value

Type	Description
System.Int32

Pinned

Gets the fixed column position of this cell.

Declaration

public PinnedPositions Pinned { get; set; }

Property Value

Type	Description
PinnedPositions

PinnedRowBackground

Gets or sets the background color for the cell that has been marked as pinned.

Declaration

public string PinnedRowBackground { get; set; }

Property Value

Type	Description
System.String

PinnedRowOpacity

Gets or sets the color to use for displaying text.

Declaration

public double PinnedRowOpacity { get; set; }

Property Value

Type	Description
System.Double

RenderValue

Gets or sets the text value, if any, which was rendered by a text cell.

Declaration

public string RenderValue { get; set; }

Property Value

Type	Description
System.String

RowItem

Declaration

public object RowItem { get; set; }

Property Value

Type	Description
System.Object

RowItemScript

Provides a means of setting RowItem in the JavaScript environment.

Declaration

public string RowItemScript { get; set; }

Property Value

Type	Description
System.String

SelectedBackground

Gets or sets the selected background color of the cell.

Declaration

public string SelectedBackground { get; set; }

Property Value

Type	Description
System.String

SelectedStatus

Gets the amount that the cell is selected. This is a value between 0 and 1.

Declaration

public double SelectedStatus { get; set; }

Property Value

Type	Description
System.Double

SnappedX

Gets the pixel snapped X position of the cell within the content.

Declaration

public int SnappedX { get; set; }

Property Value

Type	Description
System.Int32

SnappedY

Gets the snapped Y position of the cell within the content.

Declaration

public int SnappedY { get; set; }

Property Value

Type	Description
System.Int32

SortDirection

Gets the current sort direction for the column containing the cell.

Declaration

public ColumnSortDirection SortDirection { get; set; }

Property Value

Type	Description
ColumnSortDirection

SortIndicatorColor

Gets or sets the color for the sort indicator icon.

Declaration

public string SortIndicatorColor { get; set; }

Property Value

Type	Description
System.String

StickyRowBackground

Gets or sets the background color for the cell when it is stuck to the top of the grid as a pinned row.

Declaration

public string StickyRowBackground { get; set; }

Property Value

Type	Description
System.String

StyleKey

Gets the style key of the current cell, used for recycling.

Declaration

public string StyleKey { get; set; }

Property Value

Type	Description
System.String

TextColor

Gets or sets the color of the text for the cell, if any.

Declaration

public string TextColor { get; set; }

Property Value

Type	Description
System.String

Type

Declaration

public override string Type { get; }

Property Value

Type	Description
System.String

Overrides

BaseRendererElement.Type

UserFormattedValue

Declaration

public string UserFormattedValue { get; set; }

Property Value

Type	Description
System.String

VerticalAlignment

Gets or sets the vertical alignment of the cell content.

Declaration

public CellContentVerticalAlignment VerticalAlignment { get; set; }

Property Value

Type	Description
CellContentVerticalAlignment

VirtualizationPercentage

Gets or sets the virtualization percentage value. This is between 0 an 1, and indicates how virtual the content is at present.

Declaration

public double VirtualizationPercentage { get; set; }

Property Value

Type	Description
System.Double

Width

Gets the width of the cell.

Declaration

public int Width { get; set; }

Property Value

Type	Description
System.Int32

X

Gets the X position of the cell within the content.

Declaration

public double X { get; set; }

Property Value

Type	Description
System.Double

Y

Gets the Y position of the cell within the content.

Declaration

public double Y { get; set; }

Property Value

Type	Description
System.Double

Methods

FindByName(String)

Declaration

public override object FindByName(string name)

Parameters

Type	Name	Description
System.String	name

Returns

Type	Description
System.Object

Overrides

BaseRendererElement.FindByName(String)

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

BaseRendererElement.FromEventJson(BaseRendererControl, Dictionary<String, Object>)

GetNamedValue(String)

Declaration

public object GetNamedValue(string valueName)

Parameters

Type	Name	Description
System.String	valueName

Returns

Type	Description
System.Object

GetNamedValueAsync(String)

Gets a named value from the cell.

Declaration

public Task<object> GetNamedValueAsync(string valueName)

Parameters

Type	Name	Description
System.String	valueName	The name of the value to get.

Returns

Type	Description
System.Threading.Tasks.Task<System.Object>

HasNamedValue(String)

Declaration

public bool HasNamedValue(string valueName)

Parameters

Type	Name	Description
System.String	valueName

Returns

Type	Description
System.Boolean

HasNamedValueAsync(String)

Returns if there is a named value stored for the cell.

Declaration

public Task<bool> HasNamedValueAsync(string valueName)

Parameters

Type	Name	Description
System.String	valueName	The name of the value to check.

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>

IsCustomFieldDirty(String)

Declaration

public bool IsCustomFieldDirty(string propertyName)

Parameters

Type	Name	Description
System.String	propertyName

Returns

Type	Description
System.Boolean

IsCustomFieldDirtyAsync(String)

Declaration

public Task<bool> IsCustomFieldDirtyAsync(string propertyName)

Parameters

Type	Name	Description
System.String	propertyName

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>

IsDirty(String)

Declaration

public bool IsDirty(string propertyName)

Parameters

Type	Name	Description
System.String	propertyName

Returns

Type	Description
System.Boolean

IsDirtyAsync(String)

Gets if a named property is dirty.

Declaration

public Task<bool> IsDirtyAsync(string propertyName)

Parameters

Type	Name	Description
System.String	propertyName	The property name to check.

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>

IsDirtyById(Int32)

Declaration

public bool IsDirtyById(int propertyId_)

Parameters

Type	Name	Description
System.Int32	propertyId_

Returns

Type	Description
System.Boolean

IsDirtyByIdAsync(Int32)

Gets if a named property is dirty.

Declaration

public Task<bool> IsDirtyByIdAsync(int propertyId_)

Parameters

Type	Name	Description
System.Int32	propertyId_

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>

RemoveNamedValue(String)

Declaration

public void RemoveNamedValue(string valueName)

Parameters

Type	Name	Description
System.String	valueName

RemoveNamedValueAsync(String)

Removes a named value from the cell.

Declaration

public Task RemoveNamedValueAsync(string valueName)

Parameters

Type	Name	Description
System.String	valueName	The name of the value to remove.

Returns

Type	Description
System.Threading.Tasks.Task

SetNamedValue(String, Object)

Declaration

public void SetNamedValue(string valueName, object value)

Parameters

Type	Name	Description
System.String	valueName
System.Object	value

SetNamedValueAsync(String, Object)

Declaration

public Task SetNamedValueAsync(string valueName, object value)

Parameters

Type	Name	Description
System.String	valueName
System.Object	value

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

BaseRendererElement.ToEventJson(BaseRendererControl, Dictionary<String, Object>)

Implements

JsonSerializable