Class IgbDataGridColumn

A column in the data grid.

Inheritance
System.Object
BaseRendererElement
IgbDefinitionBase
IgbDataGridColumn
IgbComboBoxColumn
IgbDateTimeColumn
IgbImageColumn
IgbNumericColumn
IgbTemplateColumn
IgbTextColumn
Implements
System.IDisposable
Inherited Members
Namespace: IgniteUI.Blazor.Controls
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbDataGridColumn : IgbDefinitionBase, JsonSerializable, IDisposable

Constructors

IgbDataGridColumn()

Declaration
public IgbDataGridColumn()

Properties

ActualColumnOptionsAccentColor

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

ActualColumnOptionsBackground

Gets or sets the column options dropdown background color.

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

ActualColumnOptionsGroupHeaderBackground

Gets or sets the background color for group headers inside the column options menu.

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

ActualColumnOptionsGroupHeaderTextColor

Gets the actual text color for group headers inside the column options menu.

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

ActualColumnOptionsIconAlignment

Gets the actual column options icon alignment for this column.

Declaration
public ColumnOptionsIconAlignment ActualColumnOptionsIconAlignment { get; set; }
Property Value
Type Description
ColumnOptionsIconAlignment

ActualColumnOptionsIconBehavior

Gets or sets how the column option icon will behave in the column header.

Declaration
public ColumnOptionsIconBehavior ActualColumnOptionsIconBehavior { get; set; }
Property Value
Type Description
ColumnOptionsIconBehavior

ActualColumnOptionsIconColor

Gets the actual column options icon color for this column.

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

ActualColumnOptionsSeparatorColor

Gets or sets the color of separators inside the column options menu.

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

ActualColumnOptionsTextColor

Gets or sets the text color for text inside the column options menu.

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

ActualDeletedTextColor

Gets the actual text color used for deleted rows.

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

ActualEditOpacity

Gets the actual opacity for unsaved edited cell values.

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

ActualHeaderText

Gets the actual text displayed in the header of the column

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

ActualHeaderTextChanged

Declaration
public EventCallback<string> ActualHeaderTextChanged { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<System.String>

ActualHeaderTextChangedScript

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

ActualHoverBackground

Gets the actual background color that is used for the cells when they are hovered.

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

ActualIsColumnOptionsEnabled

Gets the actual state of the column options for this column.

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

ActualIsColumnOptionsGroupingEnabled

Gets the actual state of grouping menu in the column options for this column.

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

ActualIsColumnOptionsSummariesEnabled

Gets the actual state of summaries menu in the column options for this column.

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

ActualRowHoverTextColor

Gets the actual text color that is used for the cells when they are hovered.

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

ActualSelectedBackground

Gets the actual background color that is used for the cells when they are selected

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

AnimationSettings

Gets or sets the animation settings to use for this column.

Declaration
public IgbGridColumnAnimationSettings AnimationSettings { get; set; }
Property Value
Type Description
IgbGridColumnAnimationSettings

ColumnOptionsAccentColor

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

ColumnOptionsBackground

Gets or sets the column options dropdown background color.

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

ColumnOptionsGroupHeaderBackground

Gets or sets the background color for group headers inside the column options menu.

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

ColumnOptionsGroupHeaderTextColor

Gets or sets the text color for group headers inside the column options menu.

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

ColumnOptionsIconAlignment

Gets or sets whether the column options icon is aligned opposite the header text or not.

Declaration
public ColumnOptionsIconAlignment ColumnOptionsIconAlignment { get; set; }
Property Value
Type Description
ColumnOptionsIconAlignment

ColumnOptionsIconBehavior

Gets or sets how the column option icon will behave in the column header.

Declaration
public ColumnOptionsIconBehavior ColumnOptionsIconBehavior { get; set; }
Property Value
Type Description
ColumnOptionsIconBehavior

ColumnOptionsIconColor

Gets or sets the column options icon color for this column.

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

ColumnOptionsSeparatorColor

Gets or sets the color of separators inside the column options menu.

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

ColumnOptionsTextColor

Gets or sets the text color for text inside the column options menu.

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

DataGridParent

Declaration
protected BaseRendererControl DataGridParent { get; set; }
Property Value
Type Description
BaseRendererControl

DeletedTextColor

Gets or sets the text color used for deleted rows.

Declaration
public string DeletedTextColor { 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

EditOpacity

Gets or sets the opacity to use for unsaved edited cell values.

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

Field

Gets or sets the key used for the column binding

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

Filter

Gets or sets a filter to apply on the values of this column

Declaration
public IgbColumnFilterCondition Filter { get; set; }
Property Value
Type Description
IgbColumnFilterCondition

FilterComparisonType

Gets or sets whether UI filters are case sensitive or not.

Declaration
public FilterComparisonType FilterComparisonType { get; set; }
Property Value
Type Description
FilterComparisonType

FilterExpression

Gets or sets a filter to apply to the values of this column.

Declaration
public IgbFilterExpression FilterExpression { get; set; }
Property Value
Type Description
IgbFilterExpression

FilterOperands

Gets a list of the current custom filters for this column.

Declaration
public IgbGridFilterOperandsCollection FilterOperands { get; protected set; }
Property Value
Type Description
IgbGridFilterOperandsCollection

FormatCell

Declaration
public Action<IgbFormatCellEventArgs> FormatCell { get; set; }
Property Value
Type Description
System.Action<IgbFormatCellEventArgs>

FormatCellScript

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

Header

Gets or sets the header definition for this column.

Declaration
public IgbHeader Header { get; set; }
Property Value
Type Description
IgbHeader

HeaderText

Gets or sets the text displayed in the header of the column

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

IsAutoGenerated

Gets whether this column was auto generated.

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

IsColumnOptionsEnabled

Gets or sets the preferred state of the column options for this column. If the feature is disabled at the grid level then it will be disabled for the column regardless of what this is set to.

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

IsColumnOptionsGroupingEnabled

Gets or sets whether to show the grouping option in the column options menu for this column.

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

IsColumnOptionsSummariesEnabled

Gets or sets whether to show the summaries option in the column options menu for this column.

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

IsEditable

Gets or sets if the column is editable.

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

IsFilteringEnabled

Gets or sets whether filtering is enabled for this column.

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

IsFromMarkup

Gets whether this column was projected from markup/templates and is constrained.

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

IsHidden

Gets or sets whether or not a column is hidden from the grid

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

IsResizingEnabled

Gets or sets whether resizing is enabled for this column.

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

MergedCellEvaluationCriteria

Gets or sets how cells are evaluated for merging.

Declaration
public MergedCellEvaluationCriteria MergedCellEvaluationCriteria { get; set; }
Property Value
Type Description
MergedCellEvaluationCriteria

MergedCellMode

Gets or sets if and how cell merging is performed for this field.

Declaration
public MergedCellMode MergedCellMode { get; set; }
Property Value
Type Description
MergedCellMode

MergedCellPaddingBottom

Gets or sets the amount of bottom padding to use for the cell content of this column.

Declaration
public int MergedCellPaddingBottom { get; set; }
Property Value
Type Description
System.Int32

MergedCellPaddingLeft

Gets or sets the amount of left padding to use for the cell content for this column.

Declaration
public int MergedCellPaddingLeft { get; set; }
Property Value
Type Description
System.Int32

MergedCellPaddingRight

Gets or sets the amount of right padding to use for the cell content of this column.

Declaration
public int MergedCellPaddingRight { get; set; }
Property Value
Type Description
System.Int32

MergedCellPaddingTop

Gets or sets the amount of top padding to use for the cell content for this column.

Declaration
public int MergedCellPaddingTop { get; set; }
Property Value
Type Description
System.Int32

MergedCellVerticalAlignment

Gets or sets the vertical alignment to use for the merged cell content.

Declaration
public CellContentVerticalAlignment MergedCellVerticalAlignment { get; set; }
Property Value
Type Description
CellContentVerticalAlignment

MinWidth

Gets or sets the minimum width to use for this column. Overrides the DefaultColumnMinWidth from the grid, if set.

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

PaddingBottom

Gets or sets the amount of bottom padding to use for the cell content of this column.

Declaration
public int PaddingBottom { get; set; }
Property Value
Type Description
System.Int32

PaddingLeft

Gets or sets the amount of left padding to use for the cell content for this column.

Declaration
public int PaddingLeft { get; set; }
Property Value
Type Description
System.Int32

PaddingRight

Gets or sets the amount of right padding to use for the cell content of this column.

Declaration
public int PaddingRight { get; set; }
Property Value
Type Description
System.Int32

PaddingTop

Gets or sets the amount of top padding to use for the cell content for this column.

Declaration
public int PaddingTop { get; set; }
Property Value
Type Description
System.Int32

Pinned

Gets or sets the current fixed position for this column.

Declaration
public PinnedPositions Pinned { get; set; }
Property Value
Type Description
PinnedPositions

RowHoverBackground

Gets or sets the background color to use for the cells when the row is hovered.

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

RowHoverTextColor

Gets or sets the text color to use for the cells when the row is hovered.

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

SelectedBackground

Gets or sets the background color to use for the cells when they are selected

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

ShouldRemoveWhenHidden

Gets or sets if a column should be removed from the grid when it is fully hidden

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

SortDirection

Gets the current sort direction (None, Ascending, Descending) for this column.

Declaration
public ColumnSortDirection SortDirection { get; set; }
Property Value
Type Description
ColumnSortDirection

SuffixIconCollectionName

Gets or sets the icon to use in the suffix area of the cells in this column.

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

SuffixIconFill

Gets or sets the fill color of suffix icon.

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

SuffixIconName

Gets or sets the icon to use in the suffix area of the cells in this column.

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

SuffixIconStroke

Gets or sets the stroke color of suffix icon.

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

SuffixIconViewBoxHeight

Gets or sets the suffix icon's viewbox height.

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

SuffixIconViewBoxLeft

Gets or sets the suffix icon's viewbox x coordinate.

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

SuffixIconViewBoxTop

Gets or sets the suffix icon's viewbox y coordinate.

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

SuffixIconViewBoxWidth

Gets or sets the suffix icon's viewbox width.

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

SuffixMargin

Gets or sets the suffix margin.

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

SuffixText

Gets or sets the text to display in the suffix area of cells in this column.

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

SuffixTextColor

Gets or sets the color of the text in the suffix area of the cells in this column.

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

SuffixTextFontFamily

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

SuffixTextFontSize

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

SuffixTextFontStyle

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

SuffixTextFontWeight

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

TextDecoration

Gets or sets the text decoration to apply to cells in this column.

Declaration
public TextCellDecoration TextDecoration { get; set; }
Property Value
Type Description
TextCellDecoration

Type

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

Width

Gets or sets the width to use for this column.

Declaration
public IgbColumnWidth Width { get; set; }
Property Value
Type Description
IgbColumnWidth

Methods

ApplyCustomFilter(String, Int32, Object)

Declaration
public virtual void ApplyCustomFilter(string filterID, int index, object value)
Parameters
Type Name Description
System.String filterID
System.Int32 index
System.Object value

ApplyCustomFilterAsync(String, Int32, Object)

Declaration
public virtual Task ApplyCustomFilterAsync(string filterID, int index, object value)
Parameters
Type Name Description
System.String filterID
System.Int32 index
System.Object value
Returns
Type Description
System.Threading.Tasks.Task

Dispose()

Declaration
public void Dispose()

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

GetCurrentActualHeaderText()

Declaration
public string GetCurrentActualHeaderText()
Returns
Type Description
System.String

GetCurrentActualHeaderTextAsync()

Declaration
public Task<string> GetCurrentActualHeaderTextAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.String>

GetNamedHeaderValue(String)

Declaration
public object GetNamedHeaderValue(string valueName)
Parameters
Type Name Description
System.String valueName
Returns
Type Description
System.Object

GetNamedHeaderValueAsync(String)

Gets the value of a named header value for this column by name.

Declaration
public Task<object> GetNamedHeaderValueAsync(string valueName)
Parameters
Type Name Description
System.String valueName

Name of the named header value to retrieve.
Returns
Type Description
System.Threading.Tasks.Task<System.Object>

GetUniqueKey()

Declaration
public string GetUniqueKey()
Returns
Type Description
System.String

GetUniqueKeyAsync()

Get the unique key used to identify this column.

Declaration
public Task<string> GetUniqueKeyAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.String>

HasNamedHeaderValue(String)

Declaration
public bool HasNamedHeaderValue(string valueName)
Parameters
Type Name Description
System.String valueName
Returns
Type Description
System.Boolean

HasNamedHeaderValueAsync(String)

Returns if there is a named header value with a given name.

Declaration
public Task<bool> HasNamedHeaderValueAsync(string valueName)
Parameters
Type Name Description
System.String valueName

The named value to check for.
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

HasNamedHeaderValues()

Declaration
public bool HasNamedHeaderValues()
Returns
Type Description
System.Boolean

HasNamedHeaderValuesAsync()

Returns if the column has named header values.

Declaration
public Task<bool> HasNamedHeaderValuesAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

OnInitializedAsync()

Declaration
protected override Task OnInitializedAsync()
Returns
Type Description
System.Threading.Tasks.Task

RemoveNamedHeaderValue(String)

Declaration
public void RemoveNamedHeaderValue(string valueName)
Parameters
Type Name Description
System.String valueName

RemoveNamedHeaderValueAsync(String)

Removes a named header value with the given name from the named header values for this column.

Declaration
public Task RemoveNamedHeaderValueAsync(string valueName)
Parameters
Type Name Description
System.String valueName

The named header value to remove.
Returns
Type Description
System.Threading.Tasks.Task

SetNamedHeaderValue(String, CellPropertyAnimationType, Object)

Declaration
public void SetNamedHeaderValue(string valueName, CellPropertyAnimationType animationType, object value)
Parameters
Type Name Description
System.String valueName
CellPropertyAnimationType animationType
System.Object value

SetNamedHeaderValueAsync(String, CellPropertyAnimationType, Object)

Declaration
public Task SetNamedHeaderValueAsync(string valueName, CellPropertyAnimationType animationType, object value)
Parameters
Type Name Description
System.String valueName
CellPropertyAnimationType animationType
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

Implements

System.IDisposable