Class IgbDataGrid

An advanced grid for displaying data.

Inheritance
System.Object
BaseRendererControl
IgbDataGrid
Implements
System.IDisposable
Inherited Members
Namespace: IgniteUI.Blazor.Controls
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbDataGrid : BaseRendererControl, RefSink, JsonSerializable, IDisposable

Constructors

IgbDataGrid()

Declaration
public IgbDataGrid()

Properties

ActivationMode

Sets or gets the grid selection mode.

Declaration
public GridActivationMode ActivationMode { get; set; }
Property Value
Type Description
GridActivationMode

ActiveCell

Gets or sets the position of the active cell.

Declaration
public IgbGridCellPosition ActiveCell { get; set; }
Property Value
Type Description
IgbGridCellPosition

ActiveCellChanged

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

ActiveCellChangedScript

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

ActualColumns

Declaration
public IgbGridColumnCollection ActualColumns { get; protected set; }
Property Value
Type Description
IgbGridColumnCollection

ActualColumnsChanged

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

ActualColumnsChangedScript

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

ActualDataSource

Declaration
public IgbBaseDataSource ActualDataSource { get; }
Property Value
Type Description
IgbBaseDataSource

ActualHeaderHeight

Gets the height used for the header row.

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

ActualPrimaryKey

Gets either the inferred primary key from the data source, or the user provided primary key, if present. Represents the actual primary key that the grid will use in operations that require it.

Declaration
public string[] ActualPrimaryKey { get; set; }
Property Value
Type Description
System.String[]

ActualPrimaryKeyChanged

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

ActualPrimaryKeyChangedScript

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

ActualRowHeight

Gets the actual height for the rows in the grid.

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

AllowCopyOperation

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

AnimationSettings

Sets or gets the default animation settings for the grid.

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

AutoAcceptEdits

Gets or sets whether to automatically accept edits or require explicit acceptance or rejections of edits when handling the CellValueChanging or DataCommitting events. When True, nothing is required on the part of the developer in order for edits to be accepted. In order to validate and reject a user cell edit you must explicitly handle the CellValueChanging event and call the RejectEdit method using the edit ID provided by the event. In order to reject a whole commit you need to handle the DataComitting event and explicitly call the RejectCommit method using the commit ID provided by the event. When False, cell edits are not immediately accepted until you explicitly call the AcceptEdit method using the edit ID provided by the CellValueChanging event. If you do not handle this event then edits will be auto accepted.

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

AutoGenerateColumns

Configures whether or not the grid will autogenerate columns when the data source is set.

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

AutoGenerateDesiredProperties

Gets or sets the desired properties the grid will automatically generate columns for.

Declaration
public string[] AutoGenerateDesiredProperties { get; set; }
Property Value
Type Description
System.String[]

Border

Gets or sets the border color around the grid.

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

BorderWidthBottom

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

BorderWidthLeft

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

BorderWidthRight

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

BorderWidthTop

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

CellBackground

Gets or sets the default background color to use for content cells

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

CellClicked

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

CellClickedScript

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

CellDataLoadedAnimationMode

Sets or gets the cell data loaded animation mode to use.

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

CellEditEnded

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

CellEditEndedScript

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

CellEditStarted

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

CellEditStartedScript

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

CellFontFamily

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

CellFontSize

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

CellFontStyle

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

CellFontWeight

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

CellPointerDown

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

CellPointerDownScript

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

CellPointerUp

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

CellPointerUpScript

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

CellPreviewPointerDown

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

CellPreviewPointerDownScript

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

CellPreviewPointerUp

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

CellPreviewPointerUpScript

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

CellSelectedBackground

Gets or sets the default background color to use for content cells when a row is in a selected state

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

CellSelectionAnimationMode

Sets or gets the cell selection animation mode to use.

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

CellTextColor

Gets or sets the default text color to use for content cells

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

CellValueChanging

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

CellValueChangingScript

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

ClearSelectionOnEscape

Gets or sets whether selection is cleared when pressing the Escape key.

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

ColumnAddingAnimationMode

Sets or gets the Column Adding Animation mode to use.

Declaration
public ColumnShowingAnimationMode ColumnAddingAnimationMode { get; set; }
Property Value
Type Description
ColumnShowingAnimationMode

ColumnExchangingAnimationMode

Sets or gets the column exchanging animation mode to use.

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

ColumnHiddenChanged

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

ColumnHiddenChangedScript

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

ColumnHidingAnimationMode

Sets or gets the column hiding animation mode to use.

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

ColumnMovingAnimationMode

Sets or gets the column moving animation mode to use.

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

ColumnMovingMode

Gets or sets the type column moving to use.

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

ColumnMovingSeparator

Gets or sets the column resizing seperator settings.

Declaration
public IgbColumnMovingSeparator ColumnMovingSeparator { get; set; }
Property Value
Type Description
IgbColumnMovingSeparator

ColumnMovingSeparatorBackground

Gets or sets the default background color to use for column moving separator.

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

ColumnMovingSeparatorOpacity

Gets or sets the opacity of the column moving separator.

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

ColumnMovingSeparatorWidth

Sets or gets the width to use for the column resizing separator.

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

ColumnOptionsIconAlignment

Gets or sets the column options icon alignment in header cells.

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

ColumnOptionsIconBehavior

Gets or sets how the column options icon will behave inside header cells.

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

ColumnOptionsIconColor

Gets or sets the column options icon color in header cells.

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

ColumnPinnedChanged

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

ColumnPinnedChangedScript

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

ColumnPropertyUpdatingAnimationMode

Sets or gets the Column Property Updating Animation mode to use.

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

ColumnResizingAnimationMode

Sets or gets the column resizing animation mode to use. Only applies when resizing in Deferred mode.

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

ColumnResizingMode

Gets or sets the type of column resizing to use.

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

ColumnResizingSeparator

Gets or sets the column resizing seperator settings.

Declaration
public IgbColumnResizingSeparator ColumnResizingSeparator { get; set; }
Property Value
Type Description
IgbColumnResizingSeparator

ColumnResizingSeparatorBackground

Gets or sets the default background color to use for column resizing separator.

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

ColumnResizingSeparatorOpacity

Gets or sets the opacity of the column Resizing separator.

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

ColumnResizingSeparatorWidth

Sets or gets the width to use for the column resizing separator.

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

Columns

Gets the column definitions that are assigned to the grid. This collection can be modified to add or remove columns in the grid.

Declaration
public IgbGridColumnCollection Columns { get; protected set; }
Property Value
Type Description
IgbGridColumnCollection

ColumnsAutoGenerated

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

ColumnsAutoGeneratedScript

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

ColumnShowingAnimationMode

Sets or gets the column showing animation mode to use.

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

ColumnWidthChanged

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

ColumnWidthChangedScript

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

ContentColumns

Declaration
public IgbGridColumnCollection ContentColumns { get; }
Property Value
Type Description
IgbGridColumnCollection

CornerRadiusBottomLeft

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

CornerRadiusBottomRight

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

CornerRadiusTopLeft

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

CornerRadiusTopRight

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

CustomFilterRequested

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

DataCommitted

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

DataCommittedScript

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

DataCommitting

Called when edits are about to be committed to the datasource.

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

DataSource

Gets or sets the data to which to bind the grid. This can be some type of array or list, or it can be an IDataSource instance.

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

DataSourceDesiredProperties

Gets or sets the desired properties for the data source to load. If specified the data source may decide to constrain the properties it fetches to these properties and must make sure that at least those properties are loaded, rather than the default behavior for that data source.

Declaration
public string[] DataSourceDesiredProperties { get; set; }
Property Value
Type Description
System.String[]

DataSourceScript

Provides a means of setting DataSource in the JavaScript environment.

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

DefaultColumnMinWidth

Gets or sets the default minimum width to use on all columns. Ignored if NaN.

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

DefaultEventBehavior

Declaration
protected override ControlEventBehavior DefaultEventBehavior { get; }
Property Value
Type Description
ControlEventBehavior
Overrides

DeferEventForRowDragSelection

Gets or sets whether to defer the SelectedItemsChanged and SelectedKeysChanged events till after the drag selection has completed.

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

DeletedTextColor

Gets or sets the text color for unsaved deleted rows.

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

Density

Gets or sets the display density to use for the grid.

Declaration
public ControlDisplayDensity Density { get; set; }
Property Value
Type Description
ControlDisplayDensity

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

EditMode

Gets or sets the type of edit mode

Declaration
public EditModeType EditMode { get; set; }
Property Value
Type Description
EditModeType

EditModeClickAction

Gets or sets the type of click action required to enter edit mode.

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

EditOnKeyPress

Gets or sets whether edit mode will begin as soon as you start typing while a cell is active.

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

EditOpacity

Gets or sets the default opacity for unsaved cell edits.

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

EditRowBorder

Gets or sets the border color for rows being edited.

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

EditRowBorderWidthBottom

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

EditRowBorderWidthLeft

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

EditRowBorderWidthRight

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

EditRowBorderWidthTop

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

EnterBehavior

Gets or sets the behavior of the Enter key.

Declaration
public EnterKeyBehaviors EnterBehavior { get; set; }
Property Value
Type Description
EnterKeyBehaviors

EnterBehaviorAfterEdit

Gets or sets the behavior of the enter key when exiting edit mode.

Declaration
public EnterKeyBehaviorAfterEdit EnterBehaviorAfterEdit { get; set; }
Property Value
Type Description
EnterKeyBehaviorAfterEdit

FilterComparisonType

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

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

FilterExpressions

Gets the current filter that is applied to the grid. Collection can be updated to modify the filter for the grid. Once filter expresisons are in this collection, the grid will no longer listen for changes on their properties.

Declaration
public IgbFilterExpressionCollection FilterExpressions { get; protected set; }
Property Value
Type Description
IgbFilterExpressionCollection

FilterExpressionsChanged

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

FilterExpressionsChangedScript

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

FilterExpressionsChanging

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

FilterExpressionsChangingScript

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

FilterLogicalOperator

Gets or sets how filters set through the filter UI are combined.

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

FilterUIType

Gets or sets which filter UI type to use.

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

GroupDescriptions

Gets the current grouping that is applied to the grid. Collection can be updated to modify the grouping for the grid. Once grouping descriptions are in this collection, the grid will no longer listen for changes on their properties.

Declaration
public IgbColumnGroupDescriptionCollection GroupDescriptions { get; protected set; }
Property Value
Type Description
IgbColumnGroupDescriptionCollection

GroupDescriptionsChanged

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

GroupDescriptionsChangedScript

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

GroupHeaderDisplayMode

Gets or sets how group headers are displayed when there are multiple groups defined in the grid.

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

GroupSummaryDisplayMode

Gets or sets the display mode summaries will use inside groups.

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

HeaderBackground

Gets or sets the default background color to use for header cells

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

HeaderClickAction

Returns/sets the action to take when a column header is clicked.

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

HeaderFontFamily

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

HeaderFontSize

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

HeaderFontStyle

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

HeaderFontWeight

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

HeaderHeight

Gets or sets the height to use for the header row.

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

HeaderRowSeparator

Gets or sets the header row seperator settings.

Declaration
public IgbHeaderRowSeparator HeaderRowSeparator { get; set; }
Property Value
Type Description
IgbHeaderRowSeparator

HeaderRowSeparatorBackground

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

HeaderSeparator

Gets or sets the header seperator settings.

Declaration
public IgbHeaderSeparator HeaderSeparator { get; set; }
Property Value
Type Description
IgbHeaderSeparator

HeaderSeparatorBackground

Gets or sets the default background color to use for header separators.

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

HeaderSeparatorWidth

Gets or sets the width of the header separators.

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

HeaderSortIndicatorColor

Gets or sets the default text color to use for content cells

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

HeaderSortIndicatorStyle

Gets or sets the default render style for sort indicators in header cells.

Declaration
public SortIndicatorStyle HeaderSortIndicatorStyle { get; set; }
Property Value
Type Description
SortIndicatorStyle

HeaderTextColor

Gets or sets the default text color to use for header cells

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

InitialGroupDescriptions

Gets the current sort that is applied to the grid. Collection can be updated to modify the sort for the grid. Once sort descriptions are in this collection, the grid will no longer listen for changes on their properties.

Declaration
public IgbColumnGroupDescriptionCollection InitialGroupDescriptions { get; protected set; }
Property Value
Type Description
IgbColumnGroupDescriptionCollection

InitialGroups

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

InitialSortDescriptions

Gets the current sort that is applied to the grid. Collection can be updated to modify the sort for the grid. Once sort descriptions are in this collection, the grid will no longer listen for changes on their properties.

Declaration
public IgbColumnSortDescriptionCollection InitialSortDescriptions { get; protected set; }
Property Value
Type Description
IgbColumnSortDescriptionCollection

InitialSorts

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

InitialSummaries

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

InitialSummaryDescriptions

Gets the current summaries that are applied to the grid.

Declaration
public IgbColumnSummaryDescriptionCollection InitialSummaryDescriptions { get; protected set; }
Property Value
Type Description
IgbColumnSummaryDescriptionCollection

IsActiveCellStyleEnabled

Gets or sets whether the active cell style will be applied to cells when made active.

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

IsColumnOptionsEnabled

Gets or sets whether to show the column options UI in the headers for columns.

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.

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.

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

IsGroupByAreaVisible

Gets or sets whether to show the column grouping UI above the headers of the grid.

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

IsGroupCollapsable

Gets or sets whether group headers are collapsable.

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

IsGroupExpandedDefault

Gets or sets whether groups are expanded or collapsed by default.

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

IsGroupRowSticky

Gets or sets if group rows will stick to the top of the grid.

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

IsHeaderSeparatorVisible

Gets or sets if header separators are rendered.

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

IsPagerVisible

Gets or sets whether to show the pager or not.

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

IsPlaceholderRenderingEnabled

Configures whether or not place holders are used for cells who do not have their data yet.

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

IsRowHoverEnabled

Gets or sets whether the row will highlight when hovered.

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

IsToolbarColumnChooserVisible

Gets or sets whether to show the column chooser button in the toolbar.

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

IsToolbarColumnPinningVisible

Gets or sets whether to show the column pinning button in the toolbar.

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

IsToolbarVisible

Gets or sets whether to show the toolbar.

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

LastStickyRowBackground

Gets or sets the default color to use for the last sticky row

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

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 all fields.

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

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

MouseDragSelectionEnabled

Gets or sets the ability to select rows or cells via mouse dragging. Currently only applies when SelectionMode is MultipleRow or RangeCell.

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

NeedsDynamicContent

Declaration
protected override bool NeedsDynamicContent { get; }
Property Value
Type Description
System.Boolean
Overrides

NotifyOnAllSelectionChanges

Gets or sets if the grid should notify on programmatic selection changes as well as changes from the UI.

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

PageSize

Gets or sets the size of each page when the pager is visible.

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

ParentTypeName

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

PinnedAreaSeparator

Gets or sets the pinned area separator settings.

Declaration
public IgbPinnedAreaSeparator PinnedAreaSeparator { get; set; }
Property Value
Type Description
IgbPinnedAreaSeparator

PinnedAreaSeparatorWidth

Gets or sets the width of the pinned area separators.

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

PinnedItems

Gets which items are currently pinned in the grid. Collection can be updated to programatically pin items.

Declaration
public IgbGridSelectedItemsCollection PinnedItems { get; protected set; }
Property Value
Type Description
IgbGridSelectedItemsCollection

PinnedKeys

Gets which primary keys are currently pinned in the grid. Collection can be updated to programatically pin items.

Declaration
public IgbGridSelectedKeysCollection PinnedKeys { get; protected set; }
Property Value
Type Description
IgbGridSelectedKeysCollection

PinnedRowBackground

Gets or sets the default color to use for pinned rows

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

PinnedRowOpacity

Gets or sets the default opacity to use for pinned rows

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

PrimaryKey

Sets or gets the user provided primary key to assume for the data. Certain functionality of the grid requires a way to uniquely identify items in order to work correctly. If a primary key cannot be inferred from the data source, you may need to provide one here.

Declaration
public string[] PrimaryKey { get; set; }
Property Value
Type Description
System.String[]

ReactsToFilterChanges

Sets or gets whether the grid will react to filter changes.

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

ReactsToGroupChanges

Sets or gets whether the grid will react to group changes.

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

ReactsToSortChanges

Sets or gets whether the grid will react to sort changes.

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

ResponsiveStates

A set of states that can be applied to the columns of the grid based on available space.

Declaration
public IgbResponsiveStatesCollection ResponsiveStates { get; protected set; }
Property Value
Type Description
IgbResponsiveStatesCollection

RootSummariesChanged

Declaration
public EventCallback<IgbDataSourceRootSummariesChangedEventArgs> RootSummariesChanged { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbDataSourceRootSummariesChangedEventArgs>

RootSummariesChangedScript

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

RowEditEnded

Called when a row has finished editing.

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

RowEditStarted

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

RowEditStartedScript

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

RowHeight

Gets or sets the height to use for the rows in the grid. If not set the grid will use the default value for the set display density.

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

RowHoverAnimationMode

Sets or gets the row hover animation mode to use.

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

RowHoverBackground

Gets or sets the background color for rows when hovered.

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

RowHoverTextColor

Gets or sets the text color for rows when hovered.

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

RowSelectionAnimationMode

Sets or gets the row selection animation mode to use.

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

RowSeparator

Gets or sets the row seperator settings.

Declaration
public IgbRowSeparator RowSeparator { get; set; }
Property Value
Type Description
IgbRowSeparator

RowSeparatorBackground

Gets or sets the default background color to use for row separators

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

RowSeparatorHeight

Sets or gets the height to use for the row separators.

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

RowSeparatorLastStickyRowBackground

Gets or sets the default last sticky row background color to use for row separators

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

RowSeparatorPinnedRowBackground

Gets or sets the pinned row background color to use for row separators

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

RowSeparatorStickyRowBackground

Gets or sets the default sticky row background color to use for row separators

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

ScrollbarBackground

Gets or sets the scrollbar background color.

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

ScrollbarStyle

Gets or sets the style of scrollbar.

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

SectionHeader

Gets or sets the header type used for sectioning off groups of rows.

Declaration
public IgbSectionHeader SectionHeader { get; set; }
Property Value
Type Description
IgbSectionHeader

SectionHeaderBackground

Gets or sets the default background color to use for section header cells

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

SectionHeaderFontFamily

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

SectionHeaderFontSize

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

SectionHeaderFontStyle

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

SectionHeaderFontWeight

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

SectionHeaderSelectedBackground

Gets or sets the default background color to use for section header cells when a row is in a selected state

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

SectionHeaderTextColor

Gets or sets the default text color to use for section header cells

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

SelectedCellRanges

Gets which cell ranges are currently selected in the grid. Collection can be updated to programatically select cells.

Declaration
public IgbGridSelectedCellRangesCollection SelectedCellRanges { get; protected set; }
Property Value
Type Description
IgbGridSelectedCellRangesCollection

SelectedCellRangesChanged

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

SelectedCellRangesChangedScript

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

SelectedCells

Gets which cells are currently selected in the grid. Collection can be updated to programatically select cells.

Declaration
public IgbGridSelectedCellsCollection SelectedCells { get; protected set; }
Property Value
Type Description
IgbGridSelectedCellsCollection

SelectedCellsChanged

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

SelectedCellsChangedScript

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

SelectedItems

Gets which items are currently selected in the grid. Collection can be updated to programatically select items.

Declaration
public IgbGridSelectedItemsCollection SelectedItems { get; protected set; }
Property Value
Type Description
IgbGridSelectedItemsCollection

SelectedItemsChanged

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

SelectedItemsChangedScript

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

SelectedKeys

Gets which primary key values are currently selected in the grid. Collection can be updated to programatically select items.

Declaration
public IgbGridSelectedKeysCollection SelectedKeys { get; protected set; }
Property Value
Type Description
IgbGridSelectedKeysCollection

SelectedKeysChanged

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

SelectedKeysChangedScript

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

SelectionBehavior

Sets or gets how selection behaves in the grid.

Declaration
public GridSelectionBehavior SelectionBehavior { get; set; }
Property Value
Type Description
GridSelectionBehavior

SelectionChanged

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

SelectionChangedScript

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

SelectionMode

Sets or gets the grid selection mode.

Declaration
public DataGridSelectionMode SelectionMode { get; set; }
Property Value
Type Description
DataGridSelectionMode

ShiftSectionContent

Gets or sets if the section header content should be shifted into the normal column scrollable area when there are pinned columns

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

SizeChanged

Declaration
public EventCallback<IgbGridSizeChangedEventArgs> SizeChanged { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbGridSizeChangedEventArgs>

SizeChangedScript

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

SortDescriptions

Gets the current sort that is applied to the grid. Collection can be updated to modify the sort for the grid. Once sort descriptions are in this collection, the grid will no longer listen for changes on their properties.

Declaration
public IgbColumnSortDescriptionCollection SortDescriptions { get; protected set; }
Property Value
Type Description
IgbColumnSortDescriptionCollection

SortDescriptionsChanged

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

SortDescriptionsChangedScript

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

StickyRowBackground

Gets or sets the default color to use for sticky rows

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

SummaryDescriptions

Gets the current summaries that are applied to the grid.

Declaration
public IgbColumnSummaryDescriptionCollection SummaryDescriptions { get; protected set; }
Property Value
Type Description
IgbColumnSummaryDescriptionCollection

SummaryDescriptionsChanged

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

SummaryDescriptionsChangedScript

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

SummaryRootBackground

Gets or sets the default background color to use for summary cells at the root level.

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

SummaryRootLabelFontFamily

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

SummaryRootLabelFontSize

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

SummaryRootLabelFontStyle

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

SummaryRootLabelFontWeight

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

SummaryRootLabelTextColor

Gets or sets the default text color to use for summary labels in summary cells at the root level.

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

SummaryRootSelectedBackground

Gets or sets the default background color to use for summary cells at the root level.

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

SummaryRootValueFontFamily

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

SummaryRootValueFontSize

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

SummaryRootValueFontStyle

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

SummaryRootValueFontWeight

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

SummaryRootValueTextColor

Gets or sets the default text color to use for summary cells at the root level.

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

SummaryRowRoot

Gets or sets the cell definition used for summary rows at the root level.

Declaration
public IgbSummaryRowRoot SummaryRowRoot { get; set; }
Property Value
Type Description
IgbSummaryRowRoot

SummaryRowSection

Gets or sets the cell definition used for summary rows at the section level.

Declaration
public IgbSummaryRowSection SummaryRowSection { get; set; }
Property Value
Type Description
IgbSummaryRowSection

SummaryScope

Gets or sets the scope which summaries are calculated for.

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

SummarySectionBackground

Gets or sets the default background color to use for summary cells at the section level.

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

SummarySectionLabelFontFamily

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

SummarySectionLabelFontSize

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

SummarySectionLabelFontStyle

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

SummarySectionLabelFontWeight

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

SummarySectionLabelTextColor

Gets or sets the default text color to use for summary labels in summary cells at the section level.

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

SummarySectionSelectedBackground

Gets or sets the default background color to use for summary cells at the section level.

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

SummarySectionValueFontFamily

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

SummarySectionValueFontSize

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

SummarySectionValueFontStyle

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

SummarySectionValueFontWeight

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

SummarySectionValueTextColor

Gets or sets the default text color to use for summary cells at the section level.

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

TodayOverride

Declaration
public DateTime TodayOverride { get; set; }
Property Value
Type Description
System.DateTime

ToolbarColumnChooserText

Gets or sets the column chooser button text to use in the toolbar.

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

ToolbarColumnChooserTitle

Gets or sets the column chooser title text to use in the toolbar.

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

ToolbarColumnPinningText

Gets or sets the column pinning button text to use in the toolbar.

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

ToolbarColumnPinningTitle

Gets or sets the column pinning title text to use in the toolbar.

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

ToolbarTitle

Gets or sets the title text to use in the toolbar.

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

Type

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

Methods

AcceptCommit(Int32)

Declaration
public void AcceptCommit(int commitID)
Parameters
Type Name Description
System.Int32 commitID

AcceptCommitAsync(Int32)

Accepts a specific commit to the datasource.

Declaration
public Task AcceptCommitAsync(int commitID)
Parameters
Type Name Description
System.Int32 commitID

The ID of the commit provided by the Committing event.
Returns
Type Description
System.Threading.Tasks.Task

AcceptEdit(Int32)

Declaration
public void AcceptEdit(int editID)
Parameters
Type Name Description
System.Int32 editID

AcceptEditAsync(Int32)

Accept a pending edit turning it into a real edit.

Declaration
public Task AcceptEditAsync(int editID)
Parameters
Type Name Description
System.Int32 editID

The ID of the edit. Provided by the CellValueChanging event.
Returns
Type Description
System.Threading.Tasks.Task

CancelEdits()

Declaration
public void CancelEdits()

CancelEditsAsync()

Cancels any edits that may exist in the datasource.

Declaration
public Task CancelEditsAsync()
Returns
Type Description
System.Threading.Tasks.Task

CanCommit()

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

CanCommitAsync()

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

CanMoveColumnLeft(Int32)

Declaration
public bool CanMoveColumnLeft(int columnIndex)
Parameters
Type Name Description
System.Int32 columnIndex
Returns
Type Description
System.Boolean

CanMoveColumnLeftAsync(Int32)

Returns true if a column can be moved to the left of it's current position; otherwise false.

Declaration
public Task<bool> CanMoveColumnLeftAsync(int columnIndex)
Parameters
Type Name Description
System.Int32 columnIndex

The index of the column.
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

CanMoveColumnRight(Int32)

Declaration
public bool CanMoveColumnRight(int columnIndex)
Parameters
Type Name Description
System.Int32 columnIndex
Returns
Type Description
System.Boolean

CanMoveColumnRightAsync(Int32)

Returns true if a column can be moved to the right of it's current position; otherwise false.

Declaration
public Task<bool> CanMoveColumnRightAsync(int columnIndex)
Parameters
Type Name Description
System.Int32 columnIndex

The index of the column.
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

CanRedo()

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

CanRedoAsync()

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

CanUndo()

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

CanUndoAsync()

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

CommitEdits()

Declaration
public void CommitEdits()

CommitEditsAsync()

Commits any edits that may exist in the datasource.

Declaration
public Task CommitEditsAsync()
Returns
Type Description
System.Threading.Tasks.Task

DataIndexOfItem(Object)

Declaration
public int DataIndexOfItem(object item)
Parameters
Type Name Description
System.Object item
Returns
Type Description
System.Int32

DataIndexOfItemAsync(Object)

Returns the data index of an item within the bound data source.

Declaration
public Task<int> DataIndexOfItemAsync(object item)
Parameters
Type Name Description
System.Object item

The item from which to get the index.
Returns
Type Description
System.Threading.Tasks.Task<System.Int32>

DeselectAllRows()

Declaration
public void DeselectAllRows()

DeselectAllRowsAsync()

Deselects all currently selected rows.

Declaration
public Task DeselectAllRowsAsync()
Returns
Type Description
System.Threading.Tasks.Task

EndEditMode(Boolean)

Declaration
public void EndEditMode(bool commit)
Parameters
Type Name Description
System.Boolean commit

EndEditModeAsync(Boolean)

Declaration
public Task EndEditModeAsync(bool commit)
Parameters
Type Name Description
System.Boolean commit
Returns
Type Description
System.Threading.Tasks.Task

EnsureModulesLoaded()

Declaration
protected override void EnsureModulesLoaded()
Overrides

ExportSerializedVisualModel()

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

ExportSerializedVisualModelAsync()

Returns a serialized copy of the exported visual model

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

ExportVisualModel()

Declaration
public object ExportVisualModel()
Returns
Type Description
System.Object

ExportVisualModelAsync()

Exports visual information about the current state of the grid.

Declaration
public Task<object> ExportVisualModelAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Object>

FindByName(String)

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

Flush()

Declaration
public void Flush()

FlushAsync()

Makes sure pending work has completed if the grid need to be synchronously examined.

Declaration
public Task FlushAsync()
Returns
Type Description
System.Threading.Tasks.Task

GetColumnAtRenderedIndex(Int32)

Declaration
public IgbDataGridColumn GetColumnAtRenderedIndex(int index)
Parameters
Type Name Description
System.Int32 index
Returns
Type Description
IgbDataGridColumn

GetColumnAtRenderedIndexAsync(Int32)

Gets the column that appears at the index specified. This is not the columns actual index in the column's collection but the index for how it appears visually in the grid.

Declaration
public Task<IgbDataGridColumn> GetColumnAtRenderedIndexAsync(int index)
Parameters
Type Name Description
System.Int32 index

The rendered index of the column.
Returns
Type Description
System.Threading.Tasks.Task<IgbDataGridColumn>

GetCurrentActiveCell()

Declaration
public IgbGridCellPosition GetCurrentActiveCell()
Returns
Type Description
IgbGridCellPosition

GetCurrentActiveCellAsync()

Declaration
public Task<IgbGridCellPosition> GetCurrentActiveCellAsync()
Returns
Type Description
System.Threading.Tasks.Task<IgbGridCellPosition>

GetCurrentActualColumns()

Declaration
public IgbGridColumnCollection GetCurrentActualColumns()
Returns
Type Description
IgbGridColumnCollection

GetCurrentActualColumnsAsync()

Declaration
public Task<IgbGridColumnCollection> GetCurrentActualColumnsAsync()
Returns
Type Description
System.Threading.Tasks.Task<IgbGridColumnCollection>

GetCurrentActualPrimaryKey()

Declaration
public string[] GetCurrentActualPrimaryKey()
Returns
Type Description
System.String[]

GetCurrentActualPrimaryKeyAsync()

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

GetCurrentFilterExpressions()

Declaration
public IgbFilterExpressionCollection GetCurrentFilterExpressions()
Returns
Type Description
IgbFilterExpressionCollection

GetCurrentFilterExpressionsAsync()

Declaration
public Task<IgbFilterExpressionCollection> GetCurrentFilterExpressionsAsync()
Returns
Type Description
System.Threading.Tasks.Task<IgbFilterExpressionCollection>

GetCurrentGroupDescriptions()

Declaration
public IgbColumnGroupDescriptionCollection GetCurrentGroupDescriptions()
Returns
Type Description
IgbColumnGroupDescriptionCollection

GetCurrentGroupDescriptionsAsync()

Declaration
public Task<IgbColumnGroupDescriptionCollection> GetCurrentGroupDescriptionsAsync()
Returns
Type Description
System.Threading.Tasks.Task<IgbColumnGroupDescriptionCollection>

GetCurrentSelectedCellRanges()

Declaration
public IgbGridSelectedCellRangesCollection GetCurrentSelectedCellRanges()
Returns
Type Description
IgbGridSelectedCellRangesCollection

GetCurrentSelectedCellRangesAsync()

Declaration
public Task<IgbGridSelectedCellRangesCollection> GetCurrentSelectedCellRangesAsync()
Returns
Type Description
System.Threading.Tasks.Task<IgbGridSelectedCellRangesCollection>

GetCurrentSelectedCells()

Declaration
public IgbGridSelectedCellsCollection GetCurrentSelectedCells()
Returns
Type Description
IgbGridSelectedCellsCollection

GetCurrentSelectedCellsAsync()

Declaration
public Task<IgbGridSelectedCellsCollection> GetCurrentSelectedCellsAsync()
Returns
Type Description
System.Threading.Tasks.Task<IgbGridSelectedCellsCollection>

GetCurrentSelectedItems()

Declaration
public IgbGridSelectedItemsCollection GetCurrentSelectedItems()
Returns
Type Description
IgbGridSelectedItemsCollection

GetCurrentSelectedItemsAsync()

Declaration
public Task<IgbGridSelectedItemsCollection> GetCurrentSelectedItemsAsync()
Returns
Type Description
System.Threading.Tasks.Task<IgbGridSelectedItemsCollection>

GetCurrentSelectedKeys()

Declaration
public IgbGridSelectedKeysCollection GetCurrentSelectedKeys()
Returns
Type Description
IgbGridSelectedKeysCollection

GetCurrentSelectedKeysAsync()

Declaration
public Task<IgbGridSelectedKeysCollection> GetCurrentSelectedKeysAsync()
Returns
Type Description
System.Threading.Tasks.Task<IgbGridSelectedKeysCollection>

GetCurrentSortDescriptions()

Declaration
public IgbColumnSortDescriptionCollection GetCurrentSortDescriptions()
Returns
Type Description
IgbColumnSortDescriptionCollection

GetCurrentSortDescriptionsAsync()

Declaration
public Task<IgbColumnSortDescriptionCollection> GetCurrentSortDescriptionsAsync()
Returns
Type Description
System.Threading.Tasks.Task<IgbColumnSortDescriptionCollection>

GetFirstVisibleIndex()

Declaration
public int GetFirstVisibleIndex()
Returns
Type Description
System.Int32

GetFirstVisibleIndexAsync()

Gets the first visible index in the grid.

Declaration
public Task<int> GetFirstVisibleIndexAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Int32>

GetHitCell(Double, Double)

Declaration
public IgbCellInfo GetHitCell(double x, double y)
Parameters
Type Name Description
System.Double x
System.Double y
Returns
Type Description
IgbCellInfo

GetHitCellAsync(Double, Double)

Declaration
public Task<IgbCellInfo> GetHitCellAsync(double x, double y)
Parameters
Type Name Description
System.Double x
System.Double y
Returns
Type Description
System.Threading.Tasks.Task<IgbCellInfo>

GetLastVisibleIndex()

Declaration
public int GetLastVisibleIndex()
Returns
Type Description
System.Int32

GetLastVisibleIndexAsync()

Gets the last visible index in the grid.

Declaration
public Task<int> GetLastVisibleIndexAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Int32>

GetRootSummaryResults()

Declaration
public IgbDataGridSummaryResult[] GetRootSummaryResults()
Returns
Type Description
IgbDataGridSummaryResult[]

GetRootSummaryResultsAsync()

Gets the summary results for root level.

Declaration
public Task<IgbDataGridSummaryResult[]> GetRootSummaryResultsAsync()
Returns
Type Description
System.Threading.Tasks.Task<IgbDataGridSummaryResult[]>

GetSectionSummaryResults(Int32)

Declaration
public IgbDataGridSummaryResult[][] GetSectionSummaryResults(int sectionIndex)
Parameters
Type Name Description
System.Int32 sectionIndex
Returns
Type Description
IgbDataGridSummaryResult[][]

GetSectionSummaryResultsAsync(Int32)

Gets the summary results for a specific section.

Declaration
public Task<IgbDataGridSummaryResult[][]> GetSectionSummaryResultsAsync(int sectionIndex)
Parameters
Type Name Description
System.Int32 sectionIndex
Returns
Type Description
System.Threading.Tasks.Task<IgbDataGridSummaryResult[][]>

InvalidateVisibleRows()

Declaration
public void InvalidateVisibleRows()

InvalidateVisibleRowsAsync()

Invalidates the bound data for the rows currently visible.

Declaration
public Task InvalidateVisibleRowsAsync()
Returns
Type Description
System.Threading.Tasks.Task

LoadLayout(String)

Declaration
public void LoadLayout(string json)
Parameters
Type Name Description
System.String json

LoadLayoutAsync(String)

Loads the layout chnages that have been made to the grid

Declaration
public Task LoadLayoutAsync(string json)
Parameters
Type Name Description
System.String json
Returns
Type Description
System.Threading.Tasks.Task

MoveColumn(Int32, Int32)

Declaration
public void MoveColumn(int oldIndex, int newIndex)
Parameters
Type Name Description
System.Int32 oldIndex
System.Int32 newIndex

MoveColumnAsync(Int32, Int32)

Declaration
public Task MoveColumnAsync(int oldIndex, int newIndex)
Parameters
Type Name Description
System.Int32 oldIndex
System.Int32 newIndex
Returns
Type Description
System.Threading.Tasks.Task

MoveColumnLeft(Int32)

Declaration
public void MoveColumnLeft(int columnIndex)
Parameters
Type Name Description
System.Int32 columnIndex

MoveColumnLeftAsync(Int32)

Moves a column to the left, if possible.

Declaration
public Task MoveColumnLeftAsync(int columnIndex)
Parameters
Type Name Description
System.Int32 columnIndex

The index of the column to move.
Returns
Type Description
System.Threading.Tasks.Task

MoveColumnRight(Int32)

Declaration
public void MoveColumnRight(int columnIndex)
Parameters
Type Name Description
System.Int32 columnIndex

MoveColumnRightAsync(Int32)

Moves a column to the right, if possible.

Declaration
public Task MoveColumnRightAsync(int columnIndex)
Parameters
Type Name Description
System.Int32 columnIndex

The index of the column to move.
Returns
Type Description
System.Threading.Tasks.Task

NotifyScrollStart()

Declaration
public void NotifyScrollStart()

NotifyScrollStartAsync()

Declaration
public Task NotifyScrollStartAsync()
Returns
Type Description
System.Threading.Tasks.Task

NotifyScrollStop()

Declaration
public void NotifyScrollStop()

NotifyScrollStopAsync()

Declaration
public Task NotifyScrollStopAsync()
Returns
Type Description
System.Threading.Tasks.Task

PinColumn(IgbDataGridColumn, PinnedPositions)

Declaration
public void PinColumn(IgbDataGridColumn column, PinnedPositions position)
Parameters
Type Name Description
IgbDataGridColumn column
PinnedPositions position

PinColumnAsync(IgbDataGridColumn, PinnedPositions)

Declaration
public Task PinColumnAsync(IgbDataGridColumn column, PinnedPositions position)
Parameters
Type Name Description
IgbDataGridColumn column
PinnedPositions position
Returns
Type Description
System.Threading.Tasks.Task

Redo()

Declaration
public void Redo()

RedoAsync()

Redo the last edit.

Declaration
public Task RedoAsync()
Returns
Type Description
System.Threading.Tasks.Task

Refresh()

Declaration
public void Refresh()

RefreshAsync()

Forces a refresh of the grid content.

Declaration
public Task RefreshAsync()
Returns
Type Description
System.Threading.Tasks.Task

RejectCommit(Int32)

Declaration
public void RejectCommit(int commitID)
Parameters
Type Name Description
System.Int32 commitID

RejectCommitAsync(Int32)

Declaration
public Task RejectCommitAsync(int commitID)
Parameters
Type Name Description
System.Int32 commitID
Returns
Type Description
System.Threading.Tasks.Task

RejectEdit(Int32)

Declaration
public void RejectEdit(int editID)
Parameters
Type Name Description
System.Int32 editID

RejectEditAsync(Int32)

Reject a pending edit.

Declaration
public Task RejectEditAsync(int editID)
Parameters
Type Name Description
System.Int32 editID

The ID of the edit. Provided by the CellValueChanging event.
Returns
Type Description
System.Threading.Tasks.Task

RemoveItem(Object)

Declaration
public void RemoveItem(object item)
Parameters
Type Name Description
System.Object item

RemoveItemAsync(Object)

Removes an item by its instance.

Declaration
public Task RemoveItemAsync(object item)
Parameters
Type Name Description
System.Object item

The item instance to remove.
Returns
Type Description
System.Threading.Tasks.Task

RemoveItemByKey(Object[])

Declaration
public void RemoveItemByKey(object[] key)
Parameters
Type Name Description
System.Object[] key

RemoveItemByKeyAsync(Object[])

Declaration
public Task RemoveItemByKeyAsync(object[] key)
Parameters
Type Name Description
System.Object[] key
Returns
Type Description
System.Threading.Tasks.Task

ResolveCellValue(IgbCellKey)

Declaration
public object ResolveCellValue(IgbCellKey cellKey)
Parameters
Type Name Description
IgbCellKey cellKey
Returns
Type Description
System.Object

ResolveCellValueAsync(IgbCellKey)

Declaration
public Task<object> ResolveCellValueAsync(IgbCellKey cellKey)
Parameters
Type Name Description
IgbCellKey cellKey
Returns
Type Description
System.Threading.Tasks.Task<System.Object>

ResolveCellValueFromPosition(Int32, Int32)

Declaration
public object ResolveCellValueFromPosition(int row, int column)
Parameters
Type Name Description
System.Int32 row
System.Int32 column
Returns
Type Description
System.Object

ResolveCellValueFromPositionAsync(Int32, Int32)

Declaration
public Task<object> ResolveCellValueFromPositionAsync(int row, int column)
Parameters
Type Name Description
System.Int32 row
System.Int32 column
Returns
Type Description
System.Threading.Tasks.Task<System.Object>

SaveLayout()

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

SaveLayoutAsync()

Saves the layout chnages that have been made to the grid

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

ScrollToColumnByIndex(Double)

Declaration
public void ScrollToColumnByIndex(double columnNumber)
Parameters
Type Name Description
System.Double columnNumber

ScrollToColumnByIndexAsync(Double)

Scrolls the grid to given column, by index

Declaration
public Task ScrollToColumnByIndexAsync(double columnNumber)
Parameters
Type Name Description
System.Double columnNumber

The column number to scroll to.
Returns
Type Description
System.Threading.Tasks.Task

ScrollToItem(Object)

Declaration
public bool ScrollToItem(object item)
Parameters
Type Name Description
System.Object item
Returns
Type Description
System.Boolean

ScrollToItemAsync(Object)

Scrolls to an item, if found.

Declaration
public Task<bool> ScrollToItemAsync(object item)
Parameters
Type Name Description
System.Object item

The item to scroll to.
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

ScrollToLastRowByIndex(Double)

Declaration
public void ScrollToLastRowByIndex(double rowNumber)
Parameters
Type Name Description
System.Double rowNumber

ScrollToLastRowByIndexAsync(Double)

Scrolls the grid so that a row is the last visible, by index.

Declaration
public Task ScrollToLastRowByIndexAsync(double rowNumber)
Parameters
Type Name Description
System.Double rowNumber

The row index to scroll to.
Returns
Type Description
System.Threading.Tasks.Task

ScrollToPrimaryKey(Object[])

Declaration
public bool ScrollToPrimaryKey(object[] key)
Parameters
Type Name Description
System.Object[] key
Returns
Type Description
System.Boolean

ScrollToPrimaryKeyAsync(Object[])

Declaration
public Task<bool> ScrollToPrimaryKeyAsync(object[] key)
Parameters
Type Name Description
System.Object[] key
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

ScrollToRowByIndex(Double)

Declaration
public void ScrollToRowByIndex(double rowNumber)
Parameters
Type Name Description
System.Double rowNumber

ScrollToRowByIndexAsync(Double)

Scrolls the grid to given row, by index

Declaration
public Task ScrollToRowByIndexAsync(double rowNumber)
Parameters
Type Name Description
System.Double rowNumber

The row index to scroll to.
Returns
Type Description
System.Threading.Tasks.Task

SelectAllRows()

Declaration
public void SelectAllRows()

SelectAllRowsAsync()

Selects all of the rows in the grid.

Declaration
public Task SelectAllRowsAsync()
Returns
Type Description
System.Threading.Tasks.Task

SetActiveResponsiveState(String)

Declaration
public void SetActiveResponsiveState(string name)
Parameters
Type Name Description
System.String name

SetActiveResponsiveStateAsync(String)

Manually set the active responsive state of the grid.

Declaration
public Task SetActiveResponsiveStateAsync(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
System.Threading.Tasks.Task

SetCustomizedStringAsync(String, Dictionary<String, String>)

Provide a new set of localized strings to use for a given languange.

Declaration
public Task<object> SetCustomizedStringAsync(string language, Dictionary<string, string> values)
Parameters
Type Name Description
System.String language

The browser language the strings will be used with. I.e. "ja", "en", "fr", etc.
System.Collections.Generic.Dictionary<System.String, System.String> values

The new string value.
Returns
Type Description
System.Threading.Tasks.Task<System.Object>

SetCustomizedStringAsync(String, String)

Provide a new set of localized strings to use for a given languange.

Declaration
public Task<object> SetCustomizedStringAsync(string language, string json)
Parameters
Type Name Description
System.String language

The browser language the strings will be used with. I.e. "ja", "en", "fr", etc.
System.String json

The new string values in json format.
Returns
Type Description
System.Threading.Tasks.Task<System.Object>

SetCustomizedStringAsync(String, String, String)

Provide a new set of localized strings to use for a given languange.

Declaration
public Task<object> SetCustomizedStringAsync(string language, string id, string value)
Parameters
Type Name Description
System.String language

The browser language the strings will be used with. I.e. "ja", "en", "fr", etc.
System.String id

The id of the string to set.
System.String value

The new string value.
Returns
Type Description
System.Threading.Tasks.Task<System.Object>

SetEditError(Int32, String)

Declaration
public void SetEditError(int editID, string errorMessage)
Parameters
Type Name Description
System.Int32 editID
System.String errorMessage

SetEditErrorAsync(Int32, String)

Declaration
public Task SetEditErrorAsync(int editID, string errorMessage)
Parameters
Type Name Description
System.Int32 editID
System.String errorMessage
Returns
Type Description
System.Threading.Tasks.Task

StartEditMode()

Declaration
public void StartEditMode()

StartEditModeAsync()

Start edit mode on the active cell.

Declaration
public Task StartEditModeAsync()
Returns
Type Description
System.Threading.Tasks.Task

Undo()

Declaration
public void Undo()

UndoAsync()

Undo the last edit.

Declaration
public Task UndoAsync()
Returns
Type Description
System.Threading.Tasks.Task

UpdatePropertyAtKey(Object[], String, Object)

Declaration
public void UpdatePropertyAtKey(object[] key, string propertyPath, object value)
Parameters
Type Name Description
System.Object[] key
System.String propertyPath
System.Object value

UpdatePropertyAtKeyAsync(Object[], String, Object)

Declaration
public Task UpdatePropertyAtKeyAsync(object[] key, string propertyPath, object value)
Parameters
Type Name Description
System.Object[] key
System.String propertyPath
System.Object value
Returns
Type Description
System.Threading.Tasks.Task

Implements

System.IDisposable