An advanced grid for displaying data.

Inheritance

object
Implements
  • IComponent
  • IHandleEvent
  • IHandleAfterRender
  • JsonSerializable
  • IDisposable

Constructors

Section titled "Constructors"

constructor

public IgbDataGrid()

Returns IgbDataGrid

Properties

Section titled "Properties"

IgBlazor

Section titled "IgBlazor"

Inherited from: BaseRendererControl 

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

Height

Section titled "Height"

Inherited from: BaseRendererControl 

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

Width

Section titled "Width"

Inherited from: BaseRendererControl 

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

Class

Section titled "Class"

Inherited from: BaseRendererControl 

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

AdditionalAttributes

Section titled "AdditionalAttributes"

Inherited from: BaseRendererControl 

[Parameter(CaptureUnmatchedValues = true)]
public Dictionary<string, object> AdditionalAttributes { get; set; }

EventBehavior

Section titled "EventBehavior"

Inherited from: BaseRendererControl

Gets or sets how events are bubbled up from JavaScript to Blazor.

 
[Parameter]
public ControlEventBehavior EventBehavior { get; set; }

ChildContent

Section titled "ChildContent"

Inherited from: BaseRendererControl 

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

RoundTripDateConversion

Section titled "RoundTripDateConversion"

Inherited from: BaseRendererControl

Gets or sets what type of date conversion to make when round tripping dates.

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

SupportsVisualChildren

Section titled "SupportsVisualChildren"

Inherited from: BaseRendererControl 

protected virtual bool SupportsVisualChildren { get; }

UseDirectRender

Section titled "UseDirectRender"

Inherited from: BaseRendererControl 

protected virtual bool UseDirectRender { get; }

DirectRenderElementName

Section titled "DirectRenderElementName"

Inherited from: BaseRendererControl 

protected virtual string DirectRenderElementName { get; }

UseCamelEnumValues

Section titled "UseCamelEnumValues"

Inherited from: BaseRendererControl 

protected virtual bool UseCamelEnumValues { get; }

ActivationMode

Section titled "ActivationMode"

Sets or gets the grid selection mode.

 
[Parameter]
public GridActivationMode ActivationMode { get; set; }

ActiveCell

Section titled "ActiveCell"

Gets or sets the position of the active cell.

 
[Parameter]
public IgbGridCellPosition ActiveCell { get; set; }

ActiveCellChanged

Section titled "ActiveCellChanged" 
[Parameter]
public Action<IgbGridActiveCellChangedEventArgs> ActiveCellChanged { get; set; }

ActiveCellChangedScript

Section titled "ActiveCellChangedScript" 
[Parameter]
public string ActiveCellChangedScript { get; set; }

ActualBackground

Section titled "ActualBackground"

Gets the actual background for the grid.

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

ActualBorder

Section titled "ActualBorder"

Gets the actual border color around the grid.

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

ActualColumns

Section titled "ActualColumns" 
public IgbGridColumnCollection ActualColumns { get; protected set; }

ActualColumnsChanged

Section titled "ActualColumnsChanged" 
[Parameter]
public Action<IgbGridColumnsChangedEventArgs> ActualColumnsChanged { get; set; }

ActualColumnsChangedScript

Section titled "ActualColumnsChangedScript" 
[Parameter]
public string ActualColumnsChangedScript { get; set; }

ActualDataSource

Section titled "ActualDataSource" 
public IgbBaseDataSource ActualDataSource { get; }

ActualHeaderHeight

Section titled "ActualHeaderHeight"

Gets the height used for the header row.

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

ActualPrimaryKey

Section titled "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.

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

ActualRowHeight

Section titled "ActualRowHeight"

Gets the actual height for the rows in the grid.

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

AllowCopyOperation

Section titled "AllowCopyOperation" 
[Parameter]
public bool AllowCopyOperation { get; set; }

AnimationSettings

Section titled "AnimationSettings"

Sets or gets the default animation settings for the grid.

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

AutoAcceptEdits

Section titled "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.

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

AutoGenerateColumns

Section titled "AutoGenerateColumns"

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

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

AutoGenerateDesiredProperties

Section titled "AutoGenerateDesiredProperties"

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

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

Background

Section titled "Background"

Gets or sets the background for the grid.

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

Border

Section titled "Border"

Gets or sets the border color around the grid.

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

BorderWidthBottom

Section titled "BorderWidthBottom" 
[Parameter]
public double BorderWidthBottom { get; set; }

BorderWidthLeft

Section titled "BorderWidthLeft" 
[Parameter]
public double BorderWidthLeft { get; set; }

BorderWidthRight

Section titled "BorderWidthRight" 
[Parameter]
public double BorderWidthRight { get; set; }

BorderWidthTop

Section titled "BorderWidthTop" 
[Parameter]
public double BorderWidthTop { get; set; }

CellBackground

Section titled "CellBackground"

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

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

CellClicked

Section titled "CellClicked" 
[Parameter]
public Action<IgbDataGridCellEventArgs> CellClicked { get; set; }

CellClickedScript

Section titled "CellClickedScript" 
[Parameter]
public string CellClickedScript { get; set; }

CellDataLoadedAnimationMode

Section titled "CellDataLoadedAnimationMode"

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

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

CellEditEnded

Section titled "CellEditEnded" 
[Parameter]
public Action<IgbGridCellEditEndedEventArgs> CellEditEnded { get; set; }

CellEditEndedScript

Section titled "CellEditEndedScript" 
[Parameter]
public string CellEditEndedScript { get; set; }

CellEditStarted

Section titled "CellEditStarted" 
[Parameter]
public Action<IgbGridCellEditStartedEventArgs> CellEditStarted { get; set; }

CellEditStartedScript

Section titled "CellEditStartedScript" 
[Parameter]
public string CellEditStartedScript { get; set; }

CellFontFamily

Section titled "CellFontFamily" 
[Parameter]
public string CellFontFamily { get; set; }

CellFontSize

Section titled "CellFontSize" 
[Parameter]
public double CellFontSize { get; set; }

CellFontStyle

Section titled "CellFontStyle" 
[Parameter]
public string CellFontStyle { get; set; }

CellFontWeight

Section titled "CellFontWeight" 
[Parameter]
public string CellFontWeight { get; set; }

CellPointerDown

Section titled "CellPointerDown" 
[Parameter]
public Action<IgbDataGridCellEventArgs> CellPointerDown { get; set; }

CellPointerDownScript

Section titled "CellPointerDownScript" 
[Parameter]
public string CellPointerDownScript { get; set; }

CellPointerUp

Section titled "CellPointerUp" 
[Parameter]
public Action<IgbDataGridCellEventArgs> CellPointerUp { get; set; }

CellPointerUpScript

Section titled "CellPointerUpScript" 
[Parameter]
public string CellPointerUpScript { get; set; }

CellPreviewPointerDown

Section titled "CellPreviewPointerDown" 
[Parameter]
public Action<IgbDataGridCellEventArgs> CellPreviewPointerDown { get; set; }

CellPreviewPointerDownScript

Section titled "CellPreviewPointerDownScript" 
[Parameter]
public string CellPreviewPointerDownScript { get; set; }

CellPreviewPointerUp

Section titled "CellPreviewPointerUp" 
[Parameter]
public Action<IgbDataGridCellEventArgs> CellPreviewPointerUp { get; set; }

CellPreviewPointerUpScript

Section titled "CellPreviewPointerUpScript" 
[Parameter]
public string CellPreviewPointerUpScript { get; set; }

CellSelectedBackground

Section titled "CellSelectedBackground"

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

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

CellSelectedTextColor

Section titled "CellSelectedTextColor"

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

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

CellSelectionAnimationMode

Section titled "CellSelectionAnimationMode"

Sets or gets the cell selection animation mode to use.

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

CellTextColor

Section titled "CellTextColor"

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

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

CellValueChanging

Section titled "CellValueChanging" 
[Parameter]
public Action<IgbGridCellValueChangingEventArgs> CellValueChanging { get; set; }

CellValueChangingScript

Section titled "CellValueChangingScript" 
[Parameter]
public string CellValueChangingScript { get; set; }

ClearSelectionOnEscape

Section titled "ClearSelectionOnEscape"

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

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

ColumnAddingAnimationMode

Section titled "ColumnAddingAnimationMode"

Sets or gets the Column Adding Animation mode to use.

 
[Parameter]
public ColumnShowingAnimationMode ColumnAddingAnimationMode { get; set; }

ColumnExchangingAnimationMode

Section titled "ColumnExchangingAnimationMode"

Sets or gets the column exchanging animation mode to use.

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

ColumnHiddenChanged

Section titled "ColumnHiddenChanged" 
[Parameter]
public Action<IgbColumnHiddenChangedEventArgs> ColumnHiddenChanged { get; set; }

ColumnHiddenChangedScript

Section titled "ColumnHiddenChangedScript" 
[Parameter]
public string ColumnHiddenChangedScript { get; set; }

ColumnHidingAnimationMode

Section titled "ColumnHidingAnimationMode"

Sets or gets the column hiding animation mode to use.

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

ColumnMovingAnimationMode

Section titled "ColumnMovingAnimationMode"

Sets or gets the column moving animation mode to use.

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

ColumnMovingMode

Section titled "ColumnMovingMode"

Gets or sets the type column moving to use.

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

ColumnMovingSeparator

Section titled "ColumnMovingSeparator"

Gets or sets the column resizing seperator settings.

 
[Parameter]
public IgbColumnMovingSeparator ColumnMovingSeparator { get; set; }

ColumnMovingSeparatorBackground

Section titled "ColumnMovingSeparatorBackground"

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

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

ColumnMovingSeparatorOpacity

Section titled "ColumnMovingSeparatorOpacity"

Gets or sets the opacity of the column moving separator.

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

ColumnMovingSeparatorWidth

Section titled "ColumnMovingSeparatorWidth"

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

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

ColumnOptionsAccentColor

Section titled "ColumnOptionsAccentColor" 
[Parameter]
public string ColumnOptionsAccentColor { get; set; }

ColumnOptionsBackground

Section titled "ColumnOptionsBackground"

Gets or sets the column options dropdown background color.

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

ColumnOptionsFontFamily

Section titled "ColumnOptionsFontFamily" 
[Parameter]
public string ColumnOptionsFontFamily { get; set; }

ColumnOptionsFontSize

Section titled "ColumnOptionsFontSize" 
[Parameter]
public double ColumnOptionsFontSize { get; set; }

ColumnOptionsFontStyle

Section titled "ColumnOptionsFontStyle" 
[Parameter]
public string ColumnOptionsFontStyle { get; set; }

ColumnOptionsFontWeight

Section titled "ColumnOptionsFontWeight" 
[Parameter]
public string ColumnOptionsFontWeight { get; set; }

ColumnOptionsGroupHeaderBackground

Section titled "ColumnOptionsGroupHeaderBackground"

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

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

ColumnOptionsGroupHeaderFontFamily

Section titled "ColumnOptionsGroupHeaderFontFamily" 
[Parameter]
public string ColumnOptionsGroupHeaderFontFamily { get; set; }

ColumnOptionsGroupHeaderFontSize

Section titled "ColumnOptionsGroupHeaderFontSize" 
[Parameter]
public double ColumnOptionsGroupHeaderFontSize { get; set; }

ColumnOptionsGroupHeaderFontStyle

Section titled "ColumnOptionsGroupHeaderFontStyle" 
[Parameter]
public string ColumnOptionsGroupHeaderFontStyle { get; set; }

ColumnOptionsGroupHeaderFontWeight

Section titled "ColumnOptionsGroupHeaderFontWeight" 
[Parameter]
public string ColumnOptionsGroupHeaderFontWeight { get; set; }

ColumnOptionsGroupHeaderTextColor

Section titled "ColumnOptionsGroupHeaderTextColor"

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

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

ColumnOptionsHighlightColor

Section titled "ColumnOptionsHighlightColor"

Gets or sets the highlight color inside the column options menu.

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

ColumnOptionsHoverBackgroundColor

Section titled "ColumnOptionsHoverBackgroundColor"

Gets or sets the hover background color inside the column options menu.

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

ColumnOptionsIconAlignment

Section titled "ColumnOptionsIconAlignment"

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

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

ColumnOptionsIconBehavior

Section titled "ColumnOptionsIconBehavior"

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

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

ColumnOptionsIconColor

Section titled "ColumnOptionsIconColor"

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

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

ColumnOptionsRowHeight

Section titled "ColumnOptionsRowHeight"

Gets or sets the row height for submenus inside the column options menu.

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

ColumnOptionsScrollbarActiveBackground

Section titled "ColumnOptionsScrollbarActiveBackground"

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

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

ColumnOptionsScrollbarBackground

Section titled "ColumnOptionsScrollbarBackground"

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

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

ColumnOptionsScrollbarHoverBackground

Section titled "ColumnOptionsScrollbarHoverBackground"

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

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

ColumnOptionsSeparatorColor

Section titled "ColumnOptionsSeparatorColor"

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

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

ColumnOptionsTextColor

Section titled "ColumnOptionsTextColor"

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

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

ColumnOptionsToolTipBackgroundColor

Section titled "ColumnOptionsToolTipBackgroundColor"

Gets or sets the tooltip background color inside the column options menu.

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

ColumnOptionsToolTipTextColor

Section titled "ColumnOptionsToolTipTextColor"

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

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

ColumnPinnedChanged

Section titled "ColumnPinnedChanged" 
[Parameter]
public Action<IgbColumnPinnedChangedEventArgs> ColumnPinnedChanged { get; set; }

ColumnPinnedChangedScript

Section titled "ColumnPinnedChangedScript" 
[Parameter]
public string ColumnPinnedChangedScript { get; set; }

ColumnPropertyUpdatingAnimationMode

Section titled "ColumnPropertyUpdatingAnimationMode"

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

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

ColumnResizingAnimationMode

Section titled "ColumnResizingAnimationMode"

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

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

ColumnResizingMode

Section titled "ColumnResizingMode"

Gets or sets the type of column resizing to use.

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

ColumnResizingSeparator

Section titled "ColumnResizingSeparator"

Gets or sets the column resizing seperator settings.

 
[Parameter]
public IgbColumnResizingSeparator ColumnResizingSeparator { get; set; }

ColumnResizingSeparatorBackground

Section titled "ColumnResizingSeparatorBackground"

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

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

ColumnResizingSeparatorOpacity

Section titled "ColumnResizingSeparatorOpacity"

Gets or sets the opacity of the column Resizing separator.

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

ColumnResizingSeparatorWidth

Section titled "ColumnResizingSeparatorWidth"

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

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

ColumnShowingAnimationMode

Section titled "ColumnShowingAnimationMode"

Sets or gets the column showing animation mode to use.

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

ColumnWidthChanged

Section titled "ColumnWidthChanged" 
[Parameter]
public Action<IgbGridColumnWidthChangedEventArgs> ColumnWidthChanged { get; set; }

ColumnWidthChangedScript

Section titled "ColumnWidthChangedScript" 
[Parameter]
public string ColumnWidthChangedScript { get; set; }

Columns

Section titled "Columns"

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

 
public IgbGridColumnCollection Columns { get; protected set; }

ColumnsAutoGenerated

Section titled "ColumnsAutoGenerated" 
[Parameter]
public Action<IgbGridColumnsAutoGeneratedEventArgs> ColumnsAutoGenerated { get; set; }

ColumnsAutoGeneratedScript

Section titled "ColumnsAutoGeneratedScript" 
[Parameter]
public string ColumnsAutoGeneratedScript { get; set; }

ContentColumns

Section titled "ContentColumns" 
public IgbGridColumnCollection ContentColumns { get; }

CornerRadiusBottomLeft

Section titled "CornerRadiusBottomLeft" 
[Parameter]
public double CornerRadiusBottomLeft { get; set; }

CornerRadiusBottomRight

Section titled "CornerRadiusBottomRight" 
[Parameter]
public double CornerRadiusBottomRight { get; set; }

CornerRadiusTopLeft

Section titled "CornerRadiusTopLeft" 
[Parameter]
public double CornerRadiusTopLeft { get; set; }

CornerRadiusTopRight

Section titled "CornerRadiusTopRight" 
[Parameter]
public double CornerRadiusTopRight { get; set; }

CustomFilterRequested

Section titled "CustomFilterRequested" 
[Parameter]
public Action<IgbGridCustomFilterRequestedEventArgs> CustomFilterRequested { get; set; }

DataCommitted

Section titled "DataCommitted" 
[Parameter]
public Action<IgbGridDataCommittedEventArgs> DataCommitted { get; set; }

DataCommittedScript

Section titled "DataCommittedScript" 
[Parameter]
public string DataCommittedScript { get; set; }

DataCommitting

Section titled "DataCommitting"

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

 
[Parameter]
public Action<IgbGridDataCommittingEventArgs> DataCommitting { get; set; }

DataSource

Section titled "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.

 
[Parameter]
[WCWidgetMemberName("dataSource")]
public object DataSource { get; set; }

DataSourceDesiredProperties

Section titled "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.

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

DataSourceScript

Section titled "DataSourceScript"

Provides a means of setting DataSource in the JavaScript environment.

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

DefaultColumnMinWidth

Section titled "DefaultColumnMinWidth"

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

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

DefaultEventBehavior

Section titled "DefaultEventBehavior"

Gets the components default event behavior.

 
protected override ControlEventBehavior DefaultEventBehavior { get; }

DeferEventForRowDragSelection

Section titled "DeferEventForRowDragSelection"

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

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

DeletedTextColor

Section titled "DeletedTextColor"

Gets or sets the text color for unsaved deleted rows.

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

Density

Section titled "Density"

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

 
[Parameter]
public ControlDisplayDensity Density { get; set; }

EditFontFamily

Section titled "EditFontFamily" 
[Parameter]
public string EditFontFamily { get; set; }

EditFontSize

Section titled "EditFontSize" 
[Parameter]
public double EditFontSize { get; set; }

EditFontStyle

Section titled "EditFontStyle" 
[Parameter]
public string EditFontStyle { get; set; }

EditFontWeight

Section titled "EditFontWeight" 
[Parameter]
public string EditFontWeight { get; set; }

EditMode

Section titled "EditMode"

Gets or sets the type of edit mode

 
[Parameter]
public EditModeType EditMode { get; set; }

EditModeClickAction

Section titled "EditModeClickAction"

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

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

EditOnKeyPress

Section titled "EditOnKeyPress"

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

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

EditOpacity

Section titled "EditOpacity"

Gets or sets the default opacity for unsaved cell edits.

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

EditRowBorder

Section titled "EditRowBorder"

Gets or sets the border color for rows being edited.

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

EditRowBorderWidthBottom

Section titled "EditRowBorderWidthBottom" 
[Parameter]
public double EditRowBorderWidthBottom { get; set; }

EditRowBorderWidthLeft

Section titled "EditRowBorderWidthLeft" 
[Parameter]
public double EditRowBorderWidthLeft { get; set; }

EditRowBorderWidthRight

Section titled "EditRowBorderWidthRight" 
[Parameter]
public double EditRowBorderWidthRight { get; set; }

EditRowBorderWidthTop

Section titled "EditRowBorderWidthTop" 
[Parameter]
public double EditRowBorderWidthTop { get; set; }

EnterBehavior

Section titled "EnterBehavior"

Gets or sets the behavior of the Enter key.

 
[Parameter]
public EnterKeyBehaviors EnterBehavior { get; set; }

EnterBehaviorAfterEdit

Section titled "EnterBehaviorAfterEdit"

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

 
[Parameter]
public EnterKeyBehaviorAfterEdit EnterBehaviorAfterEdit { get; set; }

ExpandCollapseOnSectionHeaderClick

Section titled "ExpandCollapseOnSectionHeaderClick"

Gets or sets whether clicking anywhere inside a section header cell toggles the group's expansion state. When false (the default), only the expansion indicator toggles the group.

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

FilterComparisonType

Section titled "FilterComparisonType"

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

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

FilterExpressions

Section titled "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.

 
public IgbFilterExpressionCollection FilterExpressions { get; protected set; }

FilterExpressionsChanged

Section titled "FilterExpressionsChanged" 
[Parameter]
public Action<IgbGridFilterExpressionsEventArgs> FilterExpressionsChanged { get; set; }

FilterExpressionsChangedScript

Section titled "FilterExpressionsChangedScript" 
[Parameter]
public string FilterExpressionsChangedScript { get; set; }

FilterExpressionsChanging

Section titled "FilterExpressionsChanging" 
[Parameter]
public Action<IgbGridFilterExpressionsEventArgs> FilterExpressionsChanging { get; set; }

FilterExpressionsChangingScript

Section titled "FilterExpressionsChangingScript" 
[Parameter]
public string FilterExpressionsChangingScript { get; set; }

FilterLogicalOperator

Section titled "FilterLogicalOperator"

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

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

FilterRowDataBinding

Section titled "FilterRowDataBinding" 
[Parameter]
public Action<IgbDataBindingEventArgs> FilterRowDataBinding { get; set; }

FilterRowDataBindingScript

Section titled "FilterRowDataBindingScript" 
[Parameter]
public string FilterRowDataBindingScript { get; set; }

FilterRowDataBound

Section titled "FilterRowDataBound" 
[Parameter]
public Action<IgbDataBindingEventArgs> FilterRowDataBound { get; set; }

FilterRowDataBoundScript

Section titled "FilterRowDataBoundScript" 
[Parameter]
public string FilterRowDataBoundScript { get; set; }

FilterUIType

Section titled "FilterUIType"

Gets or sets which filter UI type to use.

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

GroupDescriptions

Section titled "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.

 
public IgbColumnGroupDescriptionCollection GroupDescriptions { get; protected set; }

GroupDescriptionsChanged

Section titled "GroupDescriptionsChanged" 
[Parameter]
public Action<IgbGridGroupDescriptionsChangedEventArgs> GroupDescriptionsChanged { get; set; }

GroupDescriptionsChangedScript

Section titled "GroupDescriptionsChangedScript" 
[Parameter]
public string GroupDescriptionsChangedScript { get; set; }

GroupHeaderDisplayMode

Section titled "GroupHeaderDisplayMode"

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

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

GroupSummaryDisplayMode

Section titled "GroupSummaryDisplayMode"

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

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

HeaderBackground

Section titled "HeaderBackground"

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

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

HeaderClickAction

Section titled "HeaderClickAction"

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

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

HeaderFontFamily

Section titled "HeaderFontFamily" 
[Parameter]
public string HeaderFontFamily { get; set; }

HeaderFontSize

Section titled "HeaderFontSize" 
[Parameter]
public double HeaderFontSize { get; set; }

HeaderFontStyle

Section titled "HeaderFontStyle" 
[Parameter]
public string HeaderFontStyle { get; set; }

HeaderFontWeight

Section titled "HeaderFontWeight" 
[Parameter]
public string HeaderFontWeight { get; set; }

HeaderHeight

Section titled "HeaderHeight"

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

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

HeaderRowSeparator

Section titled "HeaderRowSeparator"

Gets or sets the header row seperator settings.

 
[Parameter]
public IgbHeaderRowSeparator HeaderRowSeparator { get; set; }

HeaderRowSeparatorBackground

Section titled "HeaderRowSeparatorBackground" 
[Parameter]
public string HeaderRowSeparatorBackground { get; set; }

HeaderSeparator

Section titled "HeaderSeparator"

Gets or sets the header seperator settings.

 
[Parameter]
public IgbHeaderSeparator HeaderSeparator { get; set; }

HeaderSeparatorBackground

Section titled "HeaderSeparatorBackground"

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

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

HeaderSeparatorWidth

Section titled "HeaderSeparatorWidth"

Gets or sets the width of the header separators.

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

HeaderSortIndicatorColor

Section titled "HeaderSortIndicatorColor"

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

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

HeaderSortIndicatorStyle

Section titled "HeaderSortIndicatorStyle"

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

 
[Parameter]
public SortIndicatorStyle HeaderSortIndicatorStyle { get; set; }

HeaderTextColor

Section titled "HeaderTextColor"

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

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

InitialGroupDescriptions

Section titled "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.

 
public IgbColumnGroupDescriptionCollection InitialGroupDescriptions { get; protected set; }

InitialGroups

Section titled "InitialGroups" 
[Parameter]
public string InitialGroups { get; set; }

InitialSortDescriptions

Section titled "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.

 
public IgbColumnSortDescriptionCollection InitialSortDescriptions { get; protected set; }

InitialSorts

Section titled "InitialSorts" 
[Parameter]
public string InitialSorts { get; set; }

InitialSummaries

Section titled "InitialSummaries" 
[Parameter]
public string InitialSummaries { get; set; }

InitialSummaryDescriptions

Section titled "InitialSummaryDescriptions"

Gets the current summaries that are applied to the grid.

 
public IgbColumnSummaryDescriptionCollection InitialSummaryDescriptions { get; protected set; }

IsActiveCellStyleEnabled

Section titled "IsActiveCellStyleEnabled"

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

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

IsColumnOptionsEnabled

Section titled "IsColumnOptionsEnabled"

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

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

IsColumnOptionsGroupingEnabled

Section titled "IsColumnOptionsGroupingEnabled"

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

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

IsColumnOptionsSummariesEnabled

Section titled "IsColumnOptionsSummariesEnabled"

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

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

IsGroupByAreaVisible

Section titled "IsGroupByAreaVisible"

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

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

IsGroupCollapsable

Section titled "IsGroupCollapsable"

Gets or sets whether group headers are collapsable.

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

IsGroupExpandedDefault

Section titled "IsGroupExpandedDefault"

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

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

IsGroupRowSticky

Section titled "IsGroupRowSticky"

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

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

IsHeaderSeparatorVisible

Section titled "IsHeaderSeparatorVisible"

Gets or sets if header separators are rendered.

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

IsPagerVisible

Section titled "IsPagerVisible"

Gets or sets whether to show the pager or not.

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

IsPlaceholderRenderingEnabled

Section titled "IsPlaceholderRenderingEnabled"

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

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

IsRowHoverEnabled

Section titled "IsRowHoverEnabled"

Gets or sets whether the row will highlight when hovered.

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

IsToolbarColumnChooserVisible

Section titled "IsToolbarColumnChooserVisible"

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

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

IsToolbarColumnPinningVisible

Section titled "IsToolbarColumnPinningVisible"

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

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

IsToolbarVisible

Section titled "IsToolbarVisible"

Gets or sets whether to show the toolbar.

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

LastStickyRowBackground

Section titled "LastStickyRowBackground"

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

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

MaxSelectedCellRanges

Section titled "MaxSelectedCellRanges" 
[Parameter]
public int MaxSelectedCellRanges { get; set; }

MergedCellEvaluationCriteria

Section titled "MergedCellEvaluationCriteria"

Gets or sets how cells are evaluated for merging.

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

MergedCellMode

Section titled "MergedCellMode"

Gets or sets if and how cell merging is performed for all fields.

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

MergedCellVerticalAlignment

Section titled "MergedCellVerticalAlignment"

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

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

MouseDragSelectionEnabled

Section titled "MouseDragSelectionEnabled"

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

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

NeedsDynamicContent

Section titled "NeedsDynamicContent" 
protected override bool NeedsDynamicContent { get; }

NotifyOnAllSelectionChanges

Section titled "NotifyOnAllSelectionChanges"

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

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

PageSize

Section titled "PageSize"

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

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

ParentTypeName

Section titled "ParentTypeName" 
protected override string ParentTypeName { get; }

PinnedAreaSeparator

Section titled "PinnedAreaSeparator"

Gets or sets the pinned area separator settings.

 
[Parameter]
public IgbPinnedAreaSeparator PinnedAreaSeparator { get; set; }

PinnedAreaSeparatorWidth

Section titled "PinnedAreaSeparatorWidth"

Gets or sets the width of the pinned area separators.

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

PinnedItems

Section titled "PinnedItems"

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

 
public IgbGridSelectedItemsCollection PinnedItems { get; protected set; }

PinnedKeys

Section titled "PinnedKeys"

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

 
public IgbGridSelectedKeysCollection PinnedKeys { get; protected set; }

PinnedRowBackground

Section titled "PinnedRowBackground"

Gets or sets the default color to use for pinned rows

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

PinnedRowOpacity

Section titled "PinnedRowOpacity"

Gets or sets the default opacity to use for pinned rows

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

PrimaryKey

Section titled "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.

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

ReactsToFilterChanges

Section titled "ReactsToFilterChanges"

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

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

ReactsToGroupChanges

Section titled "ReactsToGroupChanges"

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

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

ReactsToSortChanges

Section titled "ReactsToSortChanges"

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

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

ResponsiveStates

Section titled "ResponsiveStates"

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

 
public IgbResponsiveStatesCollection ResponsiveStates { get; protected set; }

RowEditEnded

Section titled "RowEditEnded"

Called when a row has finished editing.

 
[Parameter]
public Action<IgbGridRowEditEndedEventArgs> RowEditEnded { get; set; }

RowEditStarted

Section titled "RowEditStarted" 
[Parameter]
public Action<IgbGridRowEditStartedEventArgs> RowEditStarted { get; set; }

RowEditStartedScript

Section titled "RowEditStartedScript" 
[Parameter]
public string RowEditStartedScript { get; set; }

RowHeight

Section titled "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.

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

RowHoverAnimationMode

Section titled "RowHoverAnimationMode"

Sets or gets the row hover animation mode to use.

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

RowHoverBackground

Section titled "RowHoverBackground"

Gets or sets the background color for rows when hovered.

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

RowHoverTextColor

Section titled "RowHoverTextColor"

Gets or sets the text color for rows when hovered.

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

RowSelectionAnimationMode

Section titled "RowSelectionAnimationMode"

Sets or gets the row selection animation mode to use.

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

RowSeparator

Section titled "RowSeparator"

Gets or sets the row seperator settings.

 
[Parameter]
public IgbRowSeparator RowSeparator { get; set; }

RowSeparatorBackground

Section titled "RowSeparatorBackground"

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

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

RowSeparatorHeight

Section titled "RowSeparatorHeight"

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

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

RowSeparatorLastStickyRowBackground

Section titled "RowSeparatorLastStickyRowBackground"

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

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

RowSeparatorPinnedRowBackground

Section titled "RowSeparatorPinnedRowBackground"

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

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

RowSeparatorStickyRowBackground

Section titled "RowSeparatorStickyRowBackground"

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

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

ScrollbarActiveBackground

Section titled "ScrollbarActiveBackground"

Gets or sets the scrollbar thumb background color when the user is dragging it.

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

ScrollbarBackground

Section titled "ScrollbarBackground"

Gets or sets the scrollbar background color.

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

ScrollbarHoverBackground

Section titled "ScrollbarHoverBackground"

Gets or sets the scrollbar thumb background color when the pointer is over it.

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

ScrollbarStyle

Section titled "ScrollbarStyle"

Gets or sets the style of scrollbar.

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

SectionHeader

Section titled "SectionHeader"

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

 
[Parameter]
public IgbSectionHeader SectionHeader { get; set; }

SectionHeaderBackground

Section titled "SectionHeaderBackground"

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

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

SectionHeaderExpansionIndicatorIconColor

Section titled "SectionHeaderExpansionIndicatorIconColor"

Gets or sets the color to use for the expansion indicator icon on section header cells. When unset, the icon defers to the section header text color.

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

SectionHeaderFontFamily

Section titled "SectionHeaderFontFamily" 
[Parameter]
public string SectionHeaderFontFamily { get; set; }

SectionHeaderFontSize

Section titled "SectionHeaderFontSize" 
[Parameter]
public double SectionHeaderFontSize { get; set; }

SectionHeaderFontStyle

Section titled "SectionHeaderFontStyle" 
[Parameter]
public string SectionHeaderFontStyle { get; set; }

SectionHeaderFontWeight

Section titled "SectionHeaderFontWeight" 
[Parameter]
public string SectionHeaderFontWeight { get; set; }

SectionHeaderSelectedBackground

Section titled "SectionHeaderSelectedBackground"

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

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

SectionHeaderTextColor

Section titled "SectionHeaderTextColor"

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

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

SelectedCellRanges

Section titled "SelectedCellRanges"

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

 
public IgbGridSelectedCellRangesCollection SelectedCellRanges { get; protected set; }

SelectedCellRangesChanged

Section titled "SelectedCellRangesChanged" 
[Parameter]
public Action<IgbGridSelectedCellRangesChangedEventArgs> SelectedCellRangesChanged { get; set; }

SelectedCellRangesChangedScript

Section titled "SelectedCellRangesChangedScript" 
[Parameter]
public string SelectedCellRangesChangedScript { get; set; }

SelectedCells

Section titled "SelectedCells"

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

 
public IgbGridSelectedCellsCollection SelectedCells { get; protected set; }

SelectedCellsChanged

Section titled "SelectedCellsChanged" 
[Parameter]
public Action<IgbGridSelectedCellsChangedEventArgs> SelectedCellsChanged { get; set; }

SelectedCellsChangedScript

Section titled "SelectedCellsChangedScript" 
[Parameter]
public string SelectedCellsChangedScript { get; set; }

SelectedItems

Section titled "SelectedItems"

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

 
public IgbGridSelectedItemsCollection SelectedItems { get; protected set; }

SelectedItemsChanged

Section titled "SelectedItemsChanged" 
[Parameter]
public Action<IgbGridSelectedItemsChangedEventArgs> SelectedItemsChanged { get; set; }

SelectedItemsChangedScript

Section titled "SelectedItemsChangedScript" 
[Parameter]
public string SelectedItemsChangedScript { get; set; }

SelectedKeys

Section titled "SelectedKeys"

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

 
public IgbGridSelectedKeysCollection SelectedKeys { get; protected set; }

SelectedKeysChanged

Section titled "SelectedKeysChanged" 
[Parameter]
public Action<IgbGridSelectedKeysChangedEventArgs> SelectedKeysChanged { get; set; }

SelectedKeysChangedScript

Section titled "SelectedKeysChangedScript" 
[Parameter]
public string SelectedKeysChangedScript { get; set; }

SelectionBehavior

Section titled "SelectionBehavior"

Sets or gets how selection behaves in the grid.

 
[Parameter]
public GridSelectionBehavior SelectionBehavior { get; set; }

SelectionChanged

Section titled "SelectionChanged" 
[Parameter]
public Action<IgbGridSelectionChangedEventArgs> SelectionChanged { get; set; }

SelectionChangedScript

Section titled "SelectionChangedScript" 
[Parameter]
public string SelectionChangedScript { get; set; }

SelectionMode

Section titled "SelectionMode"

Sets or gets the grid selection mode.

 
[Parameter]
public DataGridSelectionMode SelectionMode { get; set; }

ShiftSectionContent

Section titled "ShiftSectionContent"

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

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

SortDescriptions

Section titled "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.

 
public IgbColumnSortDescriptionCollection SortDescriptions { get; protected set; }

SortDescriptionsChanged

Section titled "SortDescriptionsChanged" 
[Parameter]
public Action<IgbGridSortDescriptionsChangedEventArgs> SortDescriptionsChanged { get; set; }

SortDescriptionsChangedScript

Section titled "SortDescriptionsChangedScript" 
[Parameter]
public string SortDescriptionsChangedScript { get; set; }

StickyRowBackground

Section titled "StickyRowBackground"

Gets or sets the default color to use for sticky rows

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

StopPropagation

Section titled "StopPropagation"

Prevents mouse events from bubbling out of the grid.

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

SummaryDescriptions

Section titled "SummaryDescriptions"

Gets the current summaries that are applied to the grid.

 
public IgbColumnSummaryDescriptionCollection SummaryDescriptions { get; protected set; }

SummaryDescriptionsChanged

Section titled "SummaryDescriptionsChanged" 
[Parameter]
public Action<IgbGridSummaryDescriptionsChangedEventArgs> SummaryDescriptionsChanged { get; set; }

SummaryDescriptionsChangedScript

Section titled "SummaryDescriptionsChangedScript" 
[Parameter]
public string SummaryDescriptionsChangedScript { get; set; }

SummaryRootBackground

Section titled "SummaryRootBackground"

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

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

SummaryRootLabelFontFamily

Section titled "SummaryRootLabelFontFamily" 
[Parameter]
public string SummaryRootLabelFontFamily { get; set; }

SummaryRootLabelFontSize

Section titled "SummaryRootLabelFontSize" 
[Parameter]
public double SummaryRootLabelFontSize { get; set; }

SummaryRootLabelFontStyle

Section titled "SummaryRootLabelFontStyle" 
[Parameter]
public string SummaryRootLabelFontStyle { get; set; }

SummaryRootLabelFontWeight

Section titled "SummaryRootLabelFontWeight" 
[Parameter]
public string SummaryRootLabelFontWeight { get; set; }

SummaryRootLabelTextColor

Section titled "SummaryRootLabelTextColor"

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

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

SummaryRootSelectedBackground

Section titled "SummaryRootSelectedBackground"

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

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

SummaryRootValueFontFamily

Section titled "SummaryRootValueFontFamily" 
[Parameter]
public string SummaryRootValueFontFamily { get; set; }

SummaryRootValueFontSize

Section titled "SummaryRootValueFontSize" 
[Parameter]
public double SummaryRootValueFontSize { get; set; }

SummaryRootValueFontStyle

Section titled "SummaryRootValueFontStyle" 
[Parameter]
public string SummaryRootValueFontStyle { get; set; }

SummaryRootValueFontWeight

Section titled "SummaryRootValueFontWeight" 
[Parameter]
public string SummaryRootValueFontWeight { get; set; }

SummaryRootValueTextColor

Section titled "SummaryRootValueTextColor"

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

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

SummaryRowRoot

Section titled "SummaryRowRoot"

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

 
[Parameter]
public IgbSummaryRowRoot SummaryRowRoot { get; set; }

SummaryRowSection

Section titled "SummaryRowSection"

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

 
[Parameter]
public IgbSummaryRowSection SummaryRowSection { get; set; }

SummaryScope

Section titled "SummaryScope"

Gets or sets the scope which summaries are calculated for.

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

SummarySectionBackground

Section titled "SummarySectionBackground"

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

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

SummarySectionLabelFontFamily

Section titled "SummarySectionLabelFontFamily" 
[Parameter]
public string SummarySectionLabelFontFamily { get; set; }

SummarySectionLabelFontSize

Section titled "SummarySectionLabelFontSize" 
[Parameter]
public double SummarySectionLabelFontSize { get; set; }

SummarySectionLabelFontStyle

Section titled "SummarySectionLabelFontStyle" 
[Parameter]
public string SummarySectionLabelFontStyle { get; set; }

SummarySectionLabelFontWeight

Section titled "SummarySectionLabelFontWeight" 
[Parameter]
public string SummarySectionLabelFontWeight { get; set; }

SummarySectionLabelTextColor

Section titled "SummarySectionLabelTextColor"

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

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

SummarySectionSelectedBackground

Section titled "SummarySectionSelectedBackground"

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

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

SummarySectionValueFontFamily

Section titled "SummarySectionValueFontFamily" 
[Parameter]
public string SummarySectionValueFontFamily { get; set; }

SummarySectionValueFontSize

Section titled "SummarySectionValueFontSize" 
[Parameter]
public double SummarySectionValueFontSize { get; set; }

SummarySectionValueFontStyle

Section titled "SummarySectionValueFontStyle" 
[Parameter]
public string SummarySectionValueFontStyle { get; set; }

SummarySectionValueFontWeight

Section titled "SummarySectionValueFontWeight" 
[Parameter]
public string SummarySectionValueFontWeight { get; set; }

SummarySectionValueTextColor

Section titled "SummarySectionValueTextColor"

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

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

Theme

Section titled "Theme"

Gets or sets the base theme used by the grid.

 
[Parameter]
public BaseControlTheme Theme { get; set; }

TodayOverride

Section titled "TodayOverride" 
[Parameter]
public DateTime TodayOverride { get; set; }

ToolbarColumnChooserText

Section titled "ToolbarColumnChooserText"

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

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

ToolbarColumnChooserTitle

Section titled "ToolbarColumnChooserTitle"

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

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

ToolbarColumnPinningText

Section titled "ToolbarColumnPinningText"

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

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

ToolbarColumnPinningTitle

Section titled "ToolbarColumnPinningTitle"

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

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

ToolbarTitle

Section titled "ToolbarTitle"

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

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

Type

Section titled "Type" 
public override string Type { get; }

UseNewerColumnOptionsMenu

Section titled "UseNewerColumnOptionsMenu" 
[Parameter]
public bool UseNewerColumnOptionsMenu { get; set; }

Accessors

Section titled "Accessors"

eventCallbacksCache

Section titled "eventCallbacksCache"

Inherited from: BaseRendererControl 

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

_cachedSerializedContent

Section titled "_cachedSerializedContent"

Inherited from: BaseRendererControl 

protected string _cachedSerializedContent

Methods

Section titled "Methods"

ResolveEventBehavior()

Section titled "ResolveEventBehavior()"

Inherited from: BaseRendererControl

Resolves the components event behavior if Auto is selected.

protected ControlEventBehavior ResolveEventBehavior()

Returns any

ResolveDisplay()

Section titled "ResolveDisplay()"

Inherited from: BaseRendererControl 

protected virtual string ResolveDisplay()

Returns any

ToSpinal(string)

Section titled "ToSpinal(string)"

Inherited from: BaseRendererControl 

protected string ToSpinal(string value)

Parameters

  • value: string

Returns any

TransformSimpleKey(string)

Section titled "TransformSimpleKey(string)"

Inherited from: BaseRendererControl 

protected virtual string TransformSimpleKey(string key)

Parameters

  • key: string

Returns any

IsTransformedEnumValue(string)

Section titled "IsTransformedEnumValue(string)"

Inherited from: BaseRendererControl 

protected virtual bool IsTransformedEnumValue(string key)

Parameters

  • key: string

Returns any

TransformPotentialEnumValue(string, object)

Section titled "TransformPotentialEnumValue(string, object)"

Inherited from: BaseRendererControl 

protected virtual object TransformPotentialEnumValue(string key, object value)

Parameters

  • key: string
  • value: object

Returns any

BuildSequenceInfo(int)

Section titled "BuildSequenceInfo(int)"

Inherited from: BaseRendererControl 

protected virtual SequenceInfo BuildSequenceInfo(int startSequence)

Parameters

  • startSequence: int

Returns any

BuildRenderTree(RenderTreeBuilder)

Section titled "BuildRenderTree(RenderTreeBuilder)"

Inherited from: BaseRendererControl 

protected override void BuildRenderTree(RenderTreeBuilder builder)

Parameters

  • builder: RenderTreeBuilder

Returns any

TemplateContentType(string)

Section titled "TemplateContentType(string)"

Inherited from: BaseRendererControl 

protected Type TemplateContentType(string templateId)

Parameters

  • templateId: string

Returns any

OnAfterRenderAsync(bool)

Section titled "OnAfterRenderAsync(bool)"

Inherited from: BaseRendererControl 

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

  • firstRender: bool

Returns any

EnsureReady()

Section titled "EnsureReady()"

Inherited from: BaseRendererControl 

public Task EnsureReady()

Returns any

MarkPropDirty(string)

Section titled "MarkPropDirty(string)"

Inherited from: BaseRendererControl 

protected void MarkPropDirty(string propertyName)

Parameters

  • propertyName: string

Returns any

IsPropDirty(string)

Section titled "IsPropDirty(string)"

Inherited from: BaseRendererControl 

protected bool IsPropDirty(string propertyName)

Parameters

  • propertyName: string

Returns any

Serialize(SerializationContext, string)

Section titled "Serialize(SerializationContext, string)"

Inherited from: BaseRendererControl 

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

Parameters

  • context: SerializationContext
  • propertyName: string

Returns any

Serialize()

Section titled "Serialize()"

Inherited from: BaseRendererControl 

public string Serialize()

Returns any

InvokeMethod(string, object[], string[], ElementReference[])

Section titled "InvokeMethod(string, object[], string[], ElementReference[])"

Inherited from: BaseRendererControl 

protected Task<object> InvokeMethod(string methodName, object[] arguments, string[] types, ElementReference[] nativeElements = null)

Parameters

  • methodName: string
  • arguments: object[]
  • types: string[]
  • nativeElements: ElementReference[]

Returns any

InvokeMethodSync(string, object[], string[], ElementReference[])

Section titled "InvokeMethodSync(string, object[], string[], ElementReference[])"

Inherited from: BaseRendererControl 

protected object InvokeMethodSync(string methodName, object[] arguments, string[] types, ElementReference[] nativeElements = null)

Parameters

  • methodName: string
  • arguments: object[]
  • types: string[]
  • nativeElements: ElementReference[]

Returns any

SuspendNotifications(object)

Section titled "SuspendNotifications(object)"

Inherited from: BaseRendererControl

Prevents data change notifications from be propagated to the component.

public void SuspendNotifications(object dataSource)

Parameters

  • dataSource: object

Returns any

ResumeNotifications(object, bool)

Section titled "ResumeNotifications(object, bool)"

Inherited from: BaseRendererControl

Resumes data change notifications.

public void ResumeNotifications(object dataSource, bool notify = true)

Parameters

  • dataSource: object
  • notify: bool

Returns any

NotifyInsertItem(object, int, object)

Section titled "NotifyInsertItem(object, int, object)"

Inherited from: BaseRendererControl 

public void NotifyInsertItem(object dataSource, int index, object refItem)

Parameters

  • dataSource: object
  • index: int
  • refItem: object

Returns any

NotifyRemoveItem(object, int, object)

Section titled "NotifyRemoveItem(object, int, object)"

Inherited from: BaseRendererControl 

public void NotifyRemoveItem(object dataSource, int index, object oldItem)

Parameters

  • dataSource: object
  • index: int
  • oldItem: object

Returns any

NotifyClearItems(object)

Section titled "NotifyClearItems(object)"

Inherited from: BaseRendererControl 

public void NotifyClearItems(object dataSource)

Parameters

  • dataSource: object

Returns any

NotifySetItem(object, int, object, object)

Section titled "NotifySetItem(object, int, object, object)"

Inherited from: BaseRendererControl 

public void NotifySetItem(object dataSource, int index, object oldItem, object newItem)

Parameters

  • dataSource: object
  • index: int
  • oldItem: object
  • newItem: object

Returns any

NotifyUpdateItem(object, int, object, bool)

Section titled "NotifyUpdateItem(object, int, object, bool)"

Inherited from: BaseRendererControl 

public void NotifyUpdateItem(object dataSource, int index, object refItem, bool syncDataOnly = false)

Parameters

  • dataSource: object
  • index: int
  • refItem: object
  • syncDataOnly: bool

Returns any

OnRefChanged(string, object)

Section titled "OnRefChanged(string, object)"

Inherited from: BaseRendererControl 

public void OnRefChanged(string refName, object refValue)

Parameters

  • refName: string
  • refValue: object

Returns any

OnInvokeReturn(long, object)

Section titled "OnInvokeReturn(long, object)"

Inherited from: BaseRendererControl 

public void OnInvokeReturn(long invokeId, object returnValue)

Parameters

  • invokeId: long
  • returnValue: object

Returns any

Camelize(string)

Section titled "Camelize(string)"

Inherited from: BaseRendererControl 

protected string Camelize(string value)

Parameters

  • value: string

Returns any

ToPascal(string)

Section titled "ToPascal(string)"

Inherited from: BaseRendererControl 

protected string ToPascal(string value)

Parameters

  • value: string

Returns any

OnElementNameChanged(BaseRendererElement, string, string)

Section titled "OnElementNameChanged(BaseRendererElement, string, string)"

Inherited from: BaseRendererControl 

protected void OnElementNameChanged(BaseRendererElement element, string oldName, string newName)

Parameters

  • element: BaseRendererElement
  • oldName: string
  • newName: string

Returns any

Dispose(bool)

Section titled "Dispose(bool)"

Inherited from: BaseRendererControl 

protected virtual void Dispose(bool disposing)

Parameters

  • disposing: bool

Returns any

SetResourceStringAsync(string, string, string)

Section titled "SetResourceStringAsync(string, string, string)"

Inherited from: BaseRendererControl 

public Task<object> SetResourceStringAsync(string grouping, string id, string value)

Parameters

  • grouping: string
  • id: string
  • value: string

Returns any

SetResourceStringAsync(string, string)

Section titled "SetResourceStringAsync(string, string)"

Inherited from: BaseRendererControl 

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

Parameters

  • grouping: string
  • json: string

Returns any

SetPropertyValue(object, PropertyInfo, JsonElement)

Section titled "SetPropertyValue(object, PropertyInfo, JsonElement)"

Inherited from: BaseRendererControl 

protected void SetPropertyValue(object item, PropertyInfo property, JsonElement jsonElement)

Parameters

  • item: object
  • property: PropertyInfo
  • jsonElement: JsonElement

Returns any

SetPropertyValue(object, PropertyInfo, object)

Section titled "SetPropertyValue(object, PropertyInfo, object)"

Inherited from: BaseRendererControl 

protected void SetPropertyValue(object item, PropertyInfo property, object value)

Parameters

  • item: object
  • property: PropertyInfo
  • value: object

Returns any

Dispose()

Section titled "Dispose()"

Inherited from: BaseRendererControl 

public void Dispose()

Returns any

AcceptCommit(int)

Section titled "AcceptCommit(int)" 
public void AcceptCommit(int commitID)

Parameters

  • commitID: int

Returns any

AcceptCommitAsync(int)

Section titled "AcceptCommitAsync(int)"

Accepts a specific commit to the datasource.

public Task AcceptCommitAsync(int commitID)

Parameters

  • commitID: int

Returns any

AcceptEdit(int)

Section titled "AcceptEdit(int)" 
public void AcceptEdit(int editID)

Parameters

  • editID: int

Returns any

AcceptEditAsync(int)

Section titled "AcceptEditAsync(int)"

Accept a pending edit turning it into a real edit.

public Task AcceptEditAsync(int editID)

Parameters

  • editID: int

Returns any

CanCommit()

Section titled "CanCommit()" 
public bool CanCommit()

Returns any

CanCommitAsync()

Section titled "CanCommitAsync()" 
public Task<bool> CanCommitAsync()

Returns any

CanMoveColumnLeft(int)

Section titled "CanMoveColumnLeft(int)" 
public bool CanMoveColumnLeft(int columnIndex)

Parameters

  • columnIndex: int

Returns any

CanMoveColumnLeftAsync(int)

Section titled "CanMoveColumnLeftAsync(int)"

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

public Task<bool> CanMoveColumnLeftAsync(int columnIndex)

Parameters

  • columnIndex: int

Returns any

CanMoveColumnRight(int)

Section titled "CanMoveColumnRight(int)" 
public bool CanMoveColumnRight(int columnIndex)

Parameters

  • columnIndex: int

Returns any

CanMoveColumnRightAsync(int)

Section titled "CanMoveColumnRightAsync(int)"

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

public Task<bool> CanMoveColumnRightAsync(int columnIndex)

Parameters

  • columnIndex: int

Returns any

CanRedo()

Section titled "CanRedo()" 
public bool CanRedo()

Returns any

CanRedoAsync()

Section titled "CanRedoAsync()" 
public Task<bool> CanRedoAsync()

Returns any

CanUndo()

Section titled "CanUndo()" 
public bool CanUndo()

Returns any

CanUndoAsync()

Section titled "CanUndoAsync()" 
public Task<bool> CanUndoAsync()

Returns any

CancelEdits()

Section titled "CancelEdits()" 
public void CancelEdits()

Returns any

CancelEditsAsync()

Section titled "CancelEditsAsync()"

Cancels any edits that may exist in the datasource.

public Task CancelEditsAsync()

Returns any

CommitEdits()

Section titled "CommitEdits()" 
public void CommitEdits()

Returns any

CommitEditsAsync()

Section titled "CommitEditsAsync()"

Commits any edits that may exist in the datasource.

public Task CommitEditsAsync()

Returns any

DataIndexOfItem(object)

Section titled "DataIndexOfItem(object)" 
public int DataIndexOfItem(object item)

Parameters

  • item: object

Returns any

DataIndexOfItemAsync(object)

Section titled "DataIndexOfItemAsync(object)"

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

public Task<int> DataIndexOfItemAsync(object item)

Parameters

  • item: object

Returns any

DeselectAllRows()

Section titled "DeselectAllRows()" 
public void DeselectAllRows()

Returns any

DeselectAllRowsAsync()

Section titled "DeselectAllRowsAsync()"

Deselects all currently selected rows.

public Task DeselectAllRowsAsync()

Returns any

EndEditMode(bool)

Section titled "EndEditMode(bool)" 
public void EndEditMode(bool commit)

Parameters

  • commit: bool

Returns any

EndEditModeAsync(bool)

Section titled "EndEditModeAsync(bool)" 
public Task EndEditModeAsync(bool commit)

Parameters

  • commit: bool

Returns any

EnsureModulesLoaded()

Section titled "EnsureModulesLoaded()" 
protected override void EnsureModulesLoaded()

Returns any

ExportSerializedVisualModel()

Section titled "ExportSerializedVisualModel()" 
public string ExportSerializedVisualModel()

Returns any

ExportSerializedVisualModelAsync()

Section titled "ExportSerializedVisualModelAsync()"

Returns a serialized copy of the exported visual model

public Task<string> ExportSerializedVisualModelAsync()

Returns any

ExportVisualModel()

Section titled "ExportVisualModel()" 
public object ExportVisualModel()

Returns any

ExportVisualModelAsync()

Section titled "ExportVisualModelAsync()"

Exports visual information about the current state of the grid.

public Task<object> ExportVisualModelAsync()

Returns any

FindByName(string)

Section titled "FindByName(string)" 
public override object FindByName(string name)

Parameters

  • name: string

Returns any

Flush()

Section titled "Flush()" 
public void Flush()

Returns any

FlushAsync()

Section titled "FlushAsync()"

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

public Task FlushAsync()

Returns any

GetColumnAtRenderedIndex(int)

Section titled "GetColumnAtRenderedIndex(int)" 
public IgbDataGridColumn GetColumnAtRenderedIndex(int index)

Parameters

  • index: int

Returns any

GetColumnAtRenderedIndexAsync(int)

Section titled "GetColumnAtRenderedIndexAsync(int)"

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.

public Task<IgbDataGridColumn> GetColumnAtRenderedIndexAsync(int index)

Parameters

  • index: int

Returns any

GetCurrentActiveCell()

Section titled "GetCurrentActiveCell()" 
public IgbGridCellPosition GetCurrentActiveCell()

Returns any

GetCurrentActiveCellAsync()

Section titled "GetCurrentActiveCellAsync()" 
public Task<IgbGridCellPosition> GetCurrentActiveCellAsync()

Returns any

GetCurrentActualColumns()

Section titled "GetCurrentActualColumns()" 
public IgbGridColumnCollection GetCurrentActualColumns()

Returns any

GetCurrentActualColumnsAsync()

Section titled "GetCurrentActualColumnsAsync()" 
public Task<IgbGridColumnCollection> GetCurrentActualColumnsAsync()

Returns any

GetCurrentActualPrimaryKey()

Section titled "GetCurrentActualPrimaryKey()" 
public string[] GetCurrentActualPrimaryKey()

Returns any

GetCurrentActualPrimaryKeyAsync()

Section titled "GetCurrentActualPrimaryKeyAsync()" 
public Task<string[]> GetCurrentActualPrimaryKeyAsync()

Returns any

GetCurrentFilterExpressions()

Section titled "GetCurrentFilterExpressions()" 
public IgbFilterExpressionCollection GetCurrentFilterExpressions()

Returns any

GetCurrentFilterExpressionsAsync()

Section titled "GetCurrentFilterExpressionsAsync()" 
public Task<IgbFilterExpressionCollection> GetCurrentFilterExpressionsAsync()

Returns any

GetCurrentGroupDescriptions()

Section titled "GetCurrentGroupDescriptions()" 
public IgbColumnGroupDescriptionCollection GetCurrentGroupDescriptions()

Returns any

GetCurrentGroupDescriptionsAsync()

Section titled "GetCurrentGroupDescriptionsAsync()" 
public Task<IgbColumnGroupDescriptionCollection> GetCurrentGroupDescriptionsAsync()

Returns any

GetCurrentSelectedCellRanges()

Section titled "GetCurrentSelectedCellRanges()" 
public IgbGridSelectedCellRangesCollection GetCurrentSelectedCellRanges()

Returns any

GetCurrentSelectedCellRangesAsync()

Section titled "GetCurrentSelectedCellRangesAsync()" 
public Task<IgbGridSelectedCellRangesCollection> GetCurrentSelectedCellRangesAsync()

Returns any

GetCurrentSelectedCells()

Section titled "GetCurrentSelectedCells()" 
public IgbGridSelectedCellsCollection GetCurrentSelectedCells()

Returns any

GetCurrentSelectedCellsAsync()

Section titled "GetCurrentSelectedCellsAsync()" 
public Task<IgbGridSelectedCellsCollection> GetCurrentSelectedCellsAsync()

Returns any

GetCurrentSelectedItems()

Section titled "GetCurrentSelectedItems()" 
public IgbGridSelectedItemsCollection GetCurrentSelectedItems()

Returns any

GetCurrentSelectedItemsAsync()

Section titled "GetCurrentSelectedItemsAsync()" 
public Task<IgbGridSelectedItemsCollection> GetCurrentSelectedItemsAsync()

Returns any

GetCurrentSelectedKeys()

Section titled "GetCurrentSelectedKeys()" 
public IgbGridSelectedKeysCollection GetCurrentSelectedKeys()

Returns any

GetCurrentSelectedKeysAsync()

Section titled "GetCurrentSelectedKeysAsync()" 
public Task<IgbGridSelectedKeysCollection> GetCurrentSelectedKeysAsync()

Returns any

GetCurrentSortDescriptions()

Section titled "GetCurrentSortDescriptions()" 
public IgbColumnSortDescriptionCollection GetCurrentSortDescriptions()

Returns any

GetCurrentSortDescriptionsAsync()

Section titled "GetCurrentSortDescriptionsAsync()" 
public Task<IgbColumnSortDescriptionCollection> GetCurrentSortDescriptionsAsync()

Returns any

GetCurrentSummaryDescriptions()

Section titled "GetCurrentSummaryDescriptions()" 
public IgbColumnSummaryDescriptionCollection GetCurrentSummaryDescriptions()

Returns any

GetCurrentSummaryDescriptionsAsync()

Section titled "GetCurrentSummaryDescriptionsAsync()" 
public Task<IgbColumnSummaryDescriptionCollection> GetCurrentSummaryDescriptionsAsync()

Returns any

GetDataURLFromCache(string, string)

Section titled "GetDataURLFromCache(string, string)" 
public string GetDataURLFromCache(string iconCollection, string iconName)

Parameters

  • iconCollection: string
  • iconName: string

Returns any

GetDataURLFromCacheAsync(string, string)

Section titled "GetDataURLFromCacheAsync(string, string)" 
public Task<string> GetDataURLFromCacheAsync(string iconCollection, string iconName)

Parameters

  • iconCollection: string
  • iconName: string

Returns any

GetFirstVisibleIndex()

Section titled "GetFirstVisibleIndex()" 
public int GetFirstVisibleIndex()

Returns any

GetFirstVisibleIndexAsync()

Section titled "GetFirstVisibleIndexAsync()"

Gets the first visible index in the grid.

public Task<int> GetFirstVisibleIndexAsync()

Returns any

GetHitCell(double, double)

Section titled "GetHitCell(double, double)" 
public IgbCellInfo GetHitCell(double x, double y)

Parameters

  • x: double
  • y: double

Returns any

GetHitCellAsync(double, double)

Section titled "GetHitCellAsync(double, double)" 
public Task<IgbCellInfo> GetHitCellAsync(double x, double y)

Parameters

  • x: double
  • y: double

Returns any

GetIconFromCache(string, string)

Section titled "GetIconFromCache(string, string)" 
public string GetIconFromCache(string iconCollection, string iconName)

Parameters

  • iconCollection: string
  • iconName: string

Returns any

GetIconFromCacheAsync(string, string)

Section titled "GetIconFromCacheAsync(string, string)" 
public Task<string> GetIconFromCacheAsync(string iconCollection, string iconName)

Parameters

  • iconCollection: string
  • iconName: string

Returns any

GetIconSource(string, string)

Section titled "GetIconSource(string, string)" 
public object GetIconSource(string iconCollection, string iconName)

Parameters

  • iconCollection: string
  • iconName: string

Returns any

GetIconSourceAsync(string, string)

Section titled "GetIconSourceAsync(string, string)" 
public Task<object> GetIconSourceAsync(string iconCollection, string iconName)

Parameters

  • iconCollection: string
  • iconName: string

Returns any

GetLastVisibleIndex()

Section titled "GetLastVisibleIndex()" 
public int GetLastVisibleIndex()

Returns any

GetLastVisibleIndexAsync()

Section titled "GetLastVisibleIndexAsync()"

Gets the last visible index in the grid.

public Task<int> GetLastVisibleIndexAsync()

Returns any

GetMultiPathSVGFromCache(string, string)

Section titled "GetMultiPathSVGFromCache(string, string)" 
public string[] GetMultiPathSVGFromCache(string iconCollection, string iconName)

Parameters

  • iconCollection: string
  • iconName: string

Returns any

GetMultiPathSVGFromCacheAsync(string, string)

Section titled "GetMultiPathSVGFromCacheAsync(string, string)" 
public Task<string[]> GetMultiPathSVGFromCacheAsync(string iconCollection, string iconName)

Parameters

  • iconCollection: string
  • iconName: string

Returns any

GetRootSummaryResults()

Section titled "GetRootSummaryResults()" 
public IgbDataGridSummaryResult[] GetRootSummaryResults()

Returns any

GetRootSummaryResultsAsync()

Section titled "GetRootSummaryResultsAsync()"

Gets the summary results for root level.

public Task<IgbDataGridSummaryResult[]> GetRootSummaryResultsAsync()

Returns any

GetSectionSummaryResults(int)

Section titled "GetSectionSummaryResults(int)" 
public IgbDataGridSummaryResult[][] GetSectionSummaryResults(int sectionIndex)

Parameters

  • sectionIndex: int

Returns any

GetSectionSummaryResultsAsync(int)

Section titled "GetSectionSummaryResultsAsync(int)"

Gets the summary results for a specific section.

public Task<IgbDataGridSummaryResult[][]> GetSectionSummaryResultsAsync(int sectionIndex)

Parameters

  • sectionIndex: int

Returns any

InvalidateVisibleRows()

Section titled "InvalidateVisibleRows()" 
public void InvalidateVisibleRows()

Returns any

InvalidateVisibleRowsAsync()

Section titled "InvalidateVisibleRowsAsync()"

Invalidates the bound data for the rows currently visible.

public Task InvalidateVisibleRowsAsync()

Returns any

LoadLayout(string)

Section titled "LoadLayout(string)" 
public void LoadLayout(string json)

Parameters

  • json: string

Returns any

LoadLayoutAsync(string)

Section titled "LoadLayoutAsync(string)"

Loads the layout chnages that have been made to the grid

public Task LoadLayoutAsync(string json)

Parameters

  • json: string

Returns any

MoveColumn(int, int)

Section titled "MoveColumn(int, int)" 
public void MoveColumn(int oldIndex, int newIndex)

Parameters

  • oldIndex: int
  • newIndex: int

Returns any

MoveColumnAsync(int, int)

Section titled "MoveColumnAsync(int, int)" 
public Task MoveColumnAsync(int oldIndex, int newIndex)

Parameters

  • oldIndex: int
  • newIndex: int

Returns any

MoveColumnLeft(int)

Section titled "MoveColumnLeft(int)" 
public void MoveColumnLeft(int columnIndex)

Parameters

  • columnIndex: int

Returns any

MoveColumnLeftAsync(int)

Section titled "MoveColumnLeftAsync(int)"

Moves a column to the left, if possible.

public Task MoveColumnLeftAsync(int columnIndex)

Parameters

  • columnIndex: int

Returns any

MoveColumnRight(int)

Section titled "MoveColumnRight(int)" 
public void MoveColumnRight(int columnIndex)

Parameters

  • columnIndex: int

Returns any

MoveColumnRightAsync(int)

Section titled "MoveColumnRightAsync(int)"

Moves a column to the right, if possible.

public Task MoveColumnRightAsync(int columnIndex)

Parameters

  • columnIndex: int

Returns any

NotifyScrollStart()

Section titled "NotifyScrollStart()" 
public void NotifyScrollStart()

Returns any

NotifyScrollStartAsync()

Section titled "NotifyScrollStartAsync()" 
public Task NotifyScrollStartAsync()

Returns any

NotifyScrollStop()

Section titled "NotifyScrollStop()" 
public void NotifyScrollStop()

Returns any

NotifyScrollStopAsync()

Section titled "NotifyScrollStopAsync()" 
public Task NotifyScrollStopAsync()

Returns any

PinColumn(IgbDataGridColumn, PinnedPositions)

Section titled "PinColumn(IgbDataGridColumn, PinnedPositions)" 
public void PinColumn(IgbDataGridColumn column, PinnedPositions position)

Parameters

  • column: IgbDataGridColumn
  • position: PinnedPositions

Returns any

PinColumnAsync(IgbDataGridColumn, PinnedPositions)

Section titled "PinColumnAsync(IgbDataGridColumn, PinnedPositions)" 
public Task PinColumnAsync(IgbDataGridColumn column, PinnedPositions position)

Parameters

  • column: IgbDataGridColumn
  • position: PinnedPositions

Returns any

Redo()

Section titled "Redo()" 
public void Redo()

Returns any

RedoAsync()

Section titled "RedoAsync()"

Redo the last edit.

public Task RedoAsync()

Returns any

Refresh()

Section titled "Refresh()" 
public void Refresh()

Returns any

RefreshAsync()

Section titled "RefreshAsync()"

Forces a refresh of the grid content.

public Task RefreshAsync()

Returns any

RegisterIconFromDataURL(string, string, string)

Section titled "RegisterIconFromDataURL(string, string, string)" 
public void RegisterIconFromDataURL(string iconCollection, string iconName, string dataURL)

Parameters

  • iconCollection: string
  • iconName: string
  • dataURL: string

Returns any

RegisterIconFromDataURLAsync(string, string, string)

Section titled "RegisterIconFromDataURLAsync(string, string, string)" 
public Task RegisterIconFromDataURLAsync(string iconCollection, string iconName, string dataURL)

Parameters

  • iconCollection: string
  • iconName: string
  • dataURL: string

Returns any

RegisterIconFromText(string, string, string)

Section titled "RegisterIconFromText(string, string, string)" 
public void RegisterIconFromText(string iconCollection, string iconName, string iconText)

Parameters

  • iconCollection: string
  • iconName: string
  • iconText: string

Returns any

RegisterIconFromTextAsync(string, string, string)

Section titled "RegisterIconFromTextAsync(string, string, string)" 
public Task RegisterIconFromTextAsync(string iconCollection, string iconName, string iconText)

Parameters

  • iconCollection: string
  • iconName: string
  • iconText: string

Returns any

RegisterIconSource(string, string, object)

Section titled "RegisterIconSource(string, string, object)" 
public void RegisterIconSource(string iconCollection, string iconName, object source)

Parameters

  • iconCollection: string
  • iconName: string
  • source: object

Returns any

RegisterIconSourceAsync(string, string, object)

Section titled "RegisterIconSourceAsync(string, string, object)" 
public Task RegisterIconSourceAsync(string iconCollection, string iconName, object source)

Parameters

  • iconCollection: string
  • iconName: string
  • source: object

Returns any

RegisterMultiPathSVG(string, string, string[])

Section titled "RegisterMultiPathSVG(string, string, string[])" 
public void RegisterMultiPathSVG(string iconCollection, string iconName, string[] multiPathSVG)

Parameters

  • iconCollection: string
  • iconName: string
  • multiPathSVG: string[]

Returns any

RegisterMultiPathSVGAsync(string, string, string[])

Section titled "RegisterMultiPathSVGAsync(string, string, string[])" 
public Task RegisterMultiPathSVGAsync(string iconCollection, string iconName, string[] multiPathSVG)

Parameters

  • iconCollection: string
  • iconName: string
  • multiPathSVG: string[]

Returns any

RejectCommit(int)

Section titled "RejectCommit(int)" 
public void RejectCommit(int commitID)

Parameters

  • commitID: int

Returns any

RejectCommitAsync(int)

Section titled "RejectCommitAsync(int)" 
public Task RejectCommitAsync(int commitID)

Parameters

  • commitID: int

Returns any

RejectEdit(int)

Section titled "RejectEdit(int)" 
public void RejectEdit(int editID)

Parameters

  • editID: int

Returns any

RejectEditAsync(int)

Section titled "RejectEditAsync(int)"

Reject a pending edit.

public Task RejectEditAsync(int editID)

Parameters

  • editID: int

Returns any

RemoveItem(object)

Section titled "RemoveItem(object)" 
public void RemoveItem(object item)

Parameters

  • item: object

Returns any

RemoveItemAsync(object)

Section titled "RemoveItemAsync(object)"

Removes an item by its instance.

public Task RemoveItemAsync(object item)

Parameters

  • item: object

Returns any

RemoveItemByKey(object[])

Section titled "RemoveItemByKey(object[])" 
public void RemoveItemByKey(object[] key)

Parameters

  • key: object[]

Returns any

RemoveItemByKeyAsync(object[])

Section titled "RemoveItemByKeyAsync(object[])" 
public Task RemoveItemByKeyAsync(object[] key)

Parameters

  • key: object[]

Returns any

ResolveCellValue(IgbCellKey)

Section titled "ResolveCellValue(IgbCellKey)" 
public object ResolveCellValue(IgbCellKey cellKey)

Parameters

  • cellKey: IgbCellKey

Returns any

ResolveCellValueAsync(IgbCellKey)

Section titled "ResolveCellValueAsync(IgbCellKey)" 
public Task<object> ResolveCellValueAsync(IgbCellKey cellKey)

Parameters

  • cellKey: IgbCellKey

Returns any

ResolveCellValueFromPosition(int, int)

Section titled "ResolveCellValueFromPosition(int, int)" 
public object ResolveCellValueFromPosition(int row, int column)

Parameters

  • row: int
  • column: int

Returns any

ResolveCellValueFromPositionAsync(int, int)

Section titled "ResolveCellValueFromPositionAsync(int, int)" 
public Task<object> ResolveCellValueFromPositionAsync(int row, int column)

Parameters

  • row: int
  • column: int

Returns any

SaveLayout()

Section titled "SaveLayout()" 
public string SaveLayout()

Returns any

SaveLayoutAsync()

Section titled "SaveLayoutAsync()"

Saves the layout chnages that have been made to the grid

public Task<string> SaveLayoutAsync()

Returns any

ScrollToColumnByIndex(double)

Section titled "ScrollToColumnByIndex(double)" 
public void ScrollToColumnByIndex(double columnNumber)

Parameters

  • columnNumber: double

Returns any

ScrollToColumnByIndexAsync(double)

Section titled "ScrollToColumnByIndexAsync(double)"

Scrolls the grid to given column, by index

public Task ScrollToColumnByIndexAsync(double columnNumber)

Parameters

  • columnNumber: double

Returns any

ScrollToItem(object)

Section titled "ScrollToItem(object)" 
public bool ScrollToItem(object item)

Parameters

  • item: object

Returns any

ScrollToItemAsync(object)

Section titled "ScrollToItemAsync(object)"

Scrolls to an item, if found.

public Task<bool> ScrollToItemAsync(object item)

Parameters

  • item: object

Returns any

ScrollToLastRowByIndex(double)

Section titled "ScrollToLastRowByIndex(double)" 
public void ScrollToLastRowByIndex(double rowNumber)

Parameters

  • rowNumber: double

Returns any

ScrollToLastRowByIndexAsync(double)

Section titled "ScrollToLastRowByIndexAsync(double)"

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

public Task ScrollToLastRowByIndexAsync(double rowNumber)

Parameters

  • rowNumber: double

Returns any

ScrollToPrimaryKey(object[])

Section titled "ScrollToPrimaryKey(object[])" 
public bool ScrollToPrimaryKey(object[] key)

Parameters

  • key: object[]

Returns any

ScrollToPrimaryKeyAsync(object[])

Section titled "ScrollToPrimaryKeyAsync(object[])" 
public Task<bool> ScrollToPrimaryKeyAsync(object[] key)

Parameters

  • key: object[]

Returns any

ScrollToRowByIndex(double)

Section titled "ScrollToRowByIndex(double)" 
public void ScrollToRowByIndex(double rowNumber)

Parameters

  • rowNumber: double

Returns any

ScrollToRowByIndexAsync(double)

Section titled "ScrollToRowByIndexAsync(double)"

Scrolls the grid to given row, by index

public Task ScrollToRowByIndexAsync(double rowNumber)

Parameters

  • rowNumber: double

Returns any

SelectAllRows()

Section titled "SelectAllRows()" 
public void SelectAllRows()

Returns any

SelectAllRowsAsync()

Section titled "SelectAllRowsAsync()"

Selects all of the rows in the grid.

public Task SelectAllRowsAsync()

Returns any

SetActiveResponsiveState(string)

Section titled "SetActiveResponsiveState(string)" 
public void SetActiveResponsiveState(string name)

Parameters

  • name: string

Returns any

SetActiveResponsiveStateAsync(string)

Section titled "SetActiveResponsiveStateAsync(string)"

Manually set the active responsive state of the grid.

public Task SetActiveResponsiveStateAsync(string name)

Parameters

  • name: string

Returns any

SetCustomizedStringAsync(string, Dictionary<string, string>)

Section titled "SetCustomizedStringAsync(string, Dictionary<string, string>)"

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

public Task<object> SetCustomizedStringAsync(string language, Dictionary<string, string> values)

Parameters

  • language: string
  • values: Dictionary

Returns any

SetCustomizedStringAsync(string, string)

Section titled "SetCustomizedStringAsync(string, string)"

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

public Task<object> SetCustomizedStringAsync(string language, string json)

Parameters

  • language: string
  • json: string

Returns any

SetCustomizedStringAsync(string, string, string)

Section titled "SetCustomizedStringAsync(string, string, string)"

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

public Task<object> SetCustomizedStringAsync(string language, string id, string value)

Parameters

  • language: string
  • id: string
  • value: string

Returns any

SetEditError(int, string)

Section titled "SetEditError(int, string)" 
public void SetEditError(int editID, string errorMessage)

Parameters

  • editID: int
  • errorMessage: string

Returns any

SetEditErrorAsync(int, string)

Section titled "SetEditErrorAsync(int, string)" 
public Task SetEditErrorAsync(int editID, string errorMessage)

Parameters

  • editID: int
  • errorMessage: string

Returns any

StartEditMode()

Section titled "StartEditMode()" 
public void StartEditMode()

Returns any

StartEditModeAsync()

Section titled "StartEditModeAsync()"

Start edit mode on the active cell.

public Task StartEditModeAsync()

Returns any

Undo()

Section titled "Undo()" 
public void Undo()

Returns any

UndoAsync()

Section titled "UndoAsync()"

Undo the last edit.

public Task UndoAsync()

Returns any

UpdatePropertyAtKey(object[], string, object)

Section titled "UpdatePropertyAtKey(object[], string, object)" 
public void UpdatePropertyAtKey(object[] key, string propertyPath, object value)

Parameters

  • key: object[]
  • propertyPath: string
  • value: object

Returns any

UpdatePropertyAtKeyAsync(object[], string, object)

Section titled "UpdatePropertyAtKeyAsync(object[], string, object)" 
public Task UpdatePropertyAtKeyAsync(object[] key, string propertyPath, object value)

Parameters

  • key: object[]
  • propertyPath: string
  • value: object

Returns any

Events

Section titled "Events"

ActualPrimaryKeyChanged

Section titled "ActualPrimaryKeyChanged" 
[Parameter]
public EventCallback<string[]> ActualPrimaryKeyChanged { get; set; }

RootSummariesChanged

Section titled "RootSummariesChanged" 
[Parameter]
public EventCallback<IgbDataSourceRootSummariesChangedEventArgs> RootSummariesChanged { get; set; }

SizeChanged

Section titled "SizeChanged" 
[Parameter]
public EventCallback<IgbGridSizeChangedEventArgs> SizeChanged { get; set; }

ActualPrimaryKeyChangedScript

Section titled "ActualPrimaryKeyChangedScript" 
[Parameter]
public string ActualPrimaryKeyChangedScript { get; set; }

RootSummariesChangedScript

Section titled "RootSummariesChangedScript" 
[Parameter]
public string RootSummariesChangedScript { get; set; }

SizeChangedScript

Section titled "SizeChangedScript" 
[Parameter]
public string SizeChangedScript { get; set; }