IgbDataGridColumn | Infragistics API Docs

A column in the data grid.

Inheritance

object

ComponentBase

BaseRendererElement

IgbDefinitionBase

IgbDataGridColumn

Classes that extend this class.

Derived Classes

Implements

IComponent
IHandleEvent
IHandleAfterRender
JsonSerializable
IDisposable

Constructors

constructor

public IgbDataGridColumn()

Returns IgbDataGridColumn

Properties

ParentTypeName

Inherited from: IgbDefinitionBase

protected override string ParentTypeName { get; }

ContentConditionalStyles

Inherited from: IgbDefinitionBase

public IgbGridConditionalStyleCollection ContentConditionalStyles { get; }

ActualConditionalStyles

Inherited from: IgbDefinitionBase

public IgbGridConditionalStyleCollection ActualConditionalStyles { get; }

Background

Inherited from: IgbDefinitionBase

Gets or sets the background color to use.

[Parameter]
public string Background { get; set; }

ConditionalStyles

Inherited from: IgbDefinitionBase

Gets the style key information to use for judging when a property will be set later by a style

public IgbGridConditionalStyleCollection ConditionalStyles { get; protected set; }

Border

Inherited from: IgbDefinitionBase

Gets or sets the background color to use.

[Parameter]
public string Border { get; set; }

ActivationBorder

Inherited from: IgbDefinitionBase

Gets or sets the background color to use.

[Parameter]
public string ActivationBorder { get; set; }

ErrorBorder

Inherited from: IgbDefinitionBase

Gets or sets the error border color to use.

[Parameter]
public string ErrorBorder { get; set; }

ActualBorder

Inherited from: IgbDefinitionBase

Gets the actual border color that will be used.

[Parameter]
public string ActualBorder { get; set; }

BorderLeftWidth

Inherited from: IgbDefinitionBase

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

[Parameter]
public int BorderLeftWidth { get; set; }

BorderTopWidth

Inherited from: IgbDefinitionBase

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

[Parameter]
public int BorderTopWidth { get; set; }

BorderRightWidth

Inherited from: IgbDefinitionBase

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

[Parameter]
public int BorderRightWidth { get; set; }

BorderBottomWidth

Inherited from: IgbDefinitionBase

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

[Parameter]
public int BorderBottomWidth { get; set; }

ActivationBorderLeftWidth

Inherited from: IgbDefinitionBase

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

[Parameter]
public int ActivationBorderLeftWidth { get; set; }

ActivationBorderTopWidth

Inherited from: IgbDefinitionBase

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

[Parameter]
public int ActivationBorderTopWidth { get; set; }

ActivationBorderRightWidth

Inherited from: IgbDefinitionBase

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

[Parameter]
public int ActivationBorderRightWidth { get; set; }

ActivationBorderBottomWidth

Inherited from: IgbDefinitionBase

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

[Parameter]
public int ActivationBorderBottomWidth { get; set; }

ErrorBorderLeftWidth

Inherited from: IgbDefinitionBase

[Parameter]
public int ErrorBorderLeftWidth { get; set; }

ErrorBorderTopWidth

Inherited from: IgbDefinitionBase

[Parameter]
public int ErrorBorderTopWidth { get; set; }

ErrorBorderRightWidth

Inherited from: IgbDefinitionBase

[Parameter]
public int ErrorBorderRightWidth { get; set; }

ErrorBorderBottomWidth

Inherited from: IgbDefinitionBase

[Parameter]
public int ErrorBorderBottomWidth { get; set; }

ActualBackground

Inherited from: IgbDefinitionBase

Gets the actual background color that will be used.

[Parameter]
public string ActualBackground { get; set; }

ActualActivationBorder

Inherited from: IgbDefinitionBase

Gets the actual background color that will be used.

[Parameter]
public string ActualActivationBorder { get; set; }

ActualErrorBorder

Inherited from: IgbDefinitionBase

Gets the actual error border color that will be used.

[Parameter]
public string ActualErrorBorder { get; set; }

StickyRowBackground

Inherited from: IgbDefinitionBase

Gets or sets the background color for content that sticks to the top of the grid.

[Parameter]
public string StickyRowBackground { get; set; }

ActualStickyRowBackground

Inherited from: IgbDefinitionBase

Gets the actual background color for content that sticks to the top of the grid.

[Parameter]
public string ActualStickyRowBackground { get; set; }

PinnedRowBackground

Inherited from: IgbDefinitionBase

Gets or sets the background color for cells belonging to rows marked as pinned.

[Parameter]
public string PinnedRowBackground { get; set; }

ActualPinnedRowBackground

Inherited from: IgbDefinitionBase

Gets the actual background color for cells belonging to rows marked as pinned.

[Parameter]
public string ActualPinnedRowBackground { get; set; }

LastStickyRowBackground

Inherited from: IgbDefinitionBase

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

[Parameter]
public string LastStickyRowBackground { get; set; }

ActualLastStickyRowBackground

Inherited from: IgbDefinitionBase

Gets the actual color for the last row in the sticky row area.

[Parameter]
public string ActualLastStickyRowBackground { get; set; }

ContentOpacity

Inherited from: IgbDefinitionBase

Gets or sets the opacity of the content.

[Parameter]
public double ContentOpacity { get; set; }

HorizontalAlignment

Inherited from: IgbDefinitionBase

Gets or sets the horizontal alignment to use for the cell content.

[Parameter]
public CellContentHorizontalAlignment HorizontalAlignment { get; set; }

VerticalAlignment

Inherited from: IgbDefinitionBase

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

[Parameter]
public CellContentVerticalAlignment VerticalAlignment { get; set; }

LineBreakMode

Inherited from: IgbDefinitionBase

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

[Parameter]
public TextCellLineBreakMode LineBreakMode { get; set; }

ActualLineBreakMode

Inherited from: IgbDefinitionBase

Gets the actual line break mode which will be used if text is present in the cell.

[Parameter]
public TextCellLineBreakMode ActualLineBreakMode { get; set; }

TextColor

Inherited from: IgbDefinitionBase

Gets or sets the color to use for displaying text.

[Parameter]
public string TextColor { get; set; }

ActualTextColor

Inherited from: IgbDefinitionBase

Gets the actual color used for displaying text.

[Parameter]
public string ActualTextColor { get; set; }

IsBarSupported

Inherited from: IgbDefinitionBase

Gets or sets whether the bar is supported.

[Parameter]
public bool IsBarSupported { get; set; }

BarBackground

Inherited from: IgbDefinitionBase

Gets or sets the color to use for value bars.

[Parameter]
public string BarBackground { get; set; }

ActualBarBackground

Inherited from: IgbDefinitionBase

Gets the actual color used for value bars.

[Parameter]
public string ActualBarBackground { get; set; }

BarOutline

Inherited from: IgbDefinitionBase

Gets or sets the Outline color to use for value bars.

[Parameter]
public string BarOutline { get; set; }

ActualBarOutline

Inherited from: IgbDefinitionBase

Gets the actual Outline color used for value bars.

[Parameter]
public string ActualBarOutline { get; set; }

BarStrokeThickness

Inherited from: IgbDefinitionBase

Gets or sets the stroke thickness to use for value bars.

[Parameter]
public int BarStrokeThickness { get; set; }

ActualBarStrokeThickness

Inherited from: IgbDefinitionBase

Gets the actual stroke thickness used for value bars.

[Parameter]
public int ActualBarStrokeThickness { get; set; }

BarCornerRadius

Inherited from: IgbDefinitionBase

Gets or sets the stroke thickness to use for value bars.

[Parameter]
public int BarCornerRadius { get; set; }

ActualBarCornerRadius

Inherited from: IgbDefinitionBase

Gets the actual stroke thickness used for value bars.

[Parameter]
public int ActualBarCornerRadius { get; set; }

PinnedRowOpacity

Inherited from: IgbDefinitionBase

Gets or sets the color to use for displaying text.

[Parameter]
public double PinnedRowOpacity { get; set; }

ActualPinnedRowOpacity

Inherited from: IgbDefinitionBase

Gets or sets the color to use for displaying text.

[Parameter]
public double ActualPinnedRowOpacity { get; set; }

FontFamily

Inherited from: IgbDefinitionBase

[Parameter]
public string FontFamily { get; set; }

FontStyle

Inherited from: IgbDefinitionBase

[Parameter]
public string FontStyle { get; set; }

FontWeight

Inherited from: IgbDefinitionBase

[Parameter]
public string FontWeight { get; set; }

DataBindingScript

Inherited from: IgbDefinitionBase

[Parameter]
public string DataBindingScript { get; set; }

DataBinding

Inherited from: IgbDefinitionBase

[Parameter]
public Action<IgbDataBindingEventArgs> DataBinding { get; set; }

DataBoundScript

Inherited from: IgbDefinitionBase

[Parameter]
public string DataBoundScript { get; set; }

DataBound

Inherited from: IgbDefinitionBase

[Parameter]
public Action<IgbDataBindingEventArgs> DataBound { get; set; }

CellStyleKeyRequestedScript

Inherited from: IgbDefinitionBase

[Parameter]
public string CellStyleKeyRequestedScript { get; set; }

CellStyleKeyRequested

Inherited from: IgbDefinitionBase

[Parameter]
public Action<IgbCellStyleRequestedEventArgs> CellStyleKeyRequested { get; set; }

IgBlazor

Inherited from: BaseRendererElement

[Inject]
protected IIgniteUIBlazor IgBlazor { get; set; }

IsComponentRooted

Inherited from: BaseRendererElement

public bool IsComponentRooted { get; }

UseDirectRender

Inherited from: BaseRendererElement

protected virtual bool UseDirectRender { get; }

ChildContent

Inherited from: BaseRendererElement

[Parameter]
public RenderFragment ChildContent { get; set; }

SupportsVisualChildren

Inherited from: BaseRendererElement

protected virtual bool SupportsVisualChildren { get; }

Name

Inherited from: BaseRendererElement

[Parameter]
public string Name { get; set; }

Parent

Inherited from: BaseRendererElement

public object Parent { get; }

MethodTarget

Inherited from: BaseRendererElement

protected virtual string MethodTarget { get; }

CurrParent

Inherited from: BaseRendererElement

protected object CurrParent { get; }

ActualColumnOptionsAccentColor

[Parameter]
public string ActualColumnOptionsAccentColor { get; set; }

ActualColumnOptionsBackground

Gets or sets the column options dropdown background color.

[Parameter]
public string ActualColumnOptionsBackground { get; set; }

ActualColumnOptionsGroupHeaderBackground

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

[Parameter]
public string ActualColumnOptionsGroupHeaderBackground { get; set; }

ActualColumnOptionsGroupHeaderTextColor

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

[Parameter]
public string ActualColumnOptionsGroupHeaderTextColor { get; set; }

ActualColumnOptionsHighlightColor

[Parameter]
public string ActualColumnOptionsHighlightColor { get; set; }

ActualColumnOptionsHoverBackgroundColor

[Parameter]
public string ActualColumnOptionsHoverBackgroundColor { get; set; }

ActualColumnOptionsIconAlignment

Gets the actual column options icon alignment for this column.

[Parameter]
public ColumnOptionsIconAlignment ActualColumnOptionsIconAlignment { get; set; }

ActualColumnOptionsIconBehavior

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

[Parameter]
public ColumnOptionsIconBehavior ActualColumnOptionsIconBehavior { get; set; }

ActualColumnOptionsIconColor

Gets the actual column options icon color for this column.

[Parameter]
public string ActualColumnOptionsIconColor { get; set; }

ActualColumnOptionsRowHeight

[Parameter]
public int ActualColumnOptionsRowHeight { get; set; }

ActualColumnOptionsScrollbarActiveBackground

Gets the resolved scrollbar thumb active (dragging) background color for checkbox lists in the column options dialog.

[Parameter]
public string ActualColumnOptionsScrollbarActiveBackground { get; set; }

ActualColumnOptionsScrollbarBackground

Gets the resolved scrollbar background color for checkbox lists in the column options dialog.

[Parameter]
public string ActualColumnOptionsScrollbarBackground { get; set; }

ActualColumnOptionsScrollbarHoverBackground

Gets the resolved scrollbar thumb hover background color for checkbox lists in the column options dialog.

[Parameter]
public string ActualColumnOptionsScrollbarHoverBackground { get; set; }

ActualColumnOptionsSeparatorColor

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

[Parameter]
public string ActualColumnOptionsSeparatorColor { get; set; }

ActualColumnOptionsTextColor

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

[Parameter]
public string ActualColumnOptionsTextColor { get; set; }

ActualColumnOptionsToolTipBackgroundColor

[Parameter]
public string ActualColumnOptionsToolTipBackgroundColor { get; set; }

ActualColumnOptionsToolTipTextColor

[Parameter]
public string ActualColumnOptionsToolTipTextColor { get; set; }

ActualDeletedTextColor

Gets the actual text color used for deleted rows.

[Parameter]
public string ActualDeletedTextColor { get; set; }

ActualEditOpacity

Gets the actual opacity for unsaved edited cell values.

[Parameter]
public double ActualEditOpacity { get; set; }

ActualHeaderText

Gets the actual text displayed in the header of the column

[Parameter]
public string ActualHeaderText { get; set; }

ActualHoverBackground

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

[Parameter]
public string ActualHoverBackground { get; set; }

ActualIsColumnOptionsEnabled

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

[Parameter]
public bool ActualIsColumnOptionsEnabled { get; set; }

ActualIsColumnOptionsGroupingEnabled

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

[Parameter]
public bool ActualIsColumnOptionsGroupingEnabled { get; set; }

ActualIsColumnOptionsSummariesEnabled

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

[Parameter]
public bool ActualIsColumnOptionsSummariesEnabled { get; set; }

ActualRowHoverTextColor

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

[Parameter]
public string ActualRowHoverTextColor { get; set; }

ActualSelectedBackground

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

[Parameter]
public string ActualSelectedBackground { get; set; }

ActualSelectedTextColor

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

[Parameter]
public string ActualSelectedTextColor { get; set; }

AnimationSettings

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

[Parameter]
public IgbGridColumnAnimationSettings AnimationSettings { get; set; }

ColumnOptionsAccentColor

[Parameter]
public string ColumnOptionsAccentColor { get; set; }

ColumnOptionsBackground

Gets or sets the column options dropdown background color.

[Parameter]
public string ColumnOptionsBackground { get; set; }

ColumnOptionsFontFamily

[Parameter]
public string ColumnOptionsFontFamily { get; set; }

ColumnOptionsFontSize

[Parameter]
public double ColumnOptionsFontSize { get; set; }

ColumnOptionsFontStyle

[Parameter]
public string ColumnOptionsFontStyle { get; set; }

ColumnOptionsFontWeight

[Parameter]
public string ColumnOptionsFontWeight { get; set; }

ColumnOptionsGroupHeaderBackground

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

[Parameter]
public string ColumnOptionsGroupHeaderBackground { get; set; }

ColumnOptionsGroupHeaderFontFamily

[Parameter]
public string ColumnOptionsGroupHeaderFontFamily { get; set; }

ColumnOptionsGroupHeaderFontSize

[Parameter]
public double ColumnOptionsGroupHeaderFontSize { get; set; }

ColumnOptionsGroupHeaderFontStyle

[Parameter]
public string ColumnOptionsGroupHeaderFontStyle { get; set; }

ColumnOptionsGroupHeaderFontWeight

[Parameter]
public string ColumnOptionsGroupHeaderFontWeight { get; set; }

ColumnOptionsGroupHeaderTextColor

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

[Parameter]
public string ColumnOptionsGroupHeaderTextColor { get; set; }

ColumnOptionsHighlightColor

[Parameter]
public string ColumnOptionsHighlightColor { get; set; }

ColumnOptionsHoverBackgroundColor

[Parameter]
public string ColumnOptionsHoverBackgroundColor { get; set; }

ColumnOptionsIconAlignment

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

[Parameter]
public ColumnOptionsIconAlignment ColumnOptionsIconAlignment { get; set; }

ColumnOptionsIconBehavior

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

[Parameter]
public ColumnOptionsIconBehavior ColumnOptionsIconBehavior { get; set; }

ColumnOptionsIconColor

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

[Parameter]
public string ColumnOptionsIconColor { get; set; }

ColumnOptionsRowHeight

[Parameter]
public int ColumnOptionsRowHeight { get; set; }

ColumnOptionsScrollbarActiveBackground

Gets or sets the scrollbar thumb active (dragging) background color for checkbox lists in this column's options dialog.

[Parameter]
public string ColumnOptionsScrollbarActiveBackground { get; set; }

ColumnOptionsScrollbarBackground

Gets or sets the scrollbar background color for checkbox lists in this column's options dialog.

[Parameter]
public string ColumnOptionsScrollbarBackground { get; set; }

ColumnOptionsScrollbarHoverBackground

Gets or sets the scrollbar thumb hover background color for checkbox lists in this column's options dialog.

[Parameter]
public string ColumnOptionsScrollbarHoverBackground { get; set; }

ColumnOptionsSeparatorColor

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

[Parameter]
public string ColumnOptionsSeparatorColor { get; set; }

ColumnOptionsTextColor

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

[Parameter]
public string ColumnOptionsTextColor { get; set; }

ColumnOptionsToolTipBackgroundColor

[Parameter]
public string ColumnOptionsToolTipBackgroundColor { get; set; }

ColumnOptionsToolTipTextColor

[Parameter]
public string ColumnOptionsToolTipTextColor { get; set; }

DataGridParent

[CascadingParameter(Name = "DataGridParent")]
protected BaseRendererControl DataGridParent { get; set; }

DeletedTextColor

Gets or sets the text color used for deleted rows.

[Parameter]
public string DeletedTextColor { get; set; }

EditFontFamily

[Parameter]
public string EditFontFamily { get; set; }

EditFontSize

[Parameter]
public double EditFontSize { get; set; }

EditFontStyle

[Parameter]
public string EditFontStyle { get; set; }

EditFontWeight

[Parameter]
public string EditFontWeight { get; set; }

EditOpacity

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

[Parameter]
public double EditOpacity { get; set; }

Field

Gets or sets the key used for the column binding

[Parameter]
public string Field { get; set; }

Filter

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

[Parameter]
public IgbColumnFilterCondition Filter { get; set; }

FilterComparisonType

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

[Parameter]
public FilterComparisonType FilterComparisonType { get; set; }

FilterExpression

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

[Parameter]
public IgbFilterExpression FilterExpression { get; set; }

FilterOperands

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

public IgbGridFilterOperandsCollection FilterOperands { get; protected set; }

FormatCell

[Parameter]
public Action<IgbFormatCellEventArgs> FormatCell { get; set; }

FormatCellScript

[Parameter]
public string FormatCellScript { get; set; }

Gets or sets the header definition for this column.

[Parameter]
public IgbHeader Header { get; set; }

HeaderText

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

[Parameter]
public string HeaderText { get; set; }

IsAutoGenerated

Gets whether this column was auto generated.

[Parameter]
public bool IsAutoGenerated { get; set; }

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.

[Parameter]
public bool IsColumnOptionsEnabled { get; set; }

IsColumnOptionsGroupingEnabled

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

[Parameter]
public bool IsColumnOptionsGroupingEnabled { get; set; }

IsColumnOptionsSummariesEnabled

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

[Parameter]
public bool IsColumnOptionsSummariesEnabled { get; set; }

IsEditable

Gets or sets if the column is editable.

[Parameter]
public bool IsEditable { get; set; }

IsFilteringEnabled

Gets or sets whether filtering is enabled for this column.

[Parameter]
public bool IsFilteringEnabled { get; set; }

IsFromMarkup

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

[Parameter]
public bool IsFromMarkup { get; set; }

IsHidden

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

[Parameter]
public bool IsHidden { get; set; }

IsResizingEnabled

Gets or sets whether resizing is enabled for this column.

[Parameter]
public bool IsResizingEnabled { get; set; }

IsSortingEnabled

Gets or sets whether sorting is enabled for this column from the UI.

[Parameter]
public bool IsSortingEnabled { get; set; }

MergedCellEvaluationCriteria

Gets or sets how cells are evaluated for merging.

[Parameter]
public MergedCellEvaluationCriteria MergedCellEvaluationCriteria { get; set; }

MergedCellMode

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

[Parameter]
public MergedCellMode MergedCellMode { get; set; }

MergedCellPaddingBottom

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

[Parameter]
public int MergedCellPaddingBottom { get; set; }

MergedCellPaddingLeft

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

[Parameter]
public int MergedCellPaddingLeft { get; set; }

MergedCellPaddingRight

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

[Parameter]
public int MergedCellPaddingRight { get; set; }

MergedCellPaddingTop

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

[Parameter]
public int MergedCellPaddingTop { get; set; }

MergedCellVerticalAlignment

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

[Parameter]
public CellContentVerticalAlignment MergedCellVerticalAlignment { get; set; }

MinWidth

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

[Parameter]
public double MinWidth { get; set; }

PaddingBottom

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

[Parameter]
public int PaddingBottom { get; set; }

PaddingLeft

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

[Parameter]
public int PaddingLeft { get; set; }

PaddingRight

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

[Parameter]
public int PaddingRight { get; set; }

PaddingTop

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

[Parameter]
public int PaddingTop { get; set; }

Pinned

Gets or sets the current fixed position for this column.

[Parameter]
public PinnedPositions Pinned { get; set; }

RowHoverBackground

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

[Parameter]
public string RowHoverBackground { get; set; }

RowHoverTextColor

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

[Parameter]
public string RowHoverTextColor { get; set; }

SelectedBackground

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

[Parameter]
public string SelectedBackground { get; set; }

SelectedTextColor

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

[Parameter]
public string SelectedTextColor { get; set; }

ShouldRemoveWhenHidden

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

[Parameter]
public bool ShouldRemoveWhenHidden { get; set; }

SortDirection

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

[Parameter]
public ColumnSortDirection SortDirection { get; set; }

SuffixIconCollectionName

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

[Parameter]
public string SuffixIconCollectionName { get; set; }

SuffixIconFill

Gets or sets the fill color of suffix icon.

[Parameter]
public string SuffixIconFill { get; set; }

SuffixIconName

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

[Parameter]
public string SuffixIconName { get; set; }

SuffixIconStroke

Gets or sets the stroke color of suffix icon.

[Parameter]
public string SuffixIconStroke { get; set; }

SuffixIconViewBoxHeight

Gets or sets the suffix icon's viewbox height.

[Parameter]
public double SuffixIconViewBoxHeight { get; set; }

SuffixIconViewBoxLeft

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

[Parameter]
public double SuffixIconViewBoxLeft { get; set; }

SuffixIconViewBoxTop

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

[Parameter]
public double SuffixIconViewBoxTop { get; set; }

SuffixIconViewBoxWidth

Gets or sets the suffix icon's viewbox width.

[Parameter]
public double SuffixIconViewBoxWidth { get; set; }

SuffixMargin

Gets or sets the suffix margin.

[Parameter]
public double SuffixMargin { get; set; }

SuffixText

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

[Parameter]
public string SuffixText { get; set; }

SuffixTextColor

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

[Parameter]
public string SuffixTextColor { get; set; }

SuffixTextFontFamily

[Parameter]
public string SuffixTextFontFamily { get; set; }

SuffixTextFontSize

[Parameter]
public double SuffixTextFontSize { get; set; }

SuffixTextFontStyle

[Parameter]
public string SuffixTextFontStyle { get; set; }

SuffixTextFontWeight

[Parameter]
public string SuffixTextFontWeight { get; set; }

TextDecoration

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

[Parameter]
public TextCellDecoration TextDecoration { get; set; }

Type

public override string Type { get; }

Width

Gets or sets the width to use for this column.

[Parameter]
public IgbColumnWidth Width { get; set; }

Accessors

_name

Inherited from: BaseRendererElement

protected string _name

eventCallbacksCache

Inherited from: BaseRendererElement

protected Dictionary<Type, Dictionary<string, FieldInfo>> eventCallbacksCache

_cachedSerializedContent

Inherited from: BaseRendererElement

protected string _cachedSerializedContent

Methods

TransitionStyleOutAsync(IgbGridConditionalStyle)

Inherited from: IgbDefinitionBase

public Task TransitionStyleOutAsync(IgbGridConditionalStyle style)

Parameters

style: IgbGridConditionalStyle

Returns any

TransitionStyleOut(IgbGridConditionalStyle)

Inherited from: IgbDefinitionBase

public void TransitionStyleOut(IgbGridConditionalStyle style)

Parameters

style: IgbGridConditionalStyle

Returns any

TransitionStyleInAsync(IgbGridConditionalStyle)

Inherited from: IgbDefinitionBase

public Task TransitionStyleInAsync(IgbGridConditionalStyle style)

Parameters

style: IgbGridConditionalStyle

Returns any

TransitionStyleIn(IgbGridConditionalStyle)

Inherited from: IgbDefinitionBase

public void TransitionStyleIn(IgbGridConditionalStyle style)

Parameters

style: IgbGridConditionalStyle

Returns any

IsStyleTransitioningOutAsync(IgbGridConditionalStyle)

Inherited from: IgbDefinitionBase

public Task<bool> IsStyleTransitioningOutAsync(IgbGridConditionalStyle style)

Parameters

style: IgbGridConditionalStyle

Returns any

IsStyleTransitioningOut(IgbGridConditionalStyle)

Inherited from: IgbDefinitionBase

public bool IsStyleTransitioningOut(IgbGridConditionalStyle style)

Parameters

style: IgbGridConditionalStyle

Returns any

SetNamedValueAsync(string, CellPropertyAnimationType, object)

Inherited from: IgbDefinitionBase

public Task SetNamedValueAsync(string valueName, CellPropertyAnimationType animationType, object value)

Parameters

valueName: string
animationType: CellPropertyAnimationType
value: object

Returns any

SetNamedValue(string, CellPropertyAnimationType, object)

Inherited from: IgbDefinitionBase

public void SetNamedValue(string valueName, CellPropertyAnimationType animationType, object value)

Parameters

valueName: string
animationType: CellPropertyAnimationType
value: object

Returns any

HasNamedValuesAsync()

Inherited from: IgbDefinitionBase

Returns if this definition has named value.

public Task<bool> HasNamedValuesAsync()

Returns any

HasNamedValues()

Inherited from: IgbDefinitionBase

public bool HasNamedValues()

Returns any

HasNamedValueAsync(string)

Inherited from: IgbDefinitionBase

Returns if this definition has a named value with a given name.

public Task<bool> HasNamedValueAsync(string valueName)

Parameters

valueName: string

Returns any

HasNamedValue(string)

Inherited from: IgbDefinitionBase

public bool HasNamedValue(string valueName)

Parameters

valueName: string

Returns any

RemoveNamedValueAsync(string)

Inherited from: IgbDefinitionBase

Removes the named value from this definition by name.

public Task RemoveNamedValueAsync(string valueName)

Parameters

valueName: string

Returns any

RemoveNamedValue(string)

Inherited from: IgbDefinitionBase

public void RemoveNamedValue(string valueName)

Parameters

valueName: string

Returns any

GetNamedValueAsync(string)

Inherited from: IgbDefinitionBase

Gets the value for a named value from this definition.

public Task<object> GetNamedValueAsync(string valueName)

Parameters

valueName: string

Returns any

GetNamedValue(string)

Inherited from: IgbDefinitionBase

public object GetNamedValue(string valueName)

Parameters

valueName: string

Returns any

EnsureModulesLoaded()

Inherited from: BaseRendererElement

protected virtual void EnsureModulesLoaded()

Returns any

BuildRenderTree(RenderTreeBuilder)

Inherited from: BaseRendererElement

protected override void BuildRenderTree(RenderTreeBuilder builder)

Parameters

builder: RenderTreeBuilder

Returns any

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[])

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[])

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[])

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[])

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)

Inherited from: BaseRendererElement

protected bool IsPropDirty(string propertyName)

Parameters

propertyName: string

Returns any

Serialize(SerializationContext, string)

Inherited from: BaseRendererElement

public void Serialize(SerializationContext context, string propertyName = null)

Parameters

context: SerializationContext
propertyName: string

Returns any

Serialize()

Inherited from: BaseRendererElement

public string Serialize()

Returns any

EnsureValid()

Inherited from: BaseRendererElement

protected void EnsureValid()

Returns any

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)

Inherited from: BaseRendererElement

protected Task<object> SetResourceStringAsync(string grouping, string json)

Parameters

grouping: string
json: string

Returns any

ApplyCustomFilter(string, int, object)

public virtual void ApplyCustomFilter(string filterID, int index, object value)

Parameters

filterID: string
index: int
value: object

Returns any

ApplyCustomFilterAsync(string, int, object)

public virtual Task ApplyCustomFilterAsync(string filterID, int index, object value)

Parameters

filterID: string
index: int
value: object

Returns any

Dispose()

public void Dispose()

Returns any

FindByName(string)

public override object FindByName(string name)

Parameters

name: string

Returns any

FromEventJson(BaseRendererControl, Dictionary<string, object>)

protected override void FromEventJson(BaseRendererControl control, Dictionary<string, object> args)

Parameters

control: BaseRendererControl
args: Dictionary

Returns any

GetCurrentActualHeaderText()

public string GetCurrentActualHeaderText()

Returns any

GetCurrentActualHeaderTextAsync()

public Task<string> GetCurrentActualHeaderTextAsync()

Returns any

GetNamedHeaderValue(string)

public object GetNamedHeaderValue(string valueName)

Parameters

valueName: string

Returns any

GetNamedHeaderValueAsync(string)

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

public Task<object> GetNamedHeaderValueAsync(string valueName)

Parameters

valueName: string

Returns any

GetUniqueKey()

public string GetUniqueKey()

Returns any

GetUniqueKeyAsync()

Get the unique key used to identify this column.

public Task<string> GetUniqueKeyAsync()

Returns any

HasNamedHeaderValue(string)

public bool HasNamedHeaderValue(string valueName)

Parameters

valueName: string

Returns any

HasNamedHeaderValueAsync(string)

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

public Task<bool> HasNamedHeaderValueAsync(string valueName)

Parameters

valueName: string

Returns any

HasNamedHeaderValues()

public bool HasNamedHeaderValues()

Returns any

HasNamedHeaderValuesAsync()

Returns if the column has named header values.

public Task<bool> HasNamedHeaderValuesAsync()

Returns any

OnInitializedAsync()

protected override Task OnInitializedAsync()

Returns any

RemoveNamedHeaderValue(string)

public void RemoveNamedHeaderValue(string valueName)

Parameters

valueName: string

Returns any

RemoveNamedHeaderValueAsync(string)

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

public Task RemoveNamedHeaderValueAsync(string valueName)

Parameters

valueName: string

Returns any

SetNamedHeaderValue(string, CellPropertyAnimationType, object)

public void SetNamedHeaderValue(string valueName, CellPropertyAnimationType animationType, object value)

Parameters

valueName: string
animationType: CellPropertyAnimationType
value: object

Returns any

SetNamedHeaderValueAsync(string, CellPropertyAnimationType, object)

public Task SetNamedHeaderValueAsync(string valueName, CellPropertyAnimationType animationType, object value)

Parameters

valueName: string
animationType: CellPropertyAnimationType
value: object

Returns any

ToEventJson(BaseRendererControl, Dictionary<string, object>)

protected override void ToEventJson(BaseRendererControl control, Dictionary<string, object> args)

Parameters

control: BaseRendererControl
args: Dictionary

Returns any

Events

ActualHeaderTextChanged

[Parameter]
public EventCallback<string> ActualHeaderTextChanged { get; set; }

ActualHeaderTextChangedScript

[Parameter]
public string ActualHeaderTextChangedScript { get; set; }