System.Object
IgbGridBaseDirective
ImplementsSystem.IDisposable
Namespace: IgniteUI.Blazor.Controls Assembly: IgniteUI.Blazor.dll Syntaxpublic class IgbGridBaseDirective : BaseRendererControl, RefSink, JsonSerializable, IDisposable
Constructors IgbGridBaseDirective() Declaration
public IgbGridBaseDirective()
Properties ActionStripComponents Declaration
public IgbActionStripCollection ActionStripComponents { get; protected set; }
Property Value ActiveNodeChange Declaration
public EventCallback<IgbActiveNodeChangeEventArgs> ActiveNodeChange { get; set; }
Property Value ActiveNodeChangeScript Declaration
public string ActiveNodeChangeScript { get; set; }
Property Value Type Description System.String ActualActionStripComponents Declaration
public IgbActionStripCollection ActualActionStripComponents { get; }
Property Value ActualColumnList Declaration
public IgbColumnCollection ActualColumnList { get; protected set; }
Property Value Declaration
public IgbPaginatorCollection ActualPaginationComponents { get; }
Property Value ActualStateComponents Declaration
public IgbStateCollection ActualStateComponents { get; }
Property Value ActualToolbar Declaration
public IgbGridToolbarCollection ActualToolbar { get; }
Property Value 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.
Declarationpublic 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 AdvancedFilteringExpressionsTreeChange Declaration
public EventCallback<IgbFilteringExpressionsTreeEventArgs> AdvancedFilteringExpressionsTreeChange { get; set; }
Property Value 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 CellClickScript Declaration
public string CellClickScript { get; set; }
Property Value Type Description System.String CellEdit Declaration
public EventCallback<IgbGridEditEventArgs> CellEdit { get; set; }
Property Value CellEditDone Declaration
public Action<IgbGridEditDoneEventArgs> CellEditDone { get; set; }
Property Value CellEditEnter Declaration
public EventCallback<IgbGridEditEventArgs> CellEditEnter { get; set; }
Property Value CellEditEnterScript Declaration
public string CellEditEnterScript { get; set; }
Property Value Type Description System.String CellEditExit Declaration
public EventCallback<IgbGridEditDoneEventArgs> CellEditExit { get; set; }
Property Value 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
Declarationpublic GridSelectionMode CellSelection { get; set; }
Property Value ClipboardOptions
Controls the copy behavior of the grid.
Declarationpublic IgbClipboardOptions ClipboardOptions { get; set; }
Property Value ColumnInit Declaration
public EventCallback<IgbColumnComponentEventArgs> ColumnInit { get; set; }
Property Value ColumnInitScript Declaration
public string ColumnInitScript { get; set; }
Property Value Type Description System.String ColumnList Declaration
public IgbColumnCollection ColumnList { get; protected set; }
Property Value ColumnMoving Declaration
public EventCallback<IgbColumnMovingEventArgs> ColumnMoving { get; set; }
Property Value ColumnMovingEnd Declaration
public EventCallback<IgbColumnMovingEndEventArgs> ColumnMovingEnd { get; set; }
Property Value 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 ColumnMovingStartScript Declaration
public string ColumnMovingStartScript { get; set; }
Property Value Type Description System.String ColumnPin Declaration
public EventCallback<IgbPinColumnCancellableEventArgs> ColumnPin { get; set; }
Property Value ColumnPinned Declaration
public EventCallback<IgbPinColumnEventArgs> ColumnPinned { get; set; }
Property Value 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 ColumnResizedScript Declaration
public string ColumnResizedScript { get; set; }
Property Value Type Description System.String ColumnsAutogenerated Declaration
public EventCallback<IgbColumnsAutoGeneratedEventArgs> ColumnsAutogenerated { get; set; }
Property Value 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
Declarationpublic GridSelectionMode ColumnSelection { get; set; }
Property Value ColumnSelectionChanging Declaration
public EventCallback<IgbColumnSelectionEventArgs> ColumnSelectionChanging { get; set; }
Property Value ColumnSelectionChangingScript Declaration
public string ColumnSelectionChangingScript { get; set; }
Property Value Type Description System.String ColumnVisibilityChanged Declaration
public EventCallback<IgbColumnVisibilityChangedEventArgs> ColumnVisibilityChanged { get; set; }
Property Value ColumnVisibilityChangedScript Declaration
public string ColumnVisibilityChangedScript { get; set; }
Property Value Type Description System.String ColumnVisibilityChanging Declaration
public EventCallback<IgbColumnVisibilityChangingEventArgs> ColumnVisibilityChanging { get; set; }
Property Value 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 ContentActionStripComponents Declaration
public IgbActionStripCollection ContentActionStripComponents { get; }
Property Value ContentColumnList Declaration
public IgbColumnCollection ContentColumnList { get; }
Property Value Declaration
public IgbPaginatorCollection ContentPaginationComponents { get; }
Property Value ContentStateComponents Declaration
public IgbStateCollection ContentStateComponents { get; }
Property Value ContentToolbar Declaration
public IgbGridToolbarCollection ContentToolbar { get; }
Property Value Declaration
public EventCallback<IgbGridContextMenuEventArgs> ContextMenu { get; set; }
Property Value Declaration
public string ContextMenuScript { get; set; }
Property Value Type Description System.String DataChanged Declaration
public EventCallback<IgbForOfDataChangeEventArgs> DataChanged { get; set; }
Property Value DataChangedScript Declaration
public string DataChangedScript { get; set; }
Property Value Type Description System.String DataChanging Declaration
public EventCallback<IgbForOfDataChangeEventArgs> DataChanging { get; set; }
Property Value DataChangingScript Declaration
public string DataChangingScript { get; set; }
Property Value Type Description System.String DataCloneStrategy Declaration
public IgbDataCloneStrategy DataCloneStrategy { get; set; }
Property Value DefaultEventBehavior Declaration
protected override ControlEventBehavior DefaultEventBehavior { get; }
Property Value Overrides DoubleClick Declaration
public EventCallback<IgbGridCellEventArgs> DoubleClick { get; set; }
Property Value 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.
Declarationpublic RenderFragment<IgbGridRowDragGhostContext> DragGhostCustomTemplate { get; set; }
Property Value DragGhostCustomTemplateScript
Provides a means of setting DragGhostCustomTemplate in the JavaScript environment.
Declarationpublic 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
Declarationpublic RenderFragment<IgbGridEmptyTemplateContext> DragIndicatorIconTemplate { get; set; }
Property Value DragIndicatorIconTemplateScript
Provides a means of setting DragIndicatorIconTemplate in the JavaScript environment.
Declarationpublic 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<IgbGridTemplateContext> EmptyGridTemplate { get; set; }
Property Value EmptyGridTemplateScript
Provides a means of setting EmptyGridTemplate in the JavaScript environment.
Declarationpublic string EmptyGridTemplateScript { get; set; }
Property Value Type Description System.String
Gets the excel style header icon.
Declarationpublic RenderFragment<IgbGridHeaderTemplateContext> ExcelStyleHeaderIconTemplate { get; set; }
Property Value
Provides a means of setting ExcelStyleHeaderIconTemplate in the JavaScript environment.
Declarationpublic string ExcelStyleHeaderIconTemplateScript { get; set; }
Property Value Type Description System.String Filtering Declaration
public EventCallback<IgbFilteringEventArgs> Filtering { get; set; }
Property Value FilteringDone Declaration
public EventCallback<IgbFilteringExpressionsTreeEventArgs> FilteringDone { get; set; }
Property Value FilteringDoneScript Declaration
public string FilteringDoneScript { get; set; }
Property Value Type Description System.String FilteringExpressionsTree Declaration
public IgbFilteringExpressionsTree FilteringExpressionsTree { get; set; }
Property Value FilteringExpressionsTreeChange Declaration
public EventCallback<IgbFilteringExpressionsTreeEventArgs> FilteringExpressionsTreeChange { get; set; }
Property Value FilteringExpressionsTreeChangeScript Declaration
public string FilteringExpressionsTreeChangeScript { get; set; }
Property Value Type Description System.String FilteringLogic Declaration
public FilteringLogic FilteringLogic { get; set; }
Property Value FilteringScript Declaration
public string FilteringScript { get; set; }
Property Value Type Description System.String FilterMode Declaration
public FilterMode FilterMode { get; set; }
Property Value FilterStrategy Declaration
public IgbFilteringStrategy FilterStrategy { get; set; }
Property Value FormGroupCreated Declaration
public EventCallback<IgbGridFormGroupCreatedEventArgs> FormGroupCreated { get; set; }
Property Value FormGroupCreatedScript Declaration
public string FormGroupCreatedScript { get; set; }
Property Value Type Description System.String GridCopy Declaration
public EventCallback<IgbGridClipboardEventEventArgs> GridCopy { get; set; }
Property Value GridCopyScript Declaration
public string GridCopyScript { get; set; }
Property Value Type Description System.String GridKeydown Declaration
public EventCallback<IgbGridKeydownEventArgs> GridKeydown { get; set; }
Property Value GridKeydownScript Declaration
public string GridKeydownScript { get; set; }
Property Value Type Description System.String GridScroll Declaration
public EventCallback<IgbGridScrollEventArgs> GridScroll { get; set; }
Property Value GridScrollScript Declaration
public string GridScrollScript { get; set; }
Property Value Type Description System.String Declaration
public RenderFragment<IgbGridTemplateContext> HeaderCollapsedIndicatorTemplate { get; set; }
Property Value Declaration
public string HeaderCollapsedIndicatorTemplateScript { get; set; }
Property Value Type Description System.String HeaderExpandedIndicatorTemplate Declaration
public RenderFragment<IgbGridTemplateContext> HeaderExpandedIndicatorTemplate { get; set; }
Property Value HeaderExpandedIndicatorTemplateScript Declaration
public string HeaderExpandedIndicatorTemplateScript { get; set; }
Property Value Type Description System.String HeadSelectorTemplate
Gets the header row selector template.
Declarationpublic RenderFragment<IgbHeadSelectorTemplateContext> HeadSelectorTemplate { get; set; }
Property Value HeadSelectorTemplateScript
Provides a means of setting HeadSelectorTemplate in the JavaScript environment.
Declarationpublic 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
Declarationpublic 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 LoadingGridTemplate Declaration
public RenderFragment<IgbGridTemplateContext> LoadingGridTemplate { get; set; }
Property Value LoadingGridTemplateScript
Provides a means of setting LoadingGridTemplate in the JavaScript environment.
Declarationpublic string LoadingGridTemplateScript { get; set; }
Property Value Type Description System.String Locale
Gets/Sets the locale. @remarks If not set, returns browser's language.
Declarationpublic string Locale { get; set; }
Property Value Type Description System.String Moving
Controls whether columns moving is enabled in the grid.
Declarationpublic bool Moving { get; set; }
Property Value Type Description System.Boolean NeedsDynamicContent Declaration
protected override bool NeedsDynamicContent { get; }
Property Value Type Description System.Boolean Overrides 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.
Declarationpublic IgbOverlayOutletDirective Outlet { get; set; }
Property Value
@hidden @internal
Declarationpublic IgbPaginatorCollection PaginationComponents { get; protected set; }
Property Value PagingMode Declaration
public GridPagingMode PagingMode { get; set; }
Property Value ParentTypeName Declaration
protected override string ParentTypeName { get; }
Property Value Type Description System.String Overrides Pinning Declaration
public IgbPinningConfig Pinning { get; set; }
Property Value PrimaryKey Declaration
public string PrimaryKey { get; set; }
Property Value Type Description System.String RangeSelected Declaration
public EventCallback<IgbGridSelectionRangeEventArgs> RangeSelected { get; set; }
Property Value RangeSelectedScript Declaration
public string RangeSelectedScript { get; set; }
Property Value Type Description System.String Rendered Declaration
public EventCallback<IgbComponentBoolValueChangedEventArgs> Rendered { get; set; }
Property Value 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.
Declarationpublic IgbGridResourceStrings ResourceStrings { get; set; }
Property Value RowAdd Declaration
public EventCallback<IgbRowDataCancelableEventArgs> RowAdd { get; set; }
Property Value RowAdded Declaration
public Action<IgbRowDataEventArgs> RowAdded { get; set; }
Property Value RowAddScript Declaration
public string RowAddScript { get; set; }
Property Value Type Description System.String RowAddTextTemplate
Gets the row add text template.
Declarationpublic RenderFragment<IgbGridEmptyTemplateContext> RowAddTextTemplate { get; set; }
Property Value RowAddTextTemplateScript
Provides a means of setting RowAddTextTemplate in the JavaScript environment.
Declarationpublic 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.
Declarationpublic string RowClassesScript { get; set; }
Property Value Type Description System.String RowClick Declaration
public EventCallback<IgbGridRowEventArgs> RowClick { get; set; }
Property Value RowClickScript Declaration
public string RowClickScript { get; set; }
Property Value Type Description System.String RowCollapsedIndicatorTemplate
The custom template, if any, that should be used when rendering a row collapse indicator.
Declarationpublic RenderFragment<IgbGridRowTemplateContext> RowCollapsedIndicatorTemplate { get; set; }
Property Value RowCollapsedIndicatorTemplateScript
Provides a means of setting RowCollapsedIndicatorTemplate in the JavaScript environment.
Declarationpublic string RowCollapsedIndicatorTemplateScript { get; set; }
Property Value Type Description System.String RowDelete Declaration
public EventCallback<IgbRowDataCancelableEventArgs> RowDelete { get; set; }
Property Value RowDeleted Declaration
public Action<IgbRowDataEventArgs> RowDeleted { get; set; }
Property Value RowDeleteScript Declaration
public string RowDeleteScript { get; set; }
Property Value Type Description System.String RowDragEnd Declaration
public EventCallback<IgbRowDragEndEventArgs> RowDragEnd { get; set; }
Property Value 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 RowDragStartScript Declaration
public string RowDragStartScript { get; set; }
Property Value Type Description System.String RowEdit Declaration
public EventCallback<IgbGridEditEventArgs> RowEdit { get; set; }
Property Value RowEditable Declaration
public bool RowEditable { get; set; }
Property Value Type Description System.Boolean RowEditActionsTemplate
Gets the row edit actions template.
Declarationpublic RenderFragment<IgbGridRowEditActionsTemplateContext> RowEditActionsTemplate { get; set; }
Property Value RowEditActionsTemplateScript
Provides a means of setting RowEditActionsTemplate in the JavaScript environment.
Declarationpublic string RowEditActionsTemplateScript { get; set; }
Property Value Type Description System.String RowEditDone Declaration
public EventCallback<IgbGridEditDoneEventArgs> RowEditDone { get; set; }
Property Value RowEditDoneScript Declaration
public string RowEditDoneScript { get; set; }
Property Value Type Description System.String RowEditEnter Declaration
public EventCallback<IgbGridEditEventArgs> RowEditEnter { get; set; }
Property Value RowEditEnterScript Declaration
public string RowEditEnterScript { get; set; }
Property Value Type Description System.String RowEditExit Declaration
public EventCallback<IgbGridEditDoneEventArgs> RowEditExit { get; set; }
Property Value 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.
Declarationpublic RenderFragment<IgbGridRowEditTextTemplateContext> RowEditTextTemplate { get; set; }
Property Value RowEditTextTemplateScript
Provides a means of setting RowEditTextTemplate in the JavaScript environment.
Declarationpublic 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.
Declarationpublic RenderFragment<IgbGridRowTemplateContext> RowExpandedIndicatorTemplate { get; set; }
Property Value RowExpandedIndicatorTemplateScript
Provides a means of setting RowExpandedIndicatorTemplate in the JavaScript environment.
Declarationpublic 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 RowPinnedScript Declaration
public string RowPinnedScript { get; set; }
Property Value Type Description System.String RowPinning Declaration
public EventCallback<IgbPinRowEventArgs> RowPinning { get; set; }
Property Value 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'
Declarationpublic GridSelectionMode RowSelection { get; set; }
Property Value RowSelectionChanging Declaration
public EventCallback<IgbRowSelectionEventArgs> RowSelectionChanging { get; set; }
Property Value RowSelectionChangingScript Declaration
public string RowSelectionChangingScript { get; set; }
Property Value Type Description System.String RowSelectorTemplate
Gets the row selector template.
Declarationpublic RenderFragment<IgbRowSelectorTemplateContext> RowSelectorTemplate { get; set; }
Property Value RowSelectorTemplateScript
Provides a means of setting RowSelectorTemplate in the JavaScript environment.
Declarationpublic 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.
Declarationpublic string RowStylesScript { get; set; }
Property Value Type Description System.String RowToggle Declaration
public EventCallback<IgbRowToggleEventArgs> RowToggle { get; set; }
Property Value RowToggleScript Declaration
public string RowToggleScript { get; set; }
Property Value Type Description System.String Selected Declaration
public EventCallback<IgbGridCellEventArgs> Selected { get; set; }
Property Value SelectedRows Declaration
public object[] SelectedRows { get; set; }
Property Value Type Description System.Object[] SelectedRowsChange Declaration
public EventCallback<IgbComponentArrayDataValueChangedEventArgs> SelectedRowsChange { get; set; }
Property Value SelectedRowsChanged Declaration
public EventCallback<object[]> SelectedRowsChanged { get; set; }
Property Value Type Description Microsoft.AspNetCore.Components.EventCallback<System.Object[]> SelectedRowsChangeScript Declaration
public string SelectedRowsChangeScript { get; set; }
Property Value Type Description System.String 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
Declarationpublic 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.
Declarationpublic double SnackbarDisplayTime { get; set; }
Property Value Type Description System.Double
The custom template, if any, that should be used when rendering a header sorting indicator when columns are sorted in asc order.
Declarationpublic RenderFragment<IgbGridHeaderTemplateContext> SortAscendingHeaderIconTemplate { get; set; }
Property Value
Provides a means of setting SortAscendingHeaderIconTemplate in the JavaScript environment.
Declarationpublic string SortAscendingHeaderIconTemplateScript { get; set; }
Property Value Type Description System.String
The custom template, if any, that should be used when rendering a header sorting indicator when columns are sorted in desc order.
Declarationpublic RenderFragment<IgbGridHeaderTemplateContext> SortDescendingHeaderIconTemplate { get; set; }
Property Value
Provides a means of setting SortDescendingHeaderIconTemplate in the JavaScript environment.
Declarationpublic string SortDescendingHeaderIconTemplateScript { get; set; }
Property Value Type Description System.String
Gets custom template, if any, that should be used when rendering a header sorting indicator when columns are not sorted.
Declarationpublic RenderFragment<IgbGridHeaderTemplateContext> SortHeaderIconTemplate { get; set; }
Property Value
Provides a means of setting SortHeaderIconTemplate in the JavaScript environment.
Declarationpublic string SortHeaderIconTemplateScript { get; set; }
Property Value Type Description System.String Sorting Declaration
public EventCallback<IgbSortingEventArgs> Sorting { get; set; }
Property Value SortingDone Declaration
public EventCallback<IgbSortingExpressionEventArgs> SortingDone { get; set; }
Property Value SortingDoneScript Declaration
public string SortingDoneScript { get; set; }
Property Value Type Description System.String SortingExpressions Declaration
public IgbSortingExpression[] SortingExpressions { get; set; }
Property Value SortingExpressionsChange Declaration
public EventCallback<IgbSortingExpressionEventArgs> SortingExpressionsChange { get; set; }
Property Value SortingExpressionsChangeScript Declaration
public string SortingExpressionsChangeScript { get; set; }
Property Value Type Description System.String SortingOptions Declaration
public IgbSortingOptions SortingOptions { get; set; }
Property Value SortingScript Declaration
public string SortingScript { get; set; }
Property Value Type Description System.String SortStrategy Declaration
public IgbGridSortingStrategy SortStrategy { get; set; }
Property Value StateComponents Declaration
public IgbStateCollection StateComponents { get; protected set; }
Property Value SummaryCalculationMode Declaration
public GridSummaryCalculationMode SummaryCalculationMode { get; set; }
Property Value SummaryPosition Declaration
public GridSummaryPosition SummaryPosition { get; set; }
Property Value SummaryRowHeight
Get/Set IgxSummaryRow height
Declarationpublic double SummaryRowHeight { get; set; }
Property Value Type Description System.Double Toolbar
@hidden @internal
Declarationpublic IgbGridToolbarCollection Toolbar { get; protected set; }
Property Value ToolbarExporting Declaration
public EventCallback<IgbGridToolbarExportEventArgs> ToolbarExporting { get; set; }
Property Value 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 ValidationStatusChange Declaration
public EventCallback<IgbGridValidationStatusEventArgs> ValidationStatusChange { get; set; }
Property Value ValidationStatusChangeScript Declaration
public string ValidationStatusChangeScript { get; set; }
Property Value Type Description System.String ValidationTrigger Declaration
public GridValidationTrigger ValidationTrigger { get; set; }
Property Value 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 = false)
Parameters Type Name Description System.Object rowID System.Boolean asChild BeginAddRowByIdAsync(Object, Boolean) Declaration
public Task BeginAddRowByIdAsync(object rowID, bool asChild = false)
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 = null)
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 IgxColumnComponent
s. @example
this.grid.clearFilter();
name
Declarationpublic Task ClearFilterAsync(string name = null)
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 = null)
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
Declarationpublic Task ClearSortAsync(string name = null)
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
Declarationpublic 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() Declarationpublic 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.
Declarationpublic 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) Declarationpublic 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
Declarationpublic 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 = false)
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
Declarationpublic Task DeselectAllRowsAsync(bool onlyFilterData = false)
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 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.
Declarationpublic 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) Declarationpublic void Filter(string name, object value, IgbFilteringExpressionsTreeOrFilteringOperation conditionOrExpressionTree, bool ignoreCase = false)
Parameters FilterAsync(String, Object, IgbFilteringExpressionsTreeOrFilteringOperation, Boolean) Declaration
public Task FilterAsync(string name, object value, IgbFilteringExpressionsTreeOrFilteringOperation conditionOrExpressionTree, bool ignoreCase = false)
Parameters 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 FindNext(String, Boolean, Boolean) Declaration
public double FindNext(string text, bool caseSensitive = false, bool exactMatch = false)
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 = false, bool exactMatch = false)
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 = false, bool exactMatch = false)
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 = false, bool exactMatch = false)
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 GetColumnByNameAsync(String)
Returns the IgxColumnComponent
by field name. @example
const myCol = this.grid1.getColumnByName("ID");
name
Declarationpublic 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 GetColumnByVisibleIndexAsync(Double) Declaration
public Task<IgbColumn> GetColumnByVisibleIndexAsync(double index)
Parameters Type Name Description System.Double index Returns Type Description System.Threading.Tasks.Task<IgbColumn> GetColumns() Declaration
public IgbColumn[] GetColumns()
Returns GetColumnsAsync() Declaration
public Task<IgbColumn[]> GetColumnsAsync()
Returns Type Description System.Threading.Tasks.Task<IgbColumn[]> GetCurrentActualColumnList() Declaration
public IgbColumnCollection GetCurrentActualColumnList()
Returns GetCurrentActualColumnListAsync() Declaration
public Task<IgbColumnCollection> GetCurrentActualColumnListAsync()
Returns 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 GetDataView() Declaration
public object[] GetDataView()
Returns Type Description System.Object[] GetDataViewAsync() Declaration
public Task<object[]> GetDataViewAsync()
Returns Type Description System.Threading.Tasks.Task<System.Object[]> Declaration
public double GetDefaultHeaderGroupMinWidth()
Returns Type Description System.Double Declaration
public Task<double> GetDefaultHeaderGroupMinWidthAsync()
Returns Type Description System.Threading.Tasks.Task<System.Double> GetDefaultRowHeight() Declaration
public double GetDefaultRowHeight()
Returns Type Description System.Double GetDefaultRowHeightAsync() Declaration
public Task<double> GetDefaultRowHeightAsync()
Returns Type Description System.Threading.Tasks.Task<System.Double> GetFilteredData() Declaration
public object GetFilteredData()
Returns Type Description System.Object GetFilteredDataAsync() Declaration
public Task<object> GetFilteredDataAsync()
Returns Type Description System.Threading.Tasks.Task<System.Object> GetFilteredSortedData() Declaration
public object[] GetFilteredSortedData()
Returns Type Description System.Object[] GetFilteredSortedDataAsync() Declaration
public Task<object[]> GetFilteredSortedDataAsync()
Returns Type Description System.Threading.Tasks.Task<System.Object[]> GetHeaderGroupWidth(IgbColumn) Declaration
public string GetHeaderGroupWidth(IgbColumn column)
Parameters Returns Type Description System.String GetHeaderGroupWidthAsync(IgbColumn)
Gets the width
to be set on IgxGridHeaderGroupComponent
.
public Task<string> GetHeaderGroupWidthAsync(IgbColumn column)
Parameters Returns Type Description System.Threading.Tasks.Task<System.String> GetHiddenColumnsCount() Declaration
public double GetHiddenColumnsCount()
Returns Type Description System.Double GetHiddenColumnsCountAsync() Declaration
public Task<double> GetHiddenColumnsCountAsync()
Returns Type Description System.Threading.Tasks.Task<System.Double> GetLastSearchInfo() Declaration
public IgbSearchInfo GetLastSearchInfo()
Returns GetLastSearchInfoAsync() Declaration
public Task<IgbSearchInfo> GetLastSearchInfoAsync()
Returns GetNextCell(Double, Double, Object) Declaration
public IgbCellPosition GetNextCell(double currRowIndex, double curVisibleColIndex, object callback)
Parameters Type Name Description System.Double currRowIndex System.Double curVisibleColIndex System.Object callback Returns GetNextCellAsync(Double, Double, Object) Declaration
public Task<IgbCellPosition> GetNextCellAsync(double currRowIndex, double curVisibleColIndex, object callback)
Parameters Type Name Description System.Double currRowIndex System.Double curVisibleColIndex System.Object callback Returns GetPinnedColumns() Declaration
public IgbColumn[] GetPinnedColumns()
Returns GetPinnedColumnsAsync() Declaration
public Task<IgbColumn[]> GetPinnedColumnsAsync()
Returns Type Description System.Threading.Tasks.Task<IgbColumn[]> GetPinnedColumnsCount() Declaration
public double GetPinnedColumnsCount()
Returns Type Description System.Double GetPinnedColumnsCountAsync() Declaration
public Task<double> GetPinnedColumnsCountAsync()
Returns Type Description System.Threading.Tasks.Task<System.Double> GetPinnedWidth(Boolean) Declaration
public void GetPinnedWidth(bool takeHidden = false)
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.
Declarationpublic Task GetPinnedWidthAsync(bool takeHidden = false)
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 GetPreviousCell(Double, Double, Object) Declarationpublic IgbCellPosition GetPreviousCell(double currRowIndex, double curVisibleColIndex, object callback)
Parameters Type Name Description System.Double currRowIndex System.Double curVisibleColIndex System.Object callback Returns GetPreviousCellAsync(Double, Double, Object) Declaration
public Task<IgbCellPosition> GetPreviousCellAsync(double currRowIndex, double curVisibleColIndex, object callback)
Parameters Type Name Description System.Double currRowIndex System.Double curVisibleColIndex System.Object callback Returns 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
Declarationpublic 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) Declarationpublic void GetSelectedColumnsData(bool formatters = false, bool headers = false)
Parameters Type Name Description System.Boolean formatters System.Boolean headers GetSelectedColumnsDataAsync(Boolean, Boolean) Declaration
public Task GetSelectedColumnsDataAsync(bool formatters = false, bool headers = false)
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 = false, bool headers = false)
Parameters Type Name Description System.Boolean formatters System.Boolean headers GetSelectedDataAsync(Boolean, Boolean) Declaration
public Task GetSelectedDataAsync(bool formatters = false, bool headers = false)
Parameters Type Name Description System.Boolean formatters System.Boolean headers Returns Type Description System.Threading.Tasks.Task GetSelectedRanges() Declaration
public IgbGridSelectionRange[] GetSelectedRanges()
Returns GetSelectedRangesAsync() Declaration
public Task<IgbGridSelectionRange[]> GetSelectedRangesAsync()
Returns GetUnpinnedColumns() Declaration
public IgbColumn[] GetUnpinnedColumns()
Returns GetUnpinnedColumnsAsync() Declaration
public Task<IgbColumn[]> GetUnpinnedColumnsAsync()
Returns Type Description System.Threading.Tasks.Task<IgbColumn[]> GetVirtualizationState() Declaration
public IgbForOfState GetVirtualizationState()
Returns GetVirtualizationStateAsync() Declaration
public Task<IgbForOfState> GetVirtualizationStateAsync()
Returns GetVisibleColumns() Declaration
public IgbColumn[] GetVisibleColumns()
Returns GetVisibleColumnsAsync() Declaration
public Task<IgbColumn[]> GetVisibleColumnsAsync()
Returns Type Description System.Threading.Tasks.Task<IgbColumn[]> 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.
public Task IsRecordPinnedByIndexAsync(double rowIndex)
Parameters Type Name Description System.Double rowIndex
Index of the record in the filteredSortedData
collection.
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'Ts:
// don't call markForCheck from inside a loop
// don'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 MoveColumnAsync(IgbColumn, IgbColumn, DropPosition) Declaration
public Task MoveColumnAsync(IgbColumn column, IgbColumn target, DropPosition pos)
Parameters Returns Type Description System.Threading.Tasks.Task NavigateTo(Double, Double, Object) Declaration
public void NavigateTo(double rowIndex, double visibleColIndex, object cb)
Parameters Type Name Description System.Double rowIndex System.Double visibleColIndex System.Object cb NavigateToAsync(Double, Double, Object) Declaration
public Task NavigateToAsync(double rowIndex, double visibleColIndex, object cb)
Parameters Type Name Description System.Double rowIndex System.Double visibleColIndex System.Object cb Returns Type Description System.Threading.Tasks.Task OnRowAddedOverride(IgbRowDataEventArgs) Declaration
protected virtual void OnRowAddedOverride(IgbRowDataEventArgs args)
Parameters OpenAdvancedFilteringDialog(IgbOverlaySettings) Declaration
public void OpenAdvancedFilteringDialog(IgbOverlaySettings overlaySettings)
Parameters OpenAdvancedFilteringDialogAsync(IgbOverlaySettings)
Opens the advanced filtering dialog.
Declarationpublic Task OpenAdvancedFilteringDialogAsync(IgbOverlaySettings overlaySettings)
Parameters Returns Type Description System.Threading.Tasks.Task PinColumn(String, Double) Declaration
public bool PinColumn(string columnName, double index = -1)
Parameters Type Name Description System.String columnName System.Double index Returns Type Description System.Boolean PinColumnAsync(String, Double) Declaration
public Task<bool> PinColumnAsync(string columnName, double index = -1)
Parameters Type Name Description System.String columnName System.Double 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 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 = false, bool endEdit = false)
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 = false, bool endEdit = false)
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 = false)
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
Declarationpublic Task SelectAllRowsAsync(bool onlyFilterData = false)
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 = false)
Parameters Type Name Description System.String[] columns System.Boolean clearCurrentSelection SelectColumnsAsync(String[], Boolean) Declaration
public Task SelectColumnsAsync(string[] columns, bool clearCurrentSelection = false)
Parameters Type Name Description System.String[] columns System.Boolean clearCurrentSelection Returns Type Description System.Threading.Tasks.Task SelectedColumns() Declaration
public IgbColumn[] SelectedColumns()
Returns 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 SelectRangeAsync(IgbGridSelectionRange[]) Declaration
public Task SelectRangeAsync(IgbGridSelectionRange[] arg)
Parameters Returns Type Description System.Threading.Tasks.Task SelectRows(Object[], Boolean) Declaration
public void SelectRows(object[] rowIDs, bool clearCurrentSelection = false)
Parameters Type Name Description System.Object[] rowIDs System.Boolean clearCurrentSelection SelectRowsAsync(Object[], Boolean) Declaration
public Task SelectRowsAsync(object[] rowIDs, bool clearCurrentSelection = false)
Parameters Type Name Description System.Object[] rowIDs System.Boolean clearCurrentSelection Returns Type Description System.Threading.Tasks.Task SetNativeElement(Object) Declaration
public void SetNativeElement(object element)
Parameters Type Name Description System.Object element SetNativeElementAsync(Object) Declaration
public Task SetNativeElementAsync(object element)
Parameters Type Name Description System.Object element Returns Type Description System.Threading.Tasks.Task Sort(IgbSortingExpression[]) Declaration
public void Sort(IgbSortingExpression[] expression)
Parameters SortAsync(IgbSortingExpression[]) Declaration
public Task SortAsync(IgbSortingExpression[] expression)
Parameters Returns Type Description System.Threading.Tasks.Task SuspendNotifications() Declaration
public void SuspendNotifications()
ToggleColumnVisibility(IgbColumnVisibilityChangedEventArgs) Declaration
public void ToggleColumnVisibility(IgbColumnVisibilityChangedEventArgs args)
Parameters 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 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.
Declarationpublic 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, Double) Declarationpublic bool UnpinColumn(string columnName, double index = -1)
Parameters Type Name Description System.String columnName System.Double index Returns Type Description System.Boolean UnpinColumnAsync(String, Double) Declaration
public Task<bool> UnpinColumnAsync(string columnName, double index = -1)
Parameters Type Name Description System.String columnName System.Double 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
System.IDisposable
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4