Class IgbGridBaseDirective

Inheritance

System.Object

BaseRendererControl

IgbDisplayDensityBase

IgbGridBaseDirective

IgbGrid

IgbPivotGrid

IgbTreeGrid

Implements

JsonSerializable

System.IDisposable

Inherited Members

IgbDisplayDensityBase.SetNativeElementAsync(Object)

IgbDisplayDensityBase.SetNativeElement(Object)

IgbDisplayDensityBase.DisplayDensity

IgbDisplayDensityBase.DensityChangedScript

IgbDisplayDensityBase.DensityChanged

BaseRendererControl._cachedSerializedContent

BaseRendererControl.EnsureModulesLoaded()

BaseRendererControl.ResolveDisplay()

BaseRendererControl.ToSpinal(String)

BaseRendererControl.TransformSimpleKey(String)

BaseRendererControl.IsTransformedEnumValue(String)

BaseRendererControl.TransformPotentialEnumValue(String, Object)

BaseRendererControl.BuildSequenceInfo(Int32)

BaseRendererControl.BuildRenderTree(RenderTreeBuilder)

BaseRendererControl.TemplateContentType(String)

BaseRendererControl.OnAfterRenderAsync(Boolean)

BaseRendererControl.EnsureReady()

BaseRendererControl.MarkPropDirty(String)

BaseRendererControl.IsPropDirty(String)

BaseRendererControl.Serialize(SerializationContext, String)

BaseRendererControl.Serialize()

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

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

BaseRendererControl.SuspendNotifications(Object)

BaseRendererControl.ResumeNotifications(Object, Boolean)

BaseRendererControl.NotifyInsertItem(Object, Int32, Object)

BaseRendererControl.NotifyRemoveItem(Object, Int32, Object)

BaseRendererControl.NotifyClearItems(Object)

BaseRendererControl.NotifySetItem(Object, Int32, Object, Object)

BaseRendererControl.NotifyUpdateItem(Object, Int32, Object, Boolean)

BaseRendererControl.OnRefChanged(String, Object)

BaseRendererControl.OnInvokeReturn(Int64, Object)

BaseRendererControl.Camelize(String)

BaseRendererControl.ToPascal(String)

BaseRendererControl.OnElementNameChanged(BaseRendererElement, String, String)

BaseRendererControl.Dispose(Boolean)

BaseRendererControl.SetResourceStringAsync(String, String, String)

BaseRendererControl.SetResourceStringAsync(String, String)

BaseRendererControl.SetPropertyValue(Object, PropertyInfo, JsonElement)

BaseRendererControl.SetPropertyValue(Object, PropertyInfo, Object)

BaseRendererControl.Finalize()

BaseRendererControl.Dispose()

BaseRendererControl.IgBlazor

BaseRendererControl.Height

BaseRendererControl.Width

BaseRendererControl.Class

BaseRendererControl.AdditionalAttributes

BaseRendererControl.ChildContent

BaseRendererControl.SupportsVisualChildren

BaseRendererControl.UseDirectRender

BaseRendererControl.DirectRenderElementName

BaseRendererControl.UseCamelEnumValues

Namespace: IgniteUI.Blazor.Controls

Assembly: IgniteUI.Blazor.dll

Syntax

public class IgbGridBaseDirective : IgbDisplayDensityBase, JsonSerializable

Constructors

IgbGridBaseDirective()

Declaration

public IgbGridBaseDirective()

Properties

ActionStrip

Declaration

public IgbActionStrip ActionStrip { get; set; }

Property Value

Type	Description
IgbActionStrip

ActiveNodeChange

Declaration

public EventCallback<IgbActiveNodeChangeEventArgs> ActiveNodeChange { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbActiveNodeChangeEventArgs>

ActiveNodeChangeScript

Declaration

public string ActiveNodeChangeScript { get; set; }

Property Value

Type	Description
System.String

ActualColumns

Declaration

public IgbColumnCollection ActualColumns { get; protected set; }

Property Value

Type	Description
IgbColumnCollection

ActualPaginationComponents

Declaration

public IgbPaginatorCollection ActualPaginationComponents { get; }

Property Value

Type	Description
IgbPaginatorCollection

ActualToolbar

Declaration

public IgbGridToolbarCollection ActualToolbar { get; }

Property Value

Type	Description
IgbGridToolbarCollection

AddRowEmptyTemplate

Declaration

public RenderFragment<object> AddRowEmptyTemplate { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment<System.Object>

AddRowEmptyTemplateScript

Provides a means of setting AddRowEmptyTemplate in the JavaScript environment.

Declaration

public string AddRowEmptyTemplateScript { get; set; }

Property Value

Type	Description
System.String

AdvancedFilteringExpressionsTree

Gets/Sets the advanced filtering state. @example

let advancedFilteringExpressionsTree = this.grid.advancedFilteringExpressionsTree;
this.grid.advancedFilteringExpressionsTree = logic;

Declaration

public IgbFilteringExpressionsTree AdvancedFilteringExpressionsTree { get; set; }

Property Value

Type	Description
IgbFilteringExpressionsTree

AdvancedFilteringExpressionsTreeChange

Declaration

public EventCallback<IgbFilteringExpressionsTreeEventArgs> AdvancedFilteringExpressionsTreeChange { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbFilteringExpressionsTreeEventArgs>

AdvancedFilteringExpressionsTreeChangeScript

Declaration

public string AdvancedFilteringExpressionsTreeChangeScript { get; set; }

Property Value

Type	Description
System.String

AllowAdvancedFiltering

Declaration

public bool AllowAdvancedFiltering { get; set; }

Property Value

Type	Description
System.Boolean

AllowFiltering

Declaration

public bool AllowFiltering { get; set; }

Property Value

Type	Description
System.Boolean

AutoGenerate

Declaration

public bool AutoGenerate { get; set; }

Property Value

Type	Description
System.Boolean

AutoGenerateExclude

Declaration

public string[] AutoGenerateExclude { get; set; }

Property Value

Type	Description
System.String[]

BatchEditing

Declaration

public bool BatchEditing { get; set; }

Property Value

Type	Description
System.Boolean

CellClick

Declaration

public EventCallback<IgbGridCellEventArgs> CellClick { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbGridCellEventArgs>

CellClickScript

Declaration

public string CellClickScript { get; set; }

Property Value

Type	Description
System.String

CellEdit

Declaration

public EventCallback<IgbGridEditEventArgs> CellEdit { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbGridEditEventArgs>

CellEditDone

Declaration

public Action<IgbGridEditDoneEventArgs> CellEditDone { get; set; }

Property Value

Type	Description
System.Action<IgbGridEditDoneEventArgs>

CellEditEnter

Declaration

public EventCallback<IgbGridEditEventArgs> CellEditEnter { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbGridEditEventArgs>

CellEditEnterScript

Declaration

public string CellEditEnterScript { get; set; }

Property Value

Type	Description
System.String

CellEditExit

Declaration

public EventCallback<IgbGridEditDoneEventArgs> CellEditExit { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbGridEditDoneEventArgs>

CellEditExitScript

Declaration

public string CellEditExitScript { get; set; }

Property Value

Type	Description
System.String

CellEditScript

Declaration

public string CellEditScript { get; set; }

Property Value

Type	Description
System.String

CellSelection

Gets/Sets cell selection mode. @remarks By default the cell selection mode is multiple selectionMode: GridSelectionMode

Declaration

public GridSelectionMode CellSelection { get; set; }

Property Value

Type	Description
GridSelectionMode

ClipboardOptions

Controls the copy behavior of the grid.

Declaration

public IgbGridClipboardOptions ClipboardOptions { get; set; }

Property Value

Type	Description
IgbGridClipboardOptions

ColumnInit

Declaration

public EventCallback<IgbColumnComponentEventArgs> ColumnInit { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbColumnComponentEventArgs>

ColumnInitScript

Declaration

public string ColumnInitScript { get; set; }

Property Value

Type	Description
System.String

ColumnMoving

Declaration

public EventCallback<IgbColumnMovingEventArgs> ColumnMoving { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbColumnMovingEventArgs>

ColumnMovingEnd

Declaration

public EventCallback<IgbColumnMovingEndEventArgs> ColumnMovingEnd { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbColumnMovingEndEventArgs>

ColumnMovingEndScript

Declaration

public string ColumnMovingEndScript { get; set; }

Property Value

Type	Description
System.String

ColumnMovingScript

Declaration

public string ColumnMovingScript { get; set; }

Property Value

Type	Description
System.String

ColumnMovingStart

Declaration

public EventCallback<IgbColumnMovingStartEventArgs> ColumnMovingStart { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbColumnMovingStartEventArgs>

ColumnMovingStartScript

Declaration

public string ColumnMovingStartScript { get; set; }

Property Value

Type	Description
System.String

ColumnPin

Declaration

public EventCallback<IgbPinColumnCancellableEventArgs> ColumnPin { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbPinColumnCancellableEventArgs>

ColumnPinned

Declaration

public EventCallback<IgbPinColumnEventArgs> ColumnPinned { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbPinColumnEventArgs>

ColumnPinnedScript

Declaration

public string ColumnPinnedScript { get; set; }

Property Value

Type	Description
System.String

ColumnPinScript

Declaration

public string ColumnPinScript { get; set; }

Property Value

Type	Description
System.String

ColumnResized

Declaration

public EventCallback<IgbColumnResizeEventArgs> ColumnResized { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbColumnResizeEventArgs>

ColumnResizedScript

Declaration

public string ColumnResizedScript { get; set; }

Property Value

Type	Description
System.String

Columns

Gets an array of IgxColumnComponents. @example

const colums = this.grid.columns.

Declaration

public IgbColumnCollection Columns { get; protected set; }

Property Value

Type	Description
IgbColumnCollection

ColumnsAutogenerated

Declaration

public EventCallback<IgbColumnsAutoGeneratedEventArgs> ColumnsAutogenerated { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbColumnsAutoGeneratedEventArgs>

ColumnsAutogeneratedScript

Declaration

public string ColumnsAutogeneratedScript { get; set; }

Property Value

Type	Description
System.String

ColumnSelection

Gets/Sets column selection mode @remarks By default the row selection mode is none selectionMode: GridSelectionMode

Declaration

public GridSelectionMode ColumnSelection { get; set; }

Property Value

Type	Description
GridSelectionMode

ColumnSelectionChanging

Declaration

public EventCallback<IgbColumnSelectionEventArgs> ColumnSelectionChanging { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbColumnSelectionEventArgs>

ColumnSelectionChangingScript

Declaration

public string ColumnSelectionChangingScript { get; set; }

Property Value

Type	Description
System.String

ColumnVisibilityChanged

Declaration

public EventCallback<IgbColumnVisibilityChangedEventArgs> ColumnVisibilityChanged { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbColumnVisibilityChangedEventArgs>

ColumnVisibilityChangedScript

Declaration

public string ColumnVisibilityChangedScript { get; set; }

Property Value

Type	Description
System.String

ColumnVisibilityChanging

Declaration

public EventCallback<IgbColumnVisibilityChangingEventArgs> ColumnVisibilityChanging { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbColumnVisibilityChangingEventArgs>

ColumnVisibilityChangingScript

Declaration

public string ColumnVisibilityChangingScript { get; set; }

Property Value

Type	Description
System.String

ColumnWidth

Declaration

public string ColumnWidth { get; set; }

Property Value

Type	Description
System.String

ContentColumns

Declaration

public IgbColumnCollection ContentColumns { get; }

Property Value

Type	Description
IgbColumnCollection

ContentPaginationComponents

Declaration

public IgbPaginatorCollection ContentPaginationComponents { get; }

Property Value

Type	Description
IgbPaginatorCollection

ContentToolbar

Declaration

public IgbGridToolbarCollection ContentToolbar { get; }

Property Value

Type	Description
IgbGridToolbarCollection

ContextMenu

Declaration

public EventCallback<IgbGridCellEventArgs> ContextMenu { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbGridCellEventArgs>

ContextMenuScript

Declaration

public string ContextMenuScript { get; set; }

Property Value

Type	Description
System.String

DataChanged

Declaration

public EventCallback<IgbVoidEventArgs> DataChanged { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbVoidEventArgs>

DataChangedScript

Declaration

public string DataChangedScript { get; set; }

Property Value

Type	Description
System.String

DataChanging

Declaration

public EventCallback<IgbForOfDataChangingEventArgs> DataChanging { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbForOfDataChangingEventArgs>

DataChangingScript

Declaration

public string DataChangingScript { get; set; }

Property Value

Type	Description
System.String

DataCloneStrategy

Declaration

public IgbDataCloneStrategy DataCloneStrategy { get; set; }

Property Value

Type	Description
IgbDataCloneStrategy

DoubleClick

Declaration

public EventCallback<IgbGridCellEventArgs> DoubleClick { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbGridCellEventArgs>

DoubleClickScript

Declaration

public string DoubleClickScript { get; set; }

Property Value

Type	Description
System.String

DragGhostCustomTemplate

Gets the custom template, if any, used for row drag ghost.

Declaration

public RenderFragment<IgbGridRowDragGhostContext> DragGhostCustomTemplate { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment<IgbGridRowDragGhostContext>

DragGhostCustomTemplateScript

Provides a means of setting DragGhostCustomTemplate in the JavaScript environment.

Declaration

public string DragGhostCustomTemplateScript { get; set; }

Property Value

Type	Description
System.String

DragIndicatorIconTemplate

The custom template, if any, that should be used when rendering the row drag indicator icon

Declaration

public RenderFragment<IgbGridEmptyTemplateContext> DragIndicatorIconTemplate { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment<IgbGridEmptyTemplateContext>

DragIndicatorIconTemplateScript

Provides a means of setting DragIndicatorIconTemplate in the JavaScript environment.

Declaration

public string DragIndicatorIconTemplateScript { get; set; }

Property Value

Type	Description
System.String

EmptyFilteredGridMessage

Declaration

public string EmptyFilteredGridMessage { get; set; }

Property Value

Type	Description
System.String

EmptyGridMessage

Declaration

public string EmptyGridMessage { get; set; }

Property Value

Type	Description
System.String

EmptyGridTemplate

Declaration

public RenderFragment<object> EmptyGridTemplate { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment<System.Object>

EmptyGridTemplateScript

Provides a means of setting EmptyGridTemplate in the JavaScript environment.

Declaration

public string EmptyGridTemplateScript { get; set; }

Property Value

Type	Description
System.String

ExcelStyleHeaderIconTemplate

Gets the excel style header icon.

Declaration

public RenderFragment<IgbGridHeaderTemplateContext> ExcelStyleHeaderIconTemplate { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment<IgbGridHeaderTemplateContext>

ExcelStyleHeaderIconTemplateScript

Provides a means of setting ExcelStyleHeaderIconTemplate in the JavaScript environment.

Declaration

public string ExcelStyleHeaderIconTemplateScript { get; set; }

Property Value

Type	Description
System.String

Filtering

Declaration

public EventCallback<IgbFilteringEventArgs> Filtering { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbFilteringEventArgs>

FilteringDone

Declaration

public EventCallback<IgbFilteringExpressionsTreeEventArgs> FilteringDone { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbFilteringExpressionsTreeEventArgs>

FilteringDoneScript

Declaration

public string FilteringDoneScript { get; set; }

Property Value

Type	Description
System.String

FilteringExpressionsTree

Declaration

public IgbFilteringExpressionsTree FilteringExpressionsTree { get; set; }

Property Value

Type	Description
IgbFilteringExpressionsTree

FilteringExpressionsTreeChange

Declaration

public EventCallback<IgbFilteringExpressionsTreeEventArgs> FilteringExpressionsTreeChange { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbFilteringExpressionsTreeEventArgs>

FilteringExpressionsTreeChangeScript

Declaration

public string FilteringExpressionsTreeChangeScript { get; set; }

Property Value

Type	Description
System.String

FilteringLogic

Declaration

public FilteringLogic FilteringLogic { get; set; }

Property Value

Type	Description
FilteringLogic

FilteringScript

Declaration

public string FilteringScript { get; set; }

Property Value

Type	Description
System.String

FilterMode

Declaration

public FilterMode FilterMode { get; set; }

Property Value

Type	Description
FilterMode

FilterStrategy

Declaration

public IgbFilteringStrategy FilterStrategy { get; set; }

Property Value

Type	Description
IgbFilteringStrategy

FormGroupCreated

Declaration

public EventCallback<IgbGridFormGroupCreatedEventArgs> FormGroupCreated { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbGridFormGroupCreatedEventArgs>

FormGroupCreatedScript

Declaration

public string FormGroupCreatedScript { get; set; }

Property Value

Type	Description
System.String

GridCopy

Declaration

public EventCallback<IgbGridClipboardEventEventArgs> GridCopy { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbGridClipboardEventEventArgs>

GridCopyScript

Declaration

public string GridCopyScript { get; set; }

Property Value

Type	Description
System.String

GridKeydown

Declaration

public EventCallback<IgbGridKeydownEventArgs> GridKeydown { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbGridKeydownEventArgs>

GridKeydownScript

Declaration

public string GridKeydownScript { get; set; }

Property Value

Type	Description
System.String

GridScroll

Declaration

public EventCallback<IgbGridScrollEventArgs> GridScroll { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbGridScrollEventArgs>

GridScrollScript

Declaration

public string GridScrollScript { get; set; }

Property Value

Type	Description
System.String

HeaderCollapsedIndicatorTemplate

Declaration

public RenderFragment<IgbGridTemplateContext> HeaderCollapsedIndicatorTemplate { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment<IgbGridTemplateContext>

HeaderCollapsedIndicatorTemplateScript

Declaration

public string HeaderCollapsedIndicatorTemplateScript { get; set; }

Property Value

Type	Description
System.String

HeaderExpandedIndicatorTemplate

Declaration

public RenderFragment<IgbGridTemplateContext> HeaderExpandedIndicatorTemplate { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment<IgbGridTemplateContext>

HeaderExpandedIndicatorTemplateScript

Declaration

public string HeaderExpandedIndicatorTemplateScript { get; set; }

Property Value

Type	Description
System.String

HeadSelectorTemplate

Gets the header row selector template.

Declaration

public RenderFragment<IgbHeadSelectorTemplateContext> HeadSelectorTemplate { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment<IgbHeadSelectorTemplateContext>

HeadSelectorTemplateScript

Provides a means of setting HeadSelectorTemplate in the JavaScript environment.

Declaration

public string HeadSelectorTemplateScript { get; set; }

Property Value

Type	Description
System.String

HideRowSelectors

Gets/Sets if the row selectors are hidden. @remarks By default row selectors are shown

Declaration

public bool HideRowSelectors { get; set; }

Property Value

Type	Description
System.Boolean

IsLoading

Declaration

public bool IsLoading { get; set; }

Property Value

Type	Description
System.Boolean

ItemRequested

Declaration

public Action<IgbItemRequestedEventArgs> ItemRequested { get; set; }

Property Value

Type	Description
System.Action<IgbItemRequestedEventArgs>

LoadingGridTemplate

Declaration

public RenderFragment<object> LoadingGridTemplate { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment<System.Object>

LoadingGridTemplateScript

Provides a means of setting LoadingGridTemplate in the JavaScript environment.

Declaration

public string LoadingGridTemplateScript { get; set; }

Property Value

Type	Description
System.String

Locale

Gets/Sets the locale. @remarks If not set, returns browser's language.

Declaration

public string Locale { get; set; }

Property Value

Type	Description
System.String

Moving

Controls whether columns moving is enabled in the grid.

Declaration

public bool Moving { get; set; }

Property Value

Type	Description
System.Boolean

NeedsDynamicContent

Declaration

protected override bool NeedsDynamicContent { get; }

Property Value

Type	Description
System.Boolean

Overrides

BaseRendererControl.NeedsDynamicContent

Outlet

Gets/Sets the outlet used to attach the grid's overlays to. @remark If set, returns the outlet defined outside the grid. Otherwise returns the grid's internal outlet directive.

Declaration

public IgbOverlayOutletDirective Outlet { get; set; }

Property Value

Type	Description
IgbOverlayOutletDirective

PaginationComponents

@hidden @internal

Declaration

public IgbPaginatorCollection PaginationComponents { get; protected set; }

Property Value

Type	Description
IgbPaginatorCollection

PagingMode

Declaration

public GridPagingMode PagingMode { get; set; }

Property Value

Type	Description
GridPagingMode

ParentTypeName

Declaration

protected override string ParentTypeName { get; }

Property Value

Type	Description
System.String

Overrides

BaseRendererControl.ParentTypeName

Pinning

Declaration

public IgbPinningConfig Pinning { get; set; }

Property Value

Type	Description
IgbPinningConfig

PrimaryKey

Declaration

public string PrimaryKey { get; set; }

Property Value

Type	Description
System.String

RangeSelected

Declaration

public EventCallback<IgbGridSelectionRangeEventArgs> RangeSelected { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbGridSelectionRangeEventArgs>

RangeSelectedScript

Declaration

public string RangeSelectedScript { get; set; }

Property Value

Type	Description
System.String

Rendered

Declaration

public EventCallback<IgbVoidEventArgs> Rendered { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbVoidEventArgs>

RenderedScript

Declaration

public string RenderedScript { get; set; }

Property Value

Type	Description
System.String

ResourceStrings

Gets/Sets the resource strings. @remarks By default it uses EN resources.

Declaration

public IgbGridResourceStrings ResourceStrings { get; set; }

Property Value

Type	Description
IgbGridResourceStrings

RowAdd

Declaration

public EventCallback<IgbGridEditEventArgs> RowAdd { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbGridEditEventArgs>

RowAdded

Declaration

public Action<IgbRowDataEventArgs> RowAdded { get; set; }

Property Value

Type	Description
System.Action<IgbRowDataEventArgs>

RowAddScript

Declaration

public string RowAddScript { get; set; }

Property Value

Type	Description
System.String

RowAddTextTemplate

Gets the row add text template.

Declaration

public RenderFragment<IgbGridEmptyTemplateContext> RowAddTextTemplate { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment<IgbGridEmptyTemplateContext>

RowAddTextTemplateScript

Provides a means of setting RowAddTextTemplate in the JavaScript environment.

Declaration

public string RowAddTextTemplateScript { get; set; }

Property Value

Type	Description
System.String

RowClasses

Declaration

public object RowClasses { get; set; }

Property Value

Type	Description
System.Object

RowClassesScript

Provides a means of setting RowClasses in the JavaScript environment.

Declaration

public string RowClassesScript { get; set; }

Property Value

Type	Description
System.String

RowCollapsedIndicatorTemplate

The custom template, if any, that should be used when rendering a row collapse indicator.

Declaration

public RenderFragment<IgbGridRowTemplateContext> RowCollapsedIndicatorTemplate { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment<IgbGridRowTemplateContext>

RowCollapsedIndicatorTemplateScript

Provides a means of setting RowCollapsedIndicatorTemplate in the JavaScript environment.

Declaration

public string RowCollapsedIndicatorTemplateScript { get; set; }

Property Value

Type	Description
System.String

RowDelete

Declaration

public EventCallback<IgbGridEditEventArgs> RowDelete { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbGridEditEventArgs>

RowDeleted

Declaration

public Action<IgbRowDataEventArgs> RowDeleted { get; set; }

Property Value

Type	Description
System.Action<IgbRowDataEventArgs>

RowDeleteScript

Declaration

public string RowDeleteScript { get; set; }

Property Value

Type	Description
System.String

RowDragEnd

Declaration

public EventCallback<IgbRowDragEndEventArgs> RowDragEnd { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbRowDragEndEventArgs>

RowDragEndScript

Declaration

public string RowDragEndScript { get; set; }

Property Value

Type	Description
System.String

RowDraggable

Declaration

public bool RowDraggable { get; set; }

Property Value

Type	Description
System.Boolean

RowDragStart

Declaration

public EventCallback<IgbRowDragStartEventArgs> RowDragStart { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbRowDragStartEventArgs>

RowDragStartScript

Declaration

public string RowDragStartScript { get; set; }

Property Value

Type	Description
System.String

RowEdit

Declaration

public EventCallback<IgbGridEditEventArgs> RowEdit { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbGridEditEventArgs>

RowEditable

Declaration

public bool RowEditable { get; set; }

Property Value

Type	Description
System.Boolean

RowEditActionsTemplate

Gets the row edit actions template.

Declaration

public RenderFragment<IgbGridRowEditActionsTemplateContext> RowEditActionsTemplate { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment<IgbGridRowEditActionsTemplateContext>

RowEditActionsTemplateScript

Provides a means of setting RowEditActionsTemplate in the JavaScript environment.

Declaration

public string RowEditActionsTemplateScript { get; set; }

Property Value

Type	Description
System.String

RowEditDone

Declaration

public EventCallback<IgbGridEditDoneEventArgs> RowEditDone { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbGridEditDoneEventArgs>

RowEditDoneScript

Declaration

public string RowEditDoneScript { get; set; }

Property Value

Type	Description
System.String

RowEditEnter

Declaration

public EventCallback<IgbGridEditEventArgs> RowEditEnter { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbGridEditEventArgs>

RowEditEnterScript

Declaration

public string RowEditEnterScript { get; set; }

Property Value

Type	Description
System.String

RowEditExit

Declaration

public EventCallback<IgbGridEditDoneEventArgs> RowEditExit { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbGridEditDoneEventArgs>

RowEditExitScript

Declaration

public string RowEditExitScript { get; set; }

Property Value

Type	Description
System.String

RowEditScript

Declaration

public string RowEditScript { get; set; }

Property Value

Type	Description
System.String

RowEditTextTemplate

Gets the row edit text template.

Declaration

public RenderFragment<IgbGridRowEditTextTemplateContext> RowEditTextTemplate { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment<IgbGridRowEditTextTemplateContext>

RowEditTextTemplateScript

Provides a means of setting RowEditTextTemplate in the JavaScript environment.

Declaration

public string RowEditTextTemplateScript { get; set; }

Property Value

Type	Description
System.String

RowExpandedIndicatorTemplate

The custom template, if any, that should be used when rendering a row expand indicator.

Declaration

public RenderFragment<IgbGridRowTemplateContext> RowExpandedIndicatorTemplate { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment<IgbGridRowTemplateContext>

RowExpandedIndicatorTemplateScript

Provides a means of setting RowExpandedIndicatorTemplate in the JavaScript environment.

Declaration

public string RowExpandedIndicatorTemplateScript { get; set; }

Property Value

Type	Description
System.String

RowHeight

Declaration

public double RowHeight { get; set; }

Property Value

Type	Description
System.Double

RowPinned

Declaration

public EventCallback<IgbPinRowEventArgs> RowPinned { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbPinRowEventArgs>

RowPinnedScript

Declaration

public string RowPinnedScript { get; set; }

Property Value

Type	Description
System.String

RowPinning

Declaration

public EventCallback<IgbPinRowEventArgs> RowPinning { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbPinRowEventArgs>

RowPinningScript

Declaration

public string RowPinningScript { get; set; }

Property Value

Type	Description
System.String

RowSelection

Gets/Sets row selection mode @remarks By default the row selection mode is 'none' Note that in IgxGrid and IgxHierarchicalGrid 'multipleCascade' behaves like 'multiple'

Declaration

public GridSelectionMode RowSelection { get; set; }

Property Value

Type	Description
GridSelectionMode

RowSelectionChanging

Declaration

public EventCallback<IgbRowSelectionEventArgs> RowSelectionChanging { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbRowSelectionEventArgs>

RowSelectionChangingScript

Declaration

public string RowSelectionChangingScript { get; set; }

Property Value

Type	Description
System.String

RowSelectorTemplate

Gets the row selector template.

Declaration

public RenderFragment<IgbRowSelectorTemplateContext> RowSelectorTemplate { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment<IgbRowSelectorTemplateContext>

RowSelectorTemplateScript

Provides a means of setting RowSelectorTemplate in the JavaScript environment.

Declaration

public string RowSelectorTemplateScript { get; set; }

Property Value

Type	Description
System.String

RowStyles

Declaration

public object RowStyles { get; set; }

Property Value

Type	Description
System.Object

RowStylesScript

Provides a means of setting RowStyles in the JavaScript environment.

Declaration

public string RowStylesScript { get; set; }

Property Value

Type	Description
System.String

RowToggle

Declaration

public EventCallback<IgbRowToggleEventArgs> RowToggle { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbRowToggleEventArgs>

RowToggleScript

Declaration

public string RowToggleScript { get; set; }

Property Value

Type	Description
System.String

Selected

Declaration

public EventCallback<IgbGridCellEventArgs> Selected { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbGridCellEventArgs>

SelectedRows

Declaration

public object[] SelectedRows { get; set; }

Property Value

Type	Description
System.Object[]

SelectedRowsChanged

Declaration

public EventCallback<object[]> SelectedRowsChanged { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<System.Object[]>

SelectedScript

Declaration

public string SelectedScript { get; set; }

Property Value

Type	Description
System.String

SelectRowOnClick

Gets/Sets whether clicking over a row should select/deselect it @remarks By default it is set to true enabled: boolean

Declaration

public bool SelectRowOnClick { get; set; }

Property Value

Type	Description
System.Boolean

ShouldGenerate

Gets/Sets whether the columns should be auto-generated once again after the initialization of the grid @remarks This will allow to bind the grid to remote data and having auto-generated columns at the same time. Note that after generating the columns, this property would be disabled to avoid re-creating columns each time a new data is assigned. @example

this.grid.shouldGenerate = true;

Declaration

public bool ShouldGenerate { get; set; }

Property Value

Type	Description
System.Boolean

ShowSummaryOnCollapse

Declaration

public bool ShowSummaryOnCollapse { get; set; }

Property Value

Type	Description
System.Boolean

SnackbarDisplayTime

Gets/Sets the display time for the row adding snackbar notification. @remarks By default it is 6000ms.

Declaration

public double SnackbarDisplayTime { get; set; }

Property Value

Type	Description
System.Double

SortAscendingHeaderIconTemplate

The custom template, if any, that should be used when rendering a header sorting indicator when columns are sorted in asc order.

Declaration

public RenderFragment<IgbGridHeaderTemplateContext> SortAscendingHeaderIconTemplate { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment<IgbGridHeaderTemplateContext>

SortAscendingHeaderIconTemplateScript

Provides a means of setting SortAscendingHeaderIconTemplate in the JavaScript environment.

Declaration

public string SortAscendingHeaderIconTemplateScript { get; set; }

Property Value

Type	Description
System.String

SortDescendingHeaderIconTemplate

The custom template, if any, that should be used when rendering a header sorting indicator when columns are sorted in desc order.

Declaration

public RenderFragment<IgbGridHeaderTemplateContext> SortDescendingHeaderIconTemplate { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment<IgbGridHeaderTemplateContext>

SortDescendingHeaderIconTemplateScript

Provides a means of setting SortDescendingHeaderIconTemplate in the JavaScript environment.

Declaration

public string SortDescendingHeaderIconTemplateScript { get; set; }

Property Value

Type	Description
System.String

SortHeaderIconTemplate

Gets custom template, if any, that should be used when rendering a header sorting indicator when columns are not sorted.

Declaration

public RenderFragment<IgbGridHeaderTemplateContext> SortHeaderIconTemplate { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment<IgbGridHeaderTemplateContext>

SortHeaderIconTemplateScript

Provides a means of setting SortHeaderIconTemplate in the JavaScript environment.

Declaration

public string SortHeaderIconTemplateScript { get; set; }

Property Value

Type	Description
System.String

Sorting

Declaration

public EventCallback<IgbSortingEventArgs> Sorting { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbSortingEventArgs>

SortingDone

Declaration

public EventCallback<IgbSortingExpressionEventArgs> SortingDone { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbSortingExpressionEventArgs>

SortingDoneScript

Declaration

public string SortingDoneScript { get; set; }

Property Value

Type	Description
System.String

SortingExpressions

Declaration

public IgbSortingExpression[] SortingExpressions { get; set; }

Property Value

Type	Description
IgbSortingExpression[]

SortingExpressionsChange

Declaration

public EventCallback<IgbSortingExpressionEventArgs> SortingExpressionsChange { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbSortingExpressionEventArgs>

SortingExpressionsChangeScript

Declaration

public string SortingExpressionsChangeScript { get; set; }

Property Value

Type	Description
System.String

SortingOptions

Declaration

public IgbSortingOptions SortingOptions { get; set; }

Property Value

Type	Description
IgbSortingOptions

SortingScript

Declaration

public string SortingScript { get; set; }

Property Value

Type	Description
System.String

SortStrategy

Declaration

public IgbGridSortingStrategy SortStrategy { get; set; }

Property Value

Type	Description
IgbGridSortingStrategy

SummaryCalculationMode

Declaration

public GridSummaryCalculationMode SummaryCalculationMode { get; set; }

Property Value

Type	Description
GridSummaryCalculationMode

SummaryPosition

Declaration

public GridSummaryPosition SummaryPosition { get; set; }

Property Value

Type	Description
GridSummaryPosition

SummaryRowHeight

Get/Set IgxSummaryRow height

Declaration

public double SummaryRowHeight { get; set; }

Property Value

Type	Description
System.Double

Toolbar

@hidden @internal

Declaration

public IgbGridToolbarCollection Toolbar { get; protected set; }

Property Value

Type	Description
IgbGridToolbarCollection

ToolbarExporting

Declaration

public EventCallback<IgbGridToolbarExportEventArgs> ToolbarExporting { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbGridToolbarExportEventArgs>

ToolbarExportingScript

Declaration

public string ToolbarExportingScript { get; set; }

Property Value

Type	Description
System.String

TotalRecords

Returns the total number of records. @remarks Only functions when paging is enabled. @example

const totalRecords = this.grid.totalRecords;

Declaration

public double TotalRecords { get; set; }

Property Value

Type	Description
System.Double

Type

Declaration

public override string Type { get; }

Property Value

Type	Description
System.String

Overrides

IgbDisplayDensityBase.Type

ValidationStatusChange

Declaration

public EventCallback<IgbGridValidationStatusEventArgs> ValidationStatusChange { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbGridValidationStatusEventArgs>

ValidationStatusChangeScript

Declaration

public string ValidationStatusChangeScript { get; set; }

Property Value

Type	Description
System.String

ValidationTrigger

Declaration

public GridValidationTrigger ValidationTrigger { get; set; }

Property Value

Type	Description
GridValidationTrigger

Methods

AddRow(Object)

Declaration

public void AddRow(object item)

Parameters

Type	Name	Description
System.Object	item

AddRowAsync(Object)

Declaration

public Task AddRowAsync(object item)

Parameters

Type	Name	Description
System.Object	item

Returns

Type	Description
System.Threading.Tasks.Task

BeginAddRowById(Object, Boolean)

Declaration

public void BeginAddRowById(object rowID, bool asChild)

Parameters

Type	Name	Description
System.Object	rowID
System.Boolean	asChild

BeginAddRowByIdAsync(Object, Boolean)

Declaration

public Task BeginAddRowByIdAsync(object rowID, bool asChild)

Parameters

Type	Name	Description
System.Object	rowID
System.Boolean	asChild

Returns

Type	Description
System.Threading.Tasks.Task

ClearCellSelection()

Declaration

public void ClearCellSelection()

ClearCellSelectionAsync()

Declaration

public Task ClearCellSelectionAsync()

Returns

Type	Description
System.Threading.Tasks.Task

ClearFilter(String)

Declaration

public void ClearFilter(string name)

Parameters

Type	Name	Description
System.String	name

ClearFilterAsync(String)

If name is provided, clears the filtering state of the corresponding IgxColumnComponent. @remarks Otherwise clears the filtering state of all IgxColumnComponents. @example

this.grid.clearFilter();

name

Declaration

public Task ClearFilterAsync(string name)

Parameters

Type	Name	Description
System.String	name

Returns

Type	Description
System.Threading.Tasks.Task

ClearSearch()

Declaration

public void ClearSearch()

ClearSearchAsync()

Removes all the highlights in the cell. @example

this.grid.clearSearch();

Declaration

public Task ClearSearchAsync()

Returns

Type	Description
System.Threading.Tasks.Task

ClearSort(String)

Declaration

public void ClearSort(string name)

Parameters

Type	Name	Description
System.String	name

ClearSortAsync(String)

If name is provided, clears the sorting state of the corresponding IgxColumnComponent. @remarks otherwise clears the sorting state of all IgxColumnComponent. @example

this.grid.clearSort();

name

Declaration

public Task ClearSortAsync(string name)

Parameters

Type	Name	Description
System.String	name

Returns

Type	Description
System.Threading.Tasks.Task

CloseAdvancedFilteringDialog(Boolean)

Declaration

public void CloseAdvancedFilteringDialog(bool applyChanges)

Parameters

Type	Name	Description
System.Boolean	applyChanges

CloseAdvancedFilteringDialogAsync(Boolean)

Closes the advanced filtering dialog. applyChanges indicates whether the changes should be applied

Declaration

public Task CloseAdvancedFilteringDialogAsync(bool applyChanges)

Parameters

Type	Name	Description
System.Boolean	applyChanges	indicates whether the changes should be applied

Returns

Type	Description
System.Threading.Tasks.Task

CollapseAll()

Declaration

public void CollapseAll()

CollapseAllAsync()

Collapses all rows. @example

this.grid.collapseAll();

Declaration

public Task CollapseAllAsync()

Returns

Type	Description
System.Threading.Tasks.Task

CollapseRow(Object)

Declaration

public void CollapseRow(object rowID)

Parameters

Type	Name	Description
System.Object	rowID

CollapseRowAsync(Object)

Collapses the row by its id. @remarks ID is either the primaryKey value or the data record instance. @example

this.grid.collapseRow(rowID);

rowID The row id - primaryKey value or the data record instance.

Declaration

public Task CollapseRowAsync(object rowID)

Parameters

Type	Name	Description
System.Object	rowID	The row id - primaryKey value or the data record instance.

Returns

Type	Description
System.Threading.Tasks.Task

DeleteRow(Object)

Declaration

public object DeleteRow(object rowSelector)

Parameters

Type	Name	Description
System.Object	rowSelector

Returns

Type	Description
System.Object

DeleteRowAsync(Object)

Removes the IgxGridRowComponent and the corresponding data record by primary key. @remarks Requires that the primaryKey property is set. The method accept rowSelector as a parameter, which is the rowID. @example

this.grid1.deleteRow(0);

rowSelector

Declaration

public Task<object> DeleteRowAsync(object rowSelector)

Parameters

Type	Name	Description
System.Object	rowSelector

Returns

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

DeselectAllColumns()

Declaration

public void DeselectAllColumns()

DeselectAllColumnsAsync()

Deselects all columns @example

this.grid.deselectAllColumns();

Declaration

public Task DeselectAllColumnsAsync()

Returns

Type	Description
System.Threading.Tasks.Task

DeselectAllRows(Boolean)

Declaration

public void DeselectAllRows(bool onlyFilterData)

Parameters

Type	Name	Description
System.Boolean	onlyFilterData

DeselectAllRowsAsync(Boolean)

Deselects all rows @remarks By default if filtering is in place, selectAllRows() and deselectAllRows() select/deselect all filtered rows. If you set the parameter onlyFilterData to false that will deselect all rows in the grid exept deleted rows. @example

this.grid.deselectAllRows();

onlyFilterData

Declaration

public Task DeselectAllRowsAsync(bool onlyFilterData)

Parameters

Type	Name	Description
System.Boolean	onlyFilterData

Returns

Type	Description
System.Threading.Tasks.Task

DeselectColumns(String[])

Declaration

public void DeselectColumns(string[] columns)

Parameters

Type	Name	Description
System.String[]	columns

DeselectColumnsAsync(String[])

Declaration

public Task DeselectColumnsAsync(string[] columns)

Parameters

Type	Name	Description
System.String[]	columns

Returns

Type	Description
System.Threading.Tasks.Task

DeselectRows(Object[])

Declaration

public void DeselectRows(object[] rowIDs)

Parameters

Type	Name	Description
System.Object[]	rowIDs

DeselectRowsAsync(Object[])

Declaration

public Task DeselectRowsAsync(object[] rowIDs)

Parameters

Type	Name	Description
System.Object[]	rowIDs

Returns

Type	Description
System.Threading.Tasks.Task

DisableSummaries(Object[])

Declaration

public void DisableSummaries(object[] rest)

Parameters

Type	Name	Description
System.Object[]	rest

DisableSummariesAsync(Object[])

Declaration

public Task DisableSummariesAsync(object[] rest)

Parameters

Type	Name	Description
System.Object[]	rest

Returns

Type	Description
System.Threading.Tasks.Task

EnableSummaries(Object[])

Declaration

public void EnableSummaries(object[] rest)

Parameters

Type	Name	Description
System.Object[]	rest

EnableSummariesAsync(Object[])

Declaration

public Task EnableSummariesAsync(object[] rest)

Parameters

Type	Name	Description
System.Object[]	rest

Returns

Type	Description
System.Threading.Tasks.Task

ExpandAll()

Declaration

public void ExpandAll()

ExpandAllAsync()

Expands all rows. @example

this.grid.expandAll();

Declaration

public Task ExpandAllAsync()

Returns

Type	Description
System.Threading.Tasks.Task

ExpandRow(Object)

Declaration

public void ExpandRow(object rowID)

Parameters

Type	Name	Description
System.Object	rowID

ExpandRowAsync(Object)

Expands the row by its id. @remarks ID is either the primaryKey value or the data record instance. @example

this.grid.expandRow(rowID);

rowID The row id - primaryKey value or the data record instance.

Declaration

public Task ExpandRowAsync(object rowID)

Parameters

Type	Name	Description
System.Object	rowID	The row id - primaryKey value or the data record instance.

Returns

Type	Description
System.Threading.Tasks.Task

Filter(String, Object, IgbFilteringExpressionsTreeOrFilteringOperation, Boolean)

Declaration

public void Filter(string name, object value, IgbFilteringExpressionsTreeOrFilteringOperation conditionOrExpressionTree, bool ignoreCase)

Parameters

Type	Name	Description
System.String	name
System.Object	value
IgbFilteringExpressionsTreeOrFilteringOperation	conditionOrExpressionTree
System.Boolean	ignoreCase

FilterAsync(String, Object, IgbFilteringExpressionsTreeOrFilteringOperation, Boolean)

Declaration

public Task FilterAsync(string name, object value, IgbFilteringExpressionsTreeOrFilteringOperation conditionOrExpressionTree, bool ignoreCase)

Parameters

Type	Name	Description
System.String	name
System.Object	value
IgbFilteringExpressionsTreeOrFilteringOperation	conditionOrExpressionTree
System.Boolean	ignoreCase

Returns

Type	Description
System.Threading.Tasks.Task

FilterGlobal(Object, Object, Object)

Declaration

public void FilterGlobal(object value, object condition, object ignoreCase)

Parameters

Type	Name	Description
System.Object	value
System.Object	condition
System.Object	ignoreCase

FilterGlobalAsync(Object, Object, Object)

Declaration

public Task FilterGlobalAsync(object value, object condition, object ignoreCase)

Parameters

Type	Name	Description
System.Object	value
System.Object	condition
System.Object	ignoreCase

Returns

Type	Description
System.Threading.Tasks.Task

FindByName(String)

Declaration

public override object FindByName(string name)

Parameters

Type	Name	Description
System.String	name

Returns

Type	Description
System.Object

Overrides

IgbDisplayDensityBase.FindByName(String)

FindNext(String, Boolean, Boolean)

Declaration

public double FindNext(string text, bool caseSensitive, bool exactMatch)

Parameters

Type	Name	Description
System.String	text
System.Boolean	caseSensitive
System.Boolean	exactMatch

Returns

Type	Description
System.Double

FindNextAsync(String, Boolean, Boolean)

Declaration

public Task<double> FindNextAsync(string text, bool caseSensitive, bool exactMatch)

Parameters

Type	Name	Description
System.String	text
System.Boolean	caseSensitive
System.Boolean	exactMatch

Returns

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

FindPrev(String, Boolean, Boolean)

Declaration

public double FindPrev(string text, bool caseSensitive, bool exactMatch)

Parameters

Type	Name	Description
System.String	text
System.Boolean	caseSensitive
System.Boolean	exactMatch

Returns

Type	Description
System.Double

FindPrevAsync(String, Boolean, Boolean)

Declaration

public Task<double> FindPrevAsync(string text, bool caseSensitive, bool exactMatch)

Parameters

Type	Name	Description
System.String	text
System.Boolean	caseSensitive
System.Boolean	exactMatch

Returns

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

GetColumnByName(String)

Declaration

public IgbColumn GetColumnByName(string name)

Parameters

Type	Name	Description
System.String	name

Returns

Type	Description
IgbColumn

GetColumnByNameAsync(String)

Returns the IgxColumnComponent by field name. @example

const myCol = this.grid1.getColumnByName(&quot;ID&quot;);

name

Declaration

public Task<IgbColumn> GetColumnByNameAsync(string name)

Parameters

Type	Name	Description
System.String	name

Returns

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

GetColumnByVisibleIndex(Double)

Declaration

public IgbColumn GetColumnByVisibleIndex(double index)

Parameters

Type	Name	Description
System.Double	index

Returns

Type	Description
IgbColumn

GetColumnByVisibleIndexAsync(Double)

Declaration

public Task<IgbColumn> GetColumnByVisibleIndexAsync(double index)

Parameters

Type	Name	Description
System.Double	index

Returns

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

GetCurrentActualColumns()

Declaration

public IgbColumnCollection GetCurrentActualColumns()

Returns

Type	Description
IgbColumnCollection

GetCurrentActualColumnsAsync()

Declaration

public Task<IgbColumnCollection> GetCurrentActualColumnsAsync()

Returns

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

GetCurrentSelectedRows()

Declaration

public object[] GetCurrentSelectedRows()

Returns

Type	Description
System.Object[]

GetCurrentSelectedRowsAsync()

Declaration

public Task<object[]> GetCurrentSelectedRowsAsync()

Returns

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

GetData()

Declaration

protected virtual object GetData()

Returns

Type	Description
System.Object

GetHeaderGroupWidth(IgbColumn)

Declaration

public string GetHeaderGroupWidth(IgbColumn column)

Parameters

Type	Name	Description
IgbColumn	column

Returns

Type	Description
System.String

GetHeaderGroupWidthAsync(IgbColumn)

Gets the width to be set on IgxGridHeaderGroupComponent.

Declaration

public Task<string> GetHeaderGroupWidthAsync(IgbColumn column)

Parameters

Type	Name	Description
IgbColumn	column

Returns

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

GetPinnedWidth(Boolean)

Declaration

public void GetPinnedWidth(bool takeHidden)

Parameters

Type	Name	Description
System.Boolean	takeHidden

GetPinnedWidthAsync(Boolean)

Gets calculated width of the pinned area. @example

const pinnedWidth = this.grid.getPinnedWidth();

takeHidden If we should take into account the hidden columns in the pinned area.

Declaration

public Task GetPinnedWidthAsync(bool takeHidden)

Parameters

Type	Name	Description
System.Boolean	takeHidden	If we should take into account the hidden columns in the pinned area.

Returns

Type	Description
System.Threading.Tasks.Task

GetRowData(Object)

Declaration

public object GetRowData(object rowSelector)

Parameters

Type	Name	Description
System.Object	rowSelector

Returns

Type	Description
System.Object

GetRowDataAsync(Object)

Returns the data that is contained in the row component. @remarks If the primary key is not specified the row selector match the row data. @example

const data = grid.getRowData(94741);

rowSelector correspond to rowID

Declaration

public Task<object> GetRowDataAsync(object rowSelector)

Parameters

Type	Name	Description
System.Object	rowSelector	correspond to rowID

Returns

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

GetSelectedColumnsData(Boolean, Boolean)

Declaration

public void GetSelectedColumnsData(bool formatters, bool headers)

Parameters

Type	Name	Description
System.Boolean	formatters
System.Boolean	headers

GetSelectedColumnsDataAsync(Boolean, Boolean)

Declaration

public Task GetSelectedColumnsDataAsync(bool formatters, bool headers)

Parameters

Type	Name	Description
System.Boolean	formatters
System.Boolean	headers

Returns

Type	Description
System.Threading.Tasks.Task

GetSelectedData(Boolean, Boolean)

Declaration

public void GetSelectedData(bool formatters, bool headers)

Parameters

Type	Name	Description
System.Boolean	formatters
System.Boolean	headers

GetSelectedDataAsync(Boolean, Boolean)

Declaration

public Task GetSelectedDataAsync(bool formatters, bool headers)

Parameters

Type	Name	Description
System.Boolean	formatters
System.Boolean	headers

Returns

Type	Description
System.Threading.Tasks.Task

GetSelectedRanges()

Declaration

public IgbGridSelectionRange[] GetSelectedRanges()

Returns

Type	Description
IgbGridSelectionRange[]

GetSelectedRangesAsync()

Declaration

public Task<IgbGridSelectionRange[]> GetSelectedRangesAsync()

Returns

Type	Description
System.Threading.Tasks.Task<IgbGridSelectionRange[]>

IsRecordPinnedByIndex(Double)

Declaration

public void IsRecordPinnedByIndex(double rowIndex)

Parameters

Type	Name	Description
System.Double	rowIndex

IsRecordPinnedByIndexAsync(Double)

Returns whether the record is pinned or not. rowIndex Index of the record in the filteredSortedData collection.

Declaration

public Task IsRecordPinnedByIndexAsync(double rowIndex)

Parameters

Type	Name	Description
System.Double	rowIndex	Index of the record in the `filteredSortedData` collection.

Returns

Type	Description
System.Threading.Tasks.Task

MarkForCheck()

Declaration

public void MarkForCheck()

MarkForCheckAsync()

Triggers change detection for the IgxGridComponent. Calling markForCheck also triggers the grid pipes explicitly, resulting in all updates being processed. May degrade performance if used when not needed, or if misused:

// DON&apos;Ts:
// don&apos;t call markForCheck from inside a loop
// don&apos;t call markForCheck when a primitive has changed
grid.data.forEach(rec => {
rec = newValue;
grid.markForCheck();
});
// DOs
// call markForCheck after updating a nested property
grid.data.forEach(rec => {
rec.nestedProp1.nestedProp2 = newValue;
});
grid.markForCheck();

@example

grid.markForCheck();

Declaration

public Task MarkForCheckAsync()

Returns

Type	Description
System.Threading.Tasks.Task

MoveColumn(IgbColumn, IgbColumn, DropPosition)

Declaration

public void MoveColumn(IgbColumn column, IgbColumn target, DropPosition pos)

Parameters

Type	Name	Description
IgbColumn	column
IgbColumn	target
DropPosition	pos

MoveColumnAsync(IgbColumn, IgbColumn, DropPosition)

Declaration

public Task MoveColumnAsync(IgbColumn column, IgbColumn target, DropPosition pos)

Parameters

Type	Name	Description
IgbColumn	column
IgbColumn	target
DropPosition	pos

Returns

Type	Description
System.Threading.Tasks.Task

OnRowAddedOverride(IgbRowDataEventArgs)

Declaration

protected virtual void OnRowAddedOverride(IgbRowDataEventArgs args)

Parameters

Type	Name	Description
IgbRowDataEventArgs	args

OpenAdvancedFilteringDialog(IgbOverlaySettings)

Declaration

public void OpenAdvancedFilteringDialog(IgbOverlaySettings overlaySettings)

Parameters

Type	Name	Description
IgbOverlaySettings	overlaySettings

OpenAdvancedFilteringDialogAsync(IgbOverlaySettings)

Opens the advanced filtering dialog.

Declaration

public Task OpenAdvancedFilteringDialogAsync(IgbOverlaySettings overlaySettings)

Parameters

Type	Name	Description
IgbOverlaySettings	overlaySettings

Returns

Type	Description
System.Threading.Tasks.Task

PinColumn(String, Object)

Declaration

public bool PinColumn(string columnName, object index)

Parameters

Type	Name	Description
System.String	columnName
System.Object	index

Returns

Type	Description
System.Boolean

PinColumnAsync(String, Object)

Declaration

public Task<bool> PinColumnAsync(string columnName, object index)

Parameters

Type	Name	Description
System.String	columnName
System.Object	index

Returns

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

PropagateValues(Object, Dictionary<String, Object>, Boolean)

Declaration

protected void PropagateValues(object item, Dictionary<string, object> props, bool createNewIfPossible)

Parameters

Type	Name	Description
System.Object	item
System.Collections.Generic.Dictionary<System.String, System.Object>	props
System.Boolean	createNewIfPossible

RecalculateAutoSizes()

Declaration

public void RecalculateAutoSizes()

RecalculateAutoSizesAsync()

Declaration

public Task RecalculateAutoSizesAsync()

Returns

Type	Description
System.Threading.Tasks.Task

Reflow()

Declaration

public void Reflow()

ReflowAsync()

Recalculates grid width/height dimensions. @remarks Should be run when changing DOM elements dimentions manually that affect the grid's size. @example

this.grid.reflow();

Declaration

public Task ReflowAsync()

Returns

Type	Description
System.Threading.Tasks.Task

RefreshSearch(Boolean, Boolean)

Declaration

public double RefreshSearch(bool updateActiveInfo, bool endEdit)

Parameters

Type	Name	Description
System.Boolean	updateActiveInfo
System.Boolean	endEdit

Returns

Type	Description
System.Double

RefreshSearchAsync(Boolean, Boolean)

Declaration

public Task<double> RefreshSearchAsync(bool updateActiveInfo, bool endEdit)

Parameters

Type	Name	Description
System.Boolean	updateActiveInfo
System.Boolean	endEdit

Returns

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

ResumeNotifications()

Declaration

public void ResumeNotifications()

SelectAllColumns()

Declaration

public void SelectAllColumns()

SelectAllColumnsAsync()

Selects all columns @example

this.grid.deselectAllColumns();

Declaration

public Task SelectAllColumnsAsync()

Returns

Type	Description
System.Threading.Tasks.Task

SelectAllRows(Boolean)

Declaration

public void SelectAllRows(bool onlyFilterData)

Parameters

Type	Name	Description
System.Boolean	onlyFilterData

SelectAllRowsAsync(Boolean)

Selects all rows @remarks By default if filtering is in place, selectAllRows() and deselectAllRows() select/deselect all filtered rows. If you set the parameter onlyFilterData to false that will select all rows in the grid exept deleted rows. @example

this.grid.selectAllRows();
this.grid.selectAllRows(false);

onlyFilterData

Declaration

public Task SelectAllRowsAsync(bool onlyFilterData)

Parameters

Type	Name	Description
System.Boolean	onlyFilterData

Returns

Type	Description
System.Threading.Tasks.Task

SelectColumns(String[], Boolean)

Declaration

public void SelectColumns(string[] columns, bool clearCurrentSelection)

Parameters

Type	Name	Description
System.String[]	columns
System.Boolean	clearCurrentSelection

SelectColumnsAsync(String[], Boolean)

Declaration

public Task SelectColumnsAsync(string[] columns, bool clearCurrentSelection)

Parameters

Type	Name	Description
System.String[]	columns
System.Boolean	clearCurrentSelection

Returns

Type	Description
System.Threading.Tasks.Task

SelectedColumns()

Declaration

public IgbColumn[] SelectedColumns()

Returns

Type	Description
IgbColumn[]

SelectedColumnsAsync()

Get current selected columns. @example Returns an array with selected columns

const selectedColumns = this.grid.selectedColumns();

Declaration

public Task<IgbColumn[]> SelectedColumnsAsync()

Returns

Type	Description
System.Threading.Tasks.Task<IgbColumn[]>

SelectRange(IgbGridSelectionRange[])

Declaration

public void SelectRange(IgbGridSelectionRange[] arg)

Parameters

Type	Name	Description
IgbGridSelectionRange[]	arg

SelectRangeAsync(IgbGridSelectionRange[])

Declaration

public Task SelectRangeAsync(IgbGridSelectionRange[] arg)

Parameters

Type	Name	Description
IgbGridSelectionRange[]	arg

Returns

Type	Description
System.Threading.Tasks.Task

SelectRows(Object[], Boolean)

Declaration

public void SelectRows(object[] rowIDs, bool clearCurrentSelection)

Parameters

Type	Name	Description
System.Object[]	rowIDs
System.Boolean	clearCurrentSelection

SelectRowsAsync(Object[], Boolean)

Declaration

public Task SelectRowsAsync(object[] rowIDs, bool clearCurrentSelection)

Parameters

Type	Name	Description
System.Object[]	rowIDs
System.Boolean	clearCurrentSelection

Returns

Type	Description
System.Threading.Tasks.Task

Sort(IgbSortingExpression[])

Declaration

public void Sort(IgbSortingExpression[] expression)

Parameters

Type	Name	Description
IgbSortingExpression[]	expression

SortAsync(IgbSortingExpression[])

Declaration

public Task SortAsync(IgbSortingExpression[] expression)

Parameters

Type	Name	Description
IgbSortingExpression[]	expression

Returns

Type	Description
System.Threading.Tasks.Task

SuspendNotifications()

Declaration

public void SuspendNotifications()

ToggleColumnVisibility(IgbColumnVisibilityChangedEventArgs)

Declaration

public void ToggleColumnVisibility(IgbColumnVisibilityChangedEventArgs args)

Parameters

Type	Name	Description
IgbColumnVisibilityChangedEventArgs	args

ToggleColumnVisibilityAsync(IgbColumnVisibilityChangedEventArgs)

Toggles the specified column's visibility. @example

this.grid1.toggleColumnVisibility({
column: this.grid1.columns[0],
newValue: true
});

Declaration

public Task ToggleColumnVisibilityAsync(IgbColumnVisibilityChangedEventArgs args)

Parameters

Type	Name	Description
IgbColumnVisibilityChangedEventArgs	args

Returns

Type	Description
System.Threading.Tasks.Task

ToggleRow(Object)

Declaration

public void ToggleRow(object rowID)

Parameters

Type	Name	Description
System.Object	rowID

ToggleRowAsync(Object)

Toggles the row by its id. @remarks ID is either the primaryKey value or the data record instance. @example

this.grid.toggleRow(rowID);

rowID The row id - primaryKey value or the data record instance.

Declaration

public Task ToggleRowAsync(object rowID)

Parameters

Type	Name	Description
System.Object	rowID	The row id - primaryKey value or the data record instance.

Returns

Type	Description
System.Threading.Tasks.Task

UnpinColumn(String, Object)

Declaration

public bool UnpinColumn(string columnName, object index)

Parameters

Type	Name	Description
System.String	columnName
System.Object	index

Returns

Type	Description
System.Boolean

UnpinColumnAsync(String, Object)

Declaration

public Task<bool> UnpinColumnAsync(string columnName, object index)

Parameters

Type	Name	Description
System.String	columnName
System.Object	index

Returns

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

UpdateCell(Object, Object, String)

Declaration

public void UpdateCell(object value, object rowSelector, string column)

Parameters

Type	Name	Description
System.Object	value
System.Object	rowSelector
System.String	column

UpdateCellAsync(Object, Object, String)

Declaration

public Task UpdateCellAsync(object value, object rowSelector, string column)

Parameters

Type	Name	Description
System.Object	value
System.Object	rowSelector
System.String	column

Returns

Type	Description
System.Threading.Tasks.Task

UpdateProperty(Object, String, Object)

Declaration

protected void UpdateProperty(object item, string propertyName, object value)

Parameters

Type	Name	Description
System.Object	item
System.String	propertyName
System.Object	value

UpdateRow(Dictionary<String, Object>, Object)

Declaration

public void UpdateRow(Dictionary<string, object> value, object rowSelector)

Parameters

Type	Name	Description
System.Collections.Generic.Dictionary<System.String, System.Object>	value
System.Object	rowSelector

UpdateRowAsync(Dictionary<String, Object>, Object)

Declaration

public Task UpdateRowAsync(Dictionary<string, object> value, object rowSelector)

Parameters

Type	Name	Description
System.Collections.Generic.Dictionary<System.String, System.Object>	value
System.Object	rowSelector

Returns

Type	Description
System.Threading.Tasks.Task

Implements

JsonSerializable

System.IDisposable