Row island

Inheritance

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

Constructors

Section titled "Constructors"

constructor

public IgbRowIsland()

Returns IgbRowIsland

Properties

Section titled "Properties"

IgBlazor

Section titled "IgBlazor"

Inherited from: BaseRendererElement 

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

IsComponentRooted

Section titled "IsComponentRooted"

Inherited from: BaseRendererElement 

public bool IsComponentRooted { get; }

UseDirectRender

Section titled "UseDirectRender"

Inherited from: BaseRendererElement 

protected virtual bool UseDirectRender { get; }

ChildContent

Section titled "ChildContent"

Inherited from: BaseRendererElement 

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

SupportsVisualChildren

Section titled "SupportsVisualChildren"

Inherited from: BaseRendererElement 

protected virtual bool SupportsVisualChildren { get; }

Name

Section titled "Name"

Inherited from: BaseRendererElement 

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

Parent

Section titled "Parent"

Inherited from: BaseRendererElement 

public object Parent { get; }

MethodTarget

Section titled "MethodTarget"

Inherited from: BaseRendererElement 

protected virtual string MethodTarget { get; }

CurrParent

Section titled "CurrParent"

Inherited from: BaseRendererElement 

protected object CurrParent { get; }

ActionStripComponents

Section titled "ActionStripComponents" 
public IgbActionStripCollection ActionStripComponents { get; protected set; }

ActualActionStripComponents

Section titled "ActualActionStripComponents" 
public IgbActionStripCollection ActualActionStripComponents { get; }

ActualChildLayoutList

Section titled "ActualChildLayoutList" 
public IgbRowIslandCollection ActualChildLayoutList { get; }

ActualPaginationComponents

Section titled "ActualPaginationComponents" 
public IgbPaginatorCollection ActualPaginationComponents { get; }

ActualToolbar

Section titled "ActualToolbar" 
public IgbGridToolbarCollection ActualToolbar { get; }

AddRowEmptyTemplate

Section titled "AddRowEmptyTemplate"

Gets/Sets a custom template for adding row UI when grid is empty.

 
[Parameter]
public RenderFragment<object> AddRowEmptyTemplate { get; set; }

AddRowEmptyTemplateScript

Section titled "AddRowEmptyTemplateScript"

Provides a means of setting AddRowEmptyTemplate in the JavaScript environment.

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

AdvancedFilteringExpressionsTree

Section titled "AdvancedFilteringExpressionsTree"

Gets/Sets the advanced filtering state.

 
[Parameter]
public IgbFilteringExpressionsTree AdvancedFilteringExpressionsTree { get; set; }

AllowAdvancedFiltering

Section titled "AllowAdvancedFiltering"

Gets/Sets a value indicating whether the advanced filtering is enabled.

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

AllowFiltering

Section titled "AllowFiltering"

Gets/Sets if the filtering is enabled.

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

AutoGenerate

Section titled "AutoGenerate"

Gets/Sets whether to auto-generate the columns.

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

AutoGenerateExclude

Section titled "AutoGenerateExclude"

Gets/Sets a list of property keys to be excluded from the generated column collection

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

BatchEditing

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

CellMergeMode

Section titled "CellMergeMode"

Gets/Sets cell merge mode.

 
[Parameter]
public GridCellMergeMode CellMergeMode { get; set; }

CellSelection

Section titled "CellSelection"

Gets/Sets cell selection mode. selectionMode: GridSelectionMode

 
[Parameter]
public GridSelectionMode CellSelection { get; set; }

ChildDataKey

Section titled "ChildDataKey"

Sets the key of the row island by which child data would be taken from the row data if such is provided.

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

ChildLayoutList

Section titled "ChildLayoutList" 
public IgbRowIslandCollection ChildLayoutList { get; protected set; }

ClipboardOptions

Section titled "ClipboardOptions"

Controls the copy behavior of the grid.

 
[Parameter]
public IgbClipboardOptions ClipboardOptions { get; set; }

ColumnList

Section titled "ColumnList" 
public IgbColumnCollection ColumnList { get; protected set; }

ColumnSelection

Section titled "ColumnSelection"

Gets/Sets column selection mode selectionMode: GridSelectionMode

 
[Parameter]
public GridSelectionMode ColumnSelection { get; set; }

ColumnWidth

Section titled "ColumnWidth"

Gets/Sets the default width of the columns.

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

ContentActionStripComponents

Section titled "ContentActionStripComponents" 
public IgbActionStripCollection ContentActionStripComponents { get; }

ContentChildLayoutList

Section titled "ContentChildLayoutList" 
public IgbRowIslandCollection ContentChildLayoutList { get; }

ContentPaginationComponents

Section titled "ContentPaginationComponents" 
public IgbPaginatorCollection ContentPaginationComponents { get; }

ContentToolbar

Section titled "ContentToolbar" 
public IgbGridToolbarCollection ContentToolbar { get; }

DataCloneStrategy

Section titled "DataCloneStrategy"

Gets/Sets the data clone strategy of the grid when in edit mode.

 
[Parameter]
public IgbDataCloneStrategy DataCloneStrategy { get; set; }

DragGhostCustomTemplate

Section titled "DragGhostCustomTemplate"

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

 
[Parameter]
public RenderFragment<IgbGridRowDragGhostContext> DragGhostCustomTemplate { get; set; }

DragGhostCustomTemplateScript

Section titled "DragGhostCustomTemplateScript"

Provides a means of setting DragGhostCustomTemplate in the JavaScript environment.

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

DragIndicatorIconTemplate

Section titled "DragIndicatorIconTemplate"

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

 
[Parameter]
public RenderFragment<IgbGridEmptyTemplateContext> DragIndicatorIconTemplate { get; set; }

DragIndicatorIconTemplateScript

Section titled "DragIndicatorIconTemplateScript"

Provides a means of setting DragIndicatorIconTemplate in the JavaScript environment.

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

EmptyFilteredGridMessage

Section titled "EmptyFilteredGridMessage"

Gets/Sets the message displayed when there are no records and the grid is filtered.

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

EmptyGridMessage

Section titled "EmptyGridMessage"

Get/Sets the message displayed when there are no records.

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

EmptyGridTemplate

Section titled "EmptyGridTemplate"

Gets/Sets a custom template when empty.

 
[Parameter]
public RenderFragment<IgbGridTemplateContext> EmptyGridTemplate { get; set; }

EmptyGridTemplateScript

Section titled "EmptyGridTemplateScript"

Provides a means of setting EmptyGridTemplate in the JavaScript environment.

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

ExcelStyleHeaderIconTemplate

Section titled "ExcelStyleHeaderIconTemplate"

Gets the excel style header icon.

 
[Parameter]
public RenderFragment<IgbGridHeaderTemplateContext> ExcelStyleHeaderIconTemplate { get; set; }

ExcelStyleHeaderIconTemplateScript

Section titled "ExcelStyleHeaderIconTemplateScript"

Provides a means of setting ExcelStyleHeaderIconTemplate in the JavaScript environment.

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

ExpandChildren

Section titled "ExpandChildren"

Sets if all immediate children of the grids for this IgxRowIslandComponent should be expanded/collapsed.

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

FilterMode

Section titled "FilterMode"

Gets/Sets the filter mode.

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

FilterStrategy

Section titled "FilterStrategy"

Gets/Sets the filtering strategy of the grid.

 
[Parameter]
public IgbFilteringStrategy FilterStrategy { get; set; }

FilteringExpressionsTree

Section titled "FilteringExpressionsTree"

Gets/Sets the filtering state.

 
[Parameter]
public IgbFilteringExpressionsTree FilteringExpressionsTree { get; set; }

FilteringLogic

Section titled "FilteringLogic"

Gets/Sets the filtering logic of the IgxGridComponent.

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

HasChildrenKey

Section titled "HasChildrenKey"

Gets/Sets the key indicating whether a row has children. If row has no children it does not render an expand indicator.

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

HeadSelectorTemplate

Section titled "HeadSelectorTemplate"

Gets the header row selector template.

 
[Parameter]
public RenderFragment<IgbHeadSelectorTemplateContext> HeadSelectorTemplate { get; set; }

HeadSelectorTemplateScript

Section titled "HeadSelectorTemplateScript"

Provides a means of setting HeadSelectorTemplate in the JavaScript environment.

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

HeaderCollapsedIndicatorTemplate

Section titled "HeaderCollapsedIndicatorTemplate"

Gets the row collapse indicator template.

 
[Parameter]
public RenderFragment<IgbGridTemplateContext> HeaderCollapsedIndicatorTemplate { get; set; }

HeaderCollapsedIndicatorTemplateScript

Section titled "HeaderCollapsedIndicatorTemplateScript"

Provides a means of setting HeaderCollapsedIndicatorTemplate in the JavaScript environment.

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

HeaderExpandedIndicatorTemplate

Section titled "HeaderExpandedIndicatorTemplate"

Gets the header expand indicator template.

 
[Parameter]
public RenderFragment<IgbGridTemplateContext> HeaderExpandedIndicatorTemplate { get; set; }

HeaderExpandedIndicatorTemplateScript

Section titled "HeaderExpandedIndicatorTemplateScript"

Provides a means of setting HeaderExpandedIndicatorTemplate in the JavaScript environment.

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

Height

Section titled "Height"

Gets/Sets the height.

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

HideRowSelectors

Section titled "HideRowSelectors"

Gets/Sets if the row selectors are hidden.

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

HierarchicalGridParent

Section titled "HierarchicalGridParent" 
[CascadingParameter(Name = "HierarchicalGridParent")]
protected BaseRendererControl HierarchicalGridParent { get; set; }

IsLoading

Section titled "IsLoading"

Gets/Sets whether the grid is going to show a loading indicator.

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

LoadingGridTemplate

Section titled "LoadingGridTemplate"

Gets/Sets a custom template when loading.

 
[Parameter]
public RenderFragment<IgbGridTemplateContext> LoadingGridTemplate { get; set; }

LoadingGridTemplateScript

Section titled "LoadingGridTemplateScript"

Provides a means of setting LoadingGridTemplate in the JavaScript environment.

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

Locale

Section titled "Locale"

Gets/Sets the locale.

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

Moving

Section titled "Moving"

Controls whether columns moving is enabled in the grid.

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

PaginationComponents

Section titled "PaginationComponents" 
public IgbPaginatorCollection PaginationComponents { get; protected set; }

PagingMode

Section titled "PagingMode" 
[Parameter]
public GridPagingMode PagingMode { get; set; }

ParentTypeName

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

Pinning

Section titled "Pinning"

Gets/Sets the initial pinning configuration.

 
[Parameter]
public IgbPinningConfig Pinning { get; set; }

PrimaryKey

Section titled "PrimaryKey"

Gets/Sets the primary key.

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

ResourceStrings

Section titled "ResourceStrings"

Gets/Sets the resource strings.

 
[Parameter]
public IgbGridResourceStrings ResourceStrings { get; set; }

ResourceStringsScript

Section titled "ResourceStringsScript"

Provides a means of setting ResourceStrings in the JavaScript environment.

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

RowAddTextTemplate

Section titled "RowAddTextTemplate"

Gets the row add text template.

 
[Parameter]
public RenderFragment<IgbGridEmptyTemplateContext> RowAddTextTemplate { get; set; }

RowAddTextTemplateScript

Section titled "RowAddTextTemplateScript"

Provides a means of setting RowAddTextTemplate in the JavaScript environment.

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

RowClasses

Section titled "RowClasses"

Sets a conditional class selector to the grid's row element. Accepts an object literal, containing key-value pairs, where the key is the name of the CSS class and the value is either a callback function that returns a boolean, or boolean, like so:

 
[Parameter]
public object RowClasses { get; set; }

RowClassesScript

Section titled "RowClassesScript"

Provides a means of setting RowClasses in the JavaScript environment.

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

RowCollapsedIndicatorTemplate

Section titled "RowCollapsedIndicatorTemplate"

Gets the row collapse indicator template.

 
[Parameter]
public RenderFragment<IgbGridRowTemplateContext> RowCollapsedIndicatorTemplate { get; set; }

RowCollapsedIndicatorTemplateScript

Section titled "RowCollapsedIndicatorTemplateScript"

Provides a means of setting RowCollapsedIndicatorTemplate in the JavaScript environment.

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

RowDraggable

Section titled "RowDraggable"

Gets/Sets whether rows can be moved.

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

RowEditActionsTemplate

Section titled "RowEditActionsTemplate"

Gets the row edit actions template.

 
[Parameter]
public RenderFragment<IgbGridRowEditActionsTemplateContext> RowEditActionsTemplate { get; set; }

RowEditActionsTemplateScript

Section titled "RowEditActionsTemplateScript"

Provides a means of setting RowEditActionsTemplate in the JavaScript environment.

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

RowEditTextTemplate

Section titled "RowEditTextTemplate"

Gets the row edit text template.

 
[Parameter]
public RenderFragment<IgbGridRowEditTextTemplateContext> RowEditTextTemplate { get; set; }

RowEditTextTemplateScript

Section titled "RowEditTextTemplateScript"

Provides a means of setting RowEditTextTemplate in the JavaScript environment.

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

RowEditable

Section titled "RowEditable"

Gets/Sets whether the rows are editable.

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

RowExpandedIndicatorTemplate

Section titled "RowExpandedIndicatorTemplate"

Gets the row expand indicator template.

 
[Parameter]
public RenderFragment<IgbGridRowTemplateContext> RowExpandedIndicatorTemplate { get; set; }

RowExpandedIndicatorTemplateScript

Section titled "RowExpandedIndicatorTemplateScript"

Provides a means of setting RowExpandedIndicatorTemplate in the JavaScript environment.

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

RowHeight

Section titled "RowHeight"

Gets/Sets the row height.

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

RowIslandParent

Section titled "RowIslandParent" 
[CascadingParameter(Name = "RowIslandParent")]
protected BaseRendererElement RowIslandParent { get; set; }

RowSelection

Section titled "RowSelection"

Gets/Sets row selection mode

 
[Parameter]
public GridSelectionMode RowSelection { get; set; }

RowSelectorTemplate

Section titled "RowSelectorTemplate"

Gets the row selector template.

 
[Parameter]
public RenderFragment<IgbRowSelectorTemplateContext> RowSelectorTemplate { get; set; }

RowSelectorTemplateScript

Section titled "RowSelectorTemplateScript"

Provides a means of setting RowSelectorTemplate in the JavaScript environment.

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

RowStyles

Section titled "RowStyles"

Sets conditional style properties on the grid row element. It accepts an object literal where the keys are the style properties and the value is an expression to be evaluated.

 
[Parameter]
public object RowStyles { get; set; }

RowStylesScript

Section titled "RowStylesScript"

Provides a means of setting RowStyles in the JavaScript environment.

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

SelectRowOnClick

Section titled "SelectRowOnClick"

Gets/Sets whether clicking over a row should select/deselect it enabled: boolean

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

SelectedRows

Section titled "SelectedRows"

Gets/Sets the current selection state.

 
[Parameter]
public object[] SelectedRows { get; set; }

ShouldGenerate

Section titled "ShouldGenerate"

Gets/Sets whether the columns should be auto-generated once again after the initialization of the grid

 
[Parameter]
[Obsolete("Column re-creation now relies on `AutoGenerate` instead.")]
public bool ShouldGenerate { get; set; }

ShowExpandAll

Section titled "ShowExpandAll"

Gets/Sets whether the expand/collapse all button in the header should be rendered.

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

ShowSummaryOnCollapse

Section titled "ShowSummaryOnCollapse"

Controls whether the summary row is visible when groupBy/parent row is collapsed.

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

SnackbarDisplayTime

Section titled "SnackbarDisplayTime"

Gets/Sets the display time for the row adding snackbar notification.

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

SortAscendingHeaderIconTemplate

Section titled "SortAscendingHeaderIconTemplate"

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

 
[Parameter]
public RenderFragment<IgbGridHeaderTemplateContext> SortAscendingHeaderIconTemplate { get; set; }

SortAscendingHeaderIconTemplateScript

Section titled "SortAscendingHeaderIconTemplateScript"

Provides a means of setting SortAscendingHeaderIconTemplate in the JavaScript environment.

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

SortDescendingHeaderIconTemplate

Section titled "SortDescendingHeaderIconTemplate"

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

 
[Parameter]
public RenderFragment<IgbGridHeaderTemplateContext> SortDescendingHeaderIconTemplate { get; set; }

SortDescendingHeaderIconTemplateScript

Section titled "SortDescendingHeaderIconTemplateScript"

Provides a means of setting SortDescendingHeaderIconTemplate in the JavaScript environment.

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

SortHeaderIconTemplate

Section titled "SortHeaderIconTemplate"

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

 
[Parameter]
public RenderFragment<IgbGridHeaderTemplateContext> SortHeaderIconTemplate { get; set; }

SortHeaderIconTemplateScript

Section titled "SortHeaderIconTemplateScript"

Provides a means of setting SortHeaderIconTemplate in the JavaScript environment.

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

SortStrategy

Section titled "SortStrategy"

Gets/Sets the sorting strategy of the grid.

 
[Parameter]
public IgbGridSortingStrategy SortStrategy { get; set; }

SortingExpressions

Section titled "SortingExpressions"

Gets/Sets the sorting state.

 
[Parameter]
public IgbSortingExpression[] SortingExpressions { get; set; }

SortingOptions

Section titled "SortingOptions"

Gets/Sets the sorting options - single or multiple sorting. Accepts an ISortingOptions object with any of the mode properties.

 
[Parameter]
public IgbSortingOptions SortingOptions { get; set; }

SummaryCalculationMode

Section titled "SummaryCalculationMode"

Gets/Sets the summary calculation mode.

 
[Parameter]
public GridSummaryCalculationMode SummaryCalculationMode { get; set; }

SummaryPosition

Section titled "SummaryPosition"

Gets/Sets the summary position.

 
[Parameter]
public GridSummaryPosition SummaryPosition { get; set; }

SummaryRowHeight

Section titled "SummaryRowHeight"

Get/Set IgxSummaryRow height

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

Toolbar

Section titled "Toolbar" 
public IgbGridToolbarCollection Toolbar { get; protected set; }

TotalRecords

Section titled "TotalRecords"

Returns the total number of records.

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

Type

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

ValidationTrigger

Section titled "ValidationTrigger"

Gets/Sets the trigger for validators used when editing the grid.

 
[Parameter]
public GridValidationTrigger ValidationTrigger { get; set; }

Width

Section titled "Width"

Gets/Sets the width of the grid.

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

Accessors

Section titled "Accessors"

_name

Section titled "_name"

Inherited from: BaseRendererElement 

protected string _name

eventCallbacksCache

Section titled "eventCallbacksCache"

Inherited from: BaseRendererElement 

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

_cachedSerializedContent

Section titled "_cachedSerializedContent"

Inherited from: BaseRendererElement 

protected string _cachedSerializedContent

Methods

Section titled "Methods"

BuildRenderTree(RenderTreeBuilder)

Section titled "BuildRenderTree(RenderTreeBuilder)"

Inherited from: BaseRendererElement 

protected override void BuildRenderTree(RenderTreeBuilder builder)

Parameters

  • builder: RenderTreeBuilder

Returns any

OnElementNameChanged(BaseRendererElement, string, string)

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

Inherited from: BaseRendererElement 

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

Parameters

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

Returns any

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

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

Inherited from: BaseRendererElement 

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

Parameters

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

Returns any

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

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

Inherited from: BaseRendererElement 

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

Parameters

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

Returns any

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

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

Inherited from: BaseRendererElement 

protected Task<object> InvokeMethodHelper(string target, string methodName, object[] arguments, string[] types, ElementReference[] nativeElements)

Parameters

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

Returns any

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

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

Inherited from: BaseRendererElement 

protected object InvokeMethodHelperSync(string target, string methodName, object[] arguments, string[] types, ElementReference[] nativeElements)

Parameters

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

Returns any

IsPropDirty(string)

Section titled "IsPropDirty(string)"

Inherited from: BaseRendererElement 

protected bool IsPropDirty(string propertyName)

Parameters

  • propertyName: string

Returns any

Serialize(SerializationContext, string)

Section titled "Serialize(SerializationContext, string)"

Inherited from: BaseRendererElement 

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

Parameters

  • context: SerializationContext
  • propertyName: string

Returns any

Serialize()

Section titled "Serialize()"

Inherited from: BaseRendererElement 

public string Serialize()

Returns any

EnsureValid()

Section titled "EnsureValid()"

Inherited from: BaseRendererElement 

protected void EnsureValid()

Returns any

FromEventJson(BaseRendererControl, Dictionary<string, object>)

Section titled "FromEventJson(BaseRendererControl, Dictionary<string, object>)"

Inherited from: BaseRendererElement 

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

Parameters

  • control: BaseRendererControl
  • args: Dictionary

Returns any

ToEventJson(BaseRendererControl, Dictionary<string, object>)

Section titled "ToEventJson(BaseRendererControl, Dictionary<string, object>)"

Inherited from: BaseRendererElement 

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

Parameters

  • control: BaseRendererControl
  • args: Dictionary

Returns any

SetResourceStringAsync(string, string, string)

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

Inherited from: BaseRendererElement 

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

Parameters

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

Returns any

SetResourceStringAsync(string, string)

Section titled "SetResourceStringAsync(string, string)"

Inherited from: BaseRendererElement 

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

Parameters

  • grouping: string
  • json: string

Returns any

BeginAddRowById(object, bool)

Section titled "BeginAddRowById(object, bool)" 
public void BeginAddRowById(object rowID, bool asChild = false)

Parameters

  • rowID: object
  • asChild: bool

Returns any

BeginAddRowByIdAsync(object, bool)

Section titled "BeginAddRowByIdAsync(object, bool)" 
public Task BeginAddRowByIdAsync(object rowID, bool asChild = false)

Parameters

  • rowID: object
  • asChild: bool

Returns any

ClearCellSelection()

Section titled "ClearCellSelection()" 
public void ClearCellSelection()

Returns any

ClearCellSelectionAsync()

Section titled "ClearCellSelectionAsync()"

Deselect selected cells.

public Task ClearCellSelectionAsync()

Returns any

ClearFilter(string)

Section titled "ClearFilter(string)" 
public void ClearFilter(string name = null)

Parameters

  • name: string

Returns any

ClearFilterAsync(string)

Section titled "ClearFilterAsync(string)"

If name is provided, clears the filtering state of the corresponding IgxColumnComponent. name

public Task ClearFilterAsync(string name = null)

Parameters

  • name: string

Returns any

ClearSearch()

Section titled "ClearSearch()" 
public void ClearSearch()

Returns any

ClearSearchAsync()

Section titled "ClearSearchAsync()"

Removes all the highlights in the cell.

public Task ClearSearchAsync()

Returns any

ClearSort(string)

Section titled "ClearSort(string)" 
public void ClearSort(string name = null)

Parameters

  • name: string

Returns any

ClearSortAsync(string)

Section titled "ClearSortAsync(string)"

If name is provided, clears the sorting state of the corresponding IgxColumnComponent. name

public Task ClearSortAsync(string name = null)

Parameters

  • name: string

Returns any

CloseAdvancedFilteringDialog(bool)

Section titled "CloseAdvancedFilteringDialog(bool)" 
public void CloseAdvancedFilteringDialog(bool applyChanges)

Parameters

  • applyChanges: bool

Returns any

CloseAdvancedFilteringDialogAsync(bool)

Section titled "CloseAdvancedFilteringDialogAsync(bool)"

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

public Task CloseAdvancedFilteringDialogAsync(bool applyChanges)

Parameters

  • applyChanges: bool

Returns any

CollapseAll()

Section titled "CollapseAll()" 
public void CollapseAll()

Returns any

CollapseAllAsync()

Section titled "CollapseAllAsync()"

Collapses all rows.

public Task CollapseAllAsync()

Returns any

CollapseRow(object)

Section titled "CollapseRow(object)" 
public void CollapseRow(object rowID)

Parameters

  • rowID: object

Returns any

CollapseRowAsync(object)

Section titled "CollapseRowAsync(object)"

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

public Task CollapseRowAsync(object rowID)

Parameters

  • rowID: object

Returns any

DeselectAllColumns()

Section titled "DeselectAllColumns()" 
public void DeselectAllColumns()

Returns any

DeselectAllColumnsAsync()

Section titled "DeselectAllColumnsAsync()"

Deselects all columns

public Task DeselectAllColumnsAsync()

Returns any

DeselectAllRows(bool)

Section titled "DeselectAllRows(bool)" 
public void DeselectAllRows(bool onlyFilterData = false)

Parameters

  • onlyFilterData: bool

Returns any

DeselectAllRowsAsync(bool)

Section titled "DeselectAllRowsAsync(bool)"

Deselects all rows onlyFilterData

public Task DeselectAllRowsAsync(bool onlyFilterData = false)

Parameters

  • onlyFilterData: bool

Returns any

DeselectColumns(string[])

Section titled "DeselectColumns(string[])" 
public void DeselectColumns(string[] columns)

Parameters

  • columns: string[]

Returns any

DeselectColumnsAsync(string[])

Section titled "DeselectColumnsAsync(string[])" 
public Task DeselectColumnsAsync(string[] columns)

Parameters

  • columns: string[]

Returns any

DeselectRows(object[])

Section titled "DeselectRows(object[])" 
public void DeselectRows(object[] rowIDs)

Parameters

  • rowIDs: object[]

Returns any

DeselectRowsAsync(object[])

Section titled "DeselectRowsAsync(object[])" 
public Task DeselectRowsAsync(object[] rowIDs)

Parameters

  • rowIDs: object[]

Returns any

DisableSummaries(object[])

Section titled "DisableSummaries(object[])" 
public void DisableSummaries(object[] rest)

Parameters

  • rest: object[]

Returns any

DisableSummariesAsync(object[])

Section titled "DisableSummariesAsync(object[])" 
public Task DisableSummariesAsync(object[] rest)

Parameters

  • rest: object[]

Returns any

Dispose()

Section titled "Dispose()" 
public void Dispose()

Returns any

EnableSummaries(object[])

Section titled "EnableSummaries(object[])" 
public void EnableSummaries(object[] rest)

Parameters

  • rest: object[]

Returns any

EnableSummariesAsync(object[])

Section titled "EnableSummariesAsync(object[])" 
public Task EnableSummariesAsync(object[] rest)

Parameters

  • rest: object[]

Returns any

EnsureModulesLoaded()

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

Returns any

ExpandAll()

Section titled "ExpandAll()" 
public void ExpandAll()

Returns any

ExpandAllAsync()

Section titled "ExpandAllAsync()"

Expands all rows.

public Task ExpandAllAsync()

Returns any

ExpandRow(object)

Section titled "ExpandRow(object)" 
public void ExpandRow(object rowID)

Parameters

  • rowID: object

Returns any

ExpandRowAsync(object)

Section titled "ExpandRowAsync(object)"

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

public Task ExpandRowAsync(object rowID)

Parameters

  • rowID: object

Returns any

Filter(string, object, IgbFilteringExpressionsTreeOrFilteringOperation, bool)

Section titled "Filter(string, object, IgbFilteringExpressionsTreeOrFilteringOperation, bool)" 
public void Filter(string name, object value, IgbFilteringExpressionsTreeOrFilteringOperation conditionOrExpressionTree, bool ignoreCase = false)

Parameters

  • name: string
  • value: object
  • conditionOrExpressionTree: IgbFilteringExpressionsTreeOrFilteringOperation
  • ignoreCase: bool

Returns any

FilterAsync(string, object, IgbFilteringExpressionsTreeOrFilteringOperation, bool)

Section titled "FilterAsync(string, object, IgbFilteringExpressionsTreeOrFilteringOperation, bool)" 
public Task FilterAsync(string name, object value, IgbFilteringExpressionsTreeOrFilteringOperation conditionOrExpressionTree, bool ignoreCase = false)

Parameters

  • name: string
  • value: object
  • conditionOrExpressionTree: IgbFilteringExpressionsTreeOrFilteringOperation
  • ignoreCase: bool

Returns any

FilterGlobal(object, object, object)

Section titled "FilterGlobal(object, object, object)" 
public void FilterGlobal(object value, object condition, object ignoreCase)

Parameters

  • value: object
  • condition: object
  • ignoreCase: object

Returns any

FilterGlobalAsync(object, object, object)

Section titled "FilterGlobalAsync(object, object, object)" 
public Task FilterGlobalAsync(object value, object condition, object ignoreCase)

Parameters

  • value: object
  • condition: object
  • ignoreCase: object

Returns any

FindByName(string)

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

Parameters

  • name: string

Returns any

FindNext(string, bool, bool)

Section titled "FindNext(string, bool, bool)" 
public double FindNext(string text, bool caseSensitive = false, bool exactMatch = false)

Parameters

  • text: string
  • caseSensitive: bool
  • exactMatch: bool

Returns any

FindNextAsync(string, bool, bool)

Section titled "FindNextAsync(string, bool, bool)" 
public Task<double> FindNextAsync(string text, bool caseSensitive = false, bool exactMatch = false)

Parameters

  • text: string
  • caseSensitive: bool
  • exactMatch: bool

Returns any

FindPrev(string, bool, bool)

Section titled "FindPrev(string, bool, bool)" 
public double FindPrev(string text, bool caseSensitive = false, bool exactMatch = false)

Parameters

  • text: string
  • caseSensitive: bool
  • exactMatch: bool

Returns any

FindPrevAsync(string, bool, bool)

Section titled "FindPrevAsync(string, bool, bool)" 
public Task<double> FindPrevAsync(string text, bool caseSensitive = false, bool exactMatch = false)

Parameters

  • text: string
  • caseSensitive: bool
  • exactMatch: bool

Returns any

GetColumnByName(string)

Section titled "GetColumnByName(string)" 
public IgbColumn GetColumnByName(string name)

Parameters

  • name: string

Returns any

GetColumnByNameAsync(string)

Section titled "GetColumnByNameAsync(string)"

Returns the IgxColumnComponent by field name. name

public Task<IgbColumn> GetColumnByNameAsync(string name)

Parameters

  • name: string

Returns any

GetColumnByVisibleIndex(double)

Section titled "GetColumnByVisibleIndex(double)" 
public IgbColumn GetColumnByVisibleIndex(double index)

Parameters

  • index: double

Returns any

GetColumnByVisibleIndexAsync(double)

Section titled "GetColumnByVisibleIndexAsync(double)" 
public Task<IgbColumn> GetColumnByVisibleIndexAsync(double index)

Parameters

  • index: double

Returns any

GetColumns()

Section titled "GetColumns()" 
public IgbColumn[] GetColumns()

Returns any

GetColumnsAsync()

Section titled "GetColumnsAsync()" 
public Task<IgbColumn[]> GetColumnsAsync()

Returns any

GetCurrentSelectedRows()

Section titled "GetCurrentSelectedRows()" 
public object[] GetCurrentSelectedRows()

Returns any

GetCurrentSelectedRowsAsync()

Section titled "GetCurrentSelectedRowsAsync()" 
public Task<object[]> GetCurrentSelectedRowsAsync()

Returns any

GetDefaultRowHeight()

Section titled "GetDefaultRowHeight()" 
public double GetDefaultRowHeight()

Returns any

GetDefaultRowHeightAsync()

Section titled "GetDefaultRowHeightAsync()" 
public Task<double> GetDefaultRowHeightAsync()

Returns any

GetHeaderGroupWidth(IgbColumn)

Section titled "GetHeaderGroupWidth(IgbColumn)" 
public string GetHeaderGroupWidth(IgbColumn column)

Parameters

  • column: IgbColumn

Returns any

GetHeaderGroupWidthAsync(IgbColumn)

Section titled "GetHeaderGroupWidthAsync(IgbColumn)"

Gets the width to be set on IgxGridHeaderGroupComponent.

public Task<string> GetHeaderGroupWidthAsync(IgbColumn column)

Parameters

  • column: IgbColumn

Returns any

GetNextCell(double, double, object)

Section titled "GetNextCell(double, double, object)" 
public IgbCellPosition GetNextCell(double currRowIndex, double curVisibleColIndex, object callback)

Parameters

  • currRowIndex: double
  • curVisibleColIndex: double
  • callback: object

Returns any

GetNextCellAsync(double, double, object)

Section titled "GetNextCellAsync(double, double, object)" 
public Task<IgbCellPosition> GetNextCellAsync(double currRowIndex, double curVisibleColIndex, object callback)

Parameters

  • currRowIndex: double
  • curVisibleColIndex: double
  • callback: object

Returns any

GetPinnedEndWidth(bool)

Section titled "GetPinnedEndWidth(bool)" 
public void GetPinnedEndWidth(bool takeHidden = false)

Parameters

  • takeHidden: bool

Returns any

GetPinnedEndWidthAsync(bool)

Section titled "GetPinnedEndWidthAsync(bool)"

Gets calculated width of the pinned areas. takeHidden If we should take into account the hidden columns in the pinned area.

public Task GetPinnedEndWidthAsync(bool takeHidden = false)

Parameters

  • takeHidden: bool

Returns any

GetPinnedStartWidth(bool)

Section titled "GetPinnedStartWidth(bool)" 
public void GetPinnedStartWidth(bool takeHidden = false)

Parameters

  • takeHidden: bool

Returns any

GetPinnedStartWidthAsync(bool)

Section titled "GetPinnedStartWidthAsync(bool)"

Gets calculated width of the pinned areas. takeHidden If we should take into account the hidden columns in the pinned area.

public Task GetPinnedStartWidthAsync(bool takeHidden = false)

Parameters

  • takeHidden: bool

Returns any

GetPreviousCell(double, double, object)

Section titled "GetPreviousCell(double, double, object)" 
public IgbCellPosition GetPreviousCell(double currRowIndex, double curVisibleColIndex, object callback)

Parameters

  • currRowIndex: double
  • curVisibleColIndex: double
  • callback: object

Returns any

GetPreviousCellAsync(double, double, object)

Section titled "GetPreviousCellAsync(double, double, object)" 
public Task<IgbCellPosition> GetPreviousCellAsync(double currRowIndex, double curVisibleColIndex, object callback)

Parameters

  • currRowIndex: double
  • curVisibleColIndex: double
  • callback: object

Returns any

GetRowData(object)

Section titled "GetRowData(object)" 
public object GetRowData(object rowSelector)

Parameters

  • rowSelector: object

Returns any

GetRowDataAsync(object)

Section titled "GetRowDataAsync(object)"

Returns the data that is contained in the row component. rowSelector correspond to rowID

public Task<object> GetRowDataAsync(object rowSelector)

Parameters

  • rowSelector: object

Returns any

GetSelectedColumnsData(bool, bool)

Section titled "GetSelectedColumnsData(bool, bool)" 
public void GetSelectedColumnsData(bool formatters = false, bool headers = false)

Parameters

  • formatters: bool
  • headers: bool

Returns any

GetSelectedColumnsDataAsync(bool, bool)

Section titled "GetSelectedColumnsDataAsync(bool, bool)" 
public Task GetSelectedColumnsDataAsync(bool formatters = false, bool headers = false)

Parameters

  • formatters: bool
  • headers: bool

Returns any

GetSelectedData(bool, bool)

Section titled "GetSelectedData(bool, bool)" 
public void GetSelectedData(bool formatters = false, bool headers = false)

Parameters

  • formatters: bool
  • headers: bool

Returns any

GetSelectedDataAsync(bool, bool)

Section titled "GetSelectedDataAsync(bool, bool)" 
public Task GetSelectedDataAsync(bool formatters = false, bool headers = false)

Parameters

  • formatters: bool
  • headers: bool

Returns any

GetSelectedRanges()

Section titled "GetSelectedRanges()" 
public IgbGridSelectionRange[] GetSelectedRanges()

Returns any

GetSelectedRangesAsync()

Section titled "GetSelectedRangesAsync()"

Get the currently selected ranges in the grid.

public Task<IgbGridSelectionRange[]> GetSelectedRangesAsync()

Returns any

IsRecordPinnedByIndex(double)

Section titled "IsRecordPinnedByIndex(double)" 
public void IsRecordPinnedByIndex(double rowIndex)

Parameters

  • rowIndex: double

Returns any

IsRecordPinnedByIndexAsync(double)

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

  • rowIndex: double

Returns any

MarkForCheck()

Section titled "MarkForCheck()" 
public void MarkForCheck()

Returns any

MarkForCheckAsync()

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

public Task MarkForCheckAsync()

Returns any

MoveColumn(IgbColumn, IgbColumn, DropPosition?)

Section titled "MoveColumn(IgbColumn, IgbColumn, DropPosition?)" 
public void MoveColumn(IgbColumn column, IgbColumn target, DropPosition? pos = null)

Parameters

  • column: IgbColumn
  • target: IgbColumn
  • pos: DropPosition?

Returns any

MoveColumnAsync(IgbColumn, IgbColumn, DropPosition?)

Section titled "MoveColumnAsync(IgbColumn, IgbColumn, DropPosition?)" 
public Task MoveColumnAsync(IgbColumn column, IgbColumn target, DropPosition? pos = null)

Parameters

  • column: IgbColumn
  • target: IgbColumn
  • pos: DropPosition?

Returns any

Section titled "NavigateTo(double, double, object)" 
public void NavigateTo(double rowIndex, double visibleColIndex, object cb)

Parameters

  • rowIndex: double
  • visibleColIndex: double
  • cb: object

Returns any

Section titled "NavigateToAsync(double, double, object)" 
public Task NavigateToAsync(double rowIndex, double visibleColIndex, object cb)

Parameters

  • rowIndex: double
  • visibleColIndex: double
  • cb: object

Returns any

OnInitializedAsync()

Section titled "OnInitializedAsync()" 
protected override Task OnInitializedAsync()

Returns any

OpenAdvancedFilteringDialog(IgbOverlaySettings)

Section titled "OpenAdvancedFilteringDialog(IgbOverlaySettings)" 
public void OpenAdvancedFilteringDialog(IgbOverlaySettings overlaySettings)

Parameters

  • overlaySettings: IgbOverlaySettings

Returns any

OpenAdvancedFilteringDialogAsync(IgbOverlaySettings)

Section titled "OpenAdvancedFilteringDialogAsync(IgbOverlaySettings)"

Opens the advanced filtering dialog.

public Task OpenAdvancedFilteringDialogAsync(IgbOverlaySettings overlaySettings)

Parameters

  • overlaySettings: IgbOverlaySettings

Returns any

PinColumn(string, double, ColumnPinningPosition?)

Section titled "PinColumn(string, double, ColumnPinningPosition?)" 
public bool PinColumn(string columnName, double index = -1, ColumnPinningPosition? pinningPosition = null)

Parameters

  • columnName: string
  • index: double
  • pinningPosition: ColumnPinningPosition?

Returns any

PinColumnAsync(string, double, ColumnPinningPosition?)

Section titled "PinColumnAsync(string, double, ColumnPinningPosition?)" 
public Task<bool> PinColumnAsync(string columnName, double index = -1, ColumnPinningPosition? pinningPosition = null)

Parameters

  • columnName: string
  • index: double
  • pinningPosition: ColumnPinningPosition?

Returns any

RecalculateAutoSizes()

Section titled "RecalculateAutoSizes()" 
public void RecalculateAutoSizes()

Returns any

RecalculateAutoSizesAsync()

Section titled "RecalculateAutoSizesAsync()"

Recalculates all widths of columns that have size set to auto.

public Task RecalculateAutoSizesAsync()

Returns any

RefreshSearch(bool, bool)

Section titled "RefreshSearch(bool, bool)" 
public double RefreshSearch(bool updateActiveInfo = false, bool endEdit = false)

Parameters

  • updateActiveInfo: bool
  • endEdit: bool

Returns any

RefreshSearchAsync(bool, bool)

Section titled "RefreshSearchAsync(bool, bool)" 
public Task<double> RefreshSearchAsync(bool updateActiveInfo = false, bool endEdit = false)

Parameters

  • updateActiveInfo: bool
  • endEdit: bool

Returns any

SelectAllColumns()

Section titled "SelectAllColumns()" 
public void SelectAllColumns()

Returns any

SelectAllColumnsAsync()

Section titled "SelectAllColumnsAsync()"

Selects all columns

public Task SelectAllColumnsAsync()

Returns any

SelectAllRows(bool)

Section titled "SelectAllRows(bool)" 
public void SelectAllRows(bool onlyFilterData = false)

Parameters

  • onlyFilterData: bool

Returns any

SelectAllRowsAsync(bool)

Section titled "SelectAllRowsAsync(bool)"

Selects all rows onlyFilterData

public Task SelectAllRowsAsync(bool onlyFilterData = false)

Parameters

  • onlyFilterData: bool

Returns any

SelectColumns(string[], bool)

Section titled "SelectColumns(string[], bool)" 
public void SelectColumns(string[] columns, bool clearCurrentSelection = false)

Parameters

  • columns: string[]
  • clearCurrentSelection: bool

Returns any

SelectColumnsAsync(string[], bool)

Section titled "SelectColumnsAsync(string[], bool)" 
public Task SelectColumnsAsync(string[] columns, bool clearCurrentSelection = false)

Parameters

  • columns: string[]
  • clearCurrentSelection: bool

Returns any

SelectRange(IgbGridSelectionRange[])

Section titled "SelectRange(IgbGridSelectionRange[])" 
public void SelectRange(IgbGridSelectionRange[] arg)

Parameters

  • arg: IgbGridSelectionRange[]

Returns any

SelectRangeAsync(IgbGridSelectionRange[])

Section titled "SelectRangeAsync(IgbGridSelectionRange[])" 
public Task SelectRangeAsync(IgbGridSelectionRange[] arg)

Parameters

  • arg: IgbGridSelectionRange[]

Returns any

SelectRows(object[], bool)

Section titled "SelectRows(object[], bool)" 
public void SelectRows(object[] rowIDs, bool clearCurrentSelection = false)

Parameters

  • rowIDs: object[]
  • clearCurrentSelection: bool

Returns any

SelectRowsAsync(object[], bool)

Section titled "SelectRowsAsync(object[], bool)" 
public Task SelectRowsAsync(object[] rowIDs, bool clearCurrentSelection = false)

Parameters

  • rowIDs: object[]
  • clearCurrentSelection: bool

Returns any

SelectedColumns()

Section titled "SelectedColumns()" 
public IgbColumn[] SelectedColumns()

Returns any

SelectedColumnsAsync()

Section titled "SelectedColumnsAsync()"

Get current selected columns.

public Task<IgbColumn[]> SelectedColumnsAsync()

Returns any

SetNativeElement(object)

Section titled "SetNativeElement(object)" 
public void SetNativeElement(object element)

Parameters

  • element: object

Returns any

SetNativeElementAsync(object)

Section titled "SetNativeElementAsync(object)" 
public Task SetNativeElementAsync(object element)

Parameters

  • element: object

Returns any

Sort(IgbSortingExpression[])

Section titled "Sort(IgbSortingExpression[])" 
public void Sort(IgbSortingExpression[] expression)

Parameters

  • expression: IgbSortingExpression[]

Returns any

SortAsync(IgbSortingExpression[])

Section titled "SortAsync(IgbSortingExpression[])" 
public Task SortAsync(IgbSortingExpression[] expression)

Parameters

  • expression: IgbSortingExpression[]

Returns any

ToggleColumnVisibility(IgbColumnVisibilityChangedEventArgs)

Section titled "ToggleColumnVisibility(IgbColumnVisibilityChangedEventArgs)" 
public void ToggleColumnVisibility(IgbColumnVisibilityChangedEventArgs args)

Parameters

  • args: IgbColumnVisibilityChangedEventArgs

Returns any

ToggleColumnVisibilityAsync(IgbColumnVisibilityChangedEventArgs)

Section titled "ToggleColumnVisibilityAsync(IgbColumnVisibilityChangedEventArgs)"

Toggles the specified column's visibility.

public Task ToggleColumnVisibilityAsync(IgbColumnVisibilityChangedEventArgs args)

Parameters

  • args: IgbColumnVisibilityChangedEventArgs

Returns any

ToggleRow(object)

Section titled "ToggleRow(object)" 
public void ToggleRow(object rowID)

Parameters

  • rowID: object

Returns any

ToggleRowAsync(object)

Section titled "ToggleRowAsync(object)"

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

public Task ToggleRowAsync(object rowID)

Parameters

  • rowID: object

Returns any

UnpinColumn(string, double)

Section titled "UnpinColumn(string, double)" 
public bool UnpinColumn(string columnName, double index = -1)

Parameters

  • columnName: string
  • index: double

Returns any

UnpinColumnAsync(string, double)

Section titled "UnpinColumnAsync(string, double)" 
public Task<bool> UnpinColumnAsync(string columnName, double index = -1)

Parameters

  • columnName: string
  • index: double

Returns any

Events

Section titled "Events"

ActiveNodeChange

Section titled "ActiveNodeChange" 
[Parameter]
public EventCallback<IgbActiveNodeChangeEventArgs> ActiveNodeChange { get; set; }

AdvancedFilteringExpressionsTreeChange

Section titled "AdvancedFilteringExpressionsTreeChange" 
[Parameter]
public EventCallback<IgbFilteringExpressionsTreeEventArgs> AdvancedFilteringExpressionsTreeChange { get; set; }

CellClick

Section titled "CellClick" 
[Parameter]
public EventCallback<IgbGridCellEventArgs> CellClick { get; set; }

CellEdit

Section titled "CellEdit" 
[Parameter]
public EventCallback<IgbGridEditEventArgs> CellEdit { get; set; }

CellEditEnter

Section titled "CellEditEnter" 
[Parameter]
public EventCallback<IgbGridEditEventArgs> CellEditEnter { get; set; }

CellEditExit

Section titled "CellEditExit" 
[Parameter]
public EventCallback<IgbGridEditDoneEventArgs> CellEditExit { get; set; }

ChildrenResolved

Section titled "ChildrenResolved" 
[Parameter]
public EventCallback<IgbVoidEventArgs> ChildrenResolved { get; set; }

ColumnInit

Section titled "ColumnInit" 
[Parameter]
public EventCallback<IgbColumnComponentEventArgs> ColumnInit { get; set; }

ColumnMoving

Section titled "ColumnMoving" 
[Parameter]
public EventCallback<IgbColumnMovingEventArgs> ColumnMoving { get; set; }

ColumnMovingEnd

Section titled "ColumnMovingEnd" 
[Parameter]
public EventCallback<IgbColumnMovingEndEventArgs> ColumnMovingEnd { get; set; }

ColumnMovingStart

Section titled "ColumnMovingStart" 
[Parameter]
public EventCallback<IgbColumnMovingStartEventArgs> ColumnMovingStart { get; set; }

ColumnPin

Section titled "ColumnPin" 
[Parameter]
public EventCallback<IgbPinColumnCancellableEventArgs> ColumnPin { get; set; }

ColumnPinned

Section titled "ColumnPinned" 
[Parameter]
public EventCallback<IgbPinColumnEventArgs> ColumnPinned { get; set; }

ColumnResized

Section titled "ColumnResized" 
[Parameter]
public EventCallback<IgbColumnResizeEventArgs> ColumnResized { get; set; }

ColumnSelectionChanging

Section titled "ColumnSelectionChanging" 
[Parameter]
public EventCallback<IgbColumnSelectionEventArgs> ColumnSelectionChanging { get; set; }

ColumnVisibilityChanged

Section titled "ColumnVisibilityChanged" 
[Parameter]
public EventCallback<IgbColumnVisibilityChangedEventArgs> ColumnVisibilityChanged { get; set; }

ColumnVisibilityChanging

Section titled "ColumnVisibilityChanging" 
[Parameter]
public EventCallback<IgbColumnVisibilityChangingEventArgs> ColumnVisibilityChanging { get; set; }

ColumnsAutogenerated

Section titled "ColumnsAutogenerated" 
[Parameter]
public EventCallback<IgbColumnsAutoGeneratedEventArgs> ColumnsAutogenerated { get; set; }

ContextMenu

Section titled "ContextMenu" 
[Parameter]
public EventCallback<IgbGridContextMenuEventArgs> ContextMenu { get; set; }

DataChanged

Section titled "DataChanged" 
[Parameter]
public EventCallback<IgbForOfDataChangeEventArgs> DataChanged { get; set; }

DataChanging

Section titled "DataChanging" 
[Parameter]
public EventCallback<IgbForOfDataChangeEventArgs> DataChanging { get; set; }

DataPreLoad

Section titled "DataPreLoad" 
[Parameter]
public EventCallback<IgbForOfStateEventArgs> DataPreLoad { get; set; }

DoubleClick

Section titled "DoubleClick" 
[Parameter]
public EventCallback<IgbGridCellEventArgs> DoubleClick { get; set; }

Filtering

Section titled "Filtering" 
[Parameter]
public EventCallback<IgbFilteringEventArgs> Filtering { get; set; }

FilteringDone

Section titled "FilteringDone" 
[Parameter]
public EventCallback<IgbFilteringExpressionsTreeEventArgs> FilteringDone { get; set; }

FilteringExpressionsTreeChange

Section titled "FilteringExpressionsTreeChange" 
[Parameter]
public EventCallback<IgbFilteringExpressionsTreeEventArgs> FilteringExpressionsTreeChange { get; set; }

FormGroupCreated

Section titled "FormGroupCreated" 
[Parameter]
public EventCallback<IgbGridFormGroupCreatedEventArgs> FormGroupCreated { get; set; }

GridCopy

Section titled "GridCopy" 
[Parameter]
public EventCallback<IgbGridClipboardEventEventArgs> GridCopy { get; set; }

GridCreated

Section titled "GridCreated" 
[Parameter]
public EventCallback<IgbGridCreatedEventArgs> GridCreated { get; set; }

GridInitialized

Section titled "GridInitialized" 
[Parameter]
public EventCallback<IgbGridCreatedEventArgs> GridInitialized { get; set; }

GridKeydown

Section titled "GridKeydown" 
[Parameter]
public EventCallback<IgbGridKeydownEventArgs> GridKeydown { get; set; }

GridScroll

Section titled "GridScroll" 
[Parameter]
public EventCallback<IgbGridScrollEventArgs> GridScroll { get; set; }

RangeSelected

Section titled "RangeSelected" 
[Parameter]
public EventCallback<IgbGridSelectionRangeEventArgs> RangeSelected { get; set; }

Rendered

Section titled "Rendered" 
[Parameter]
public EventCallback<IgbComponentBoolValueChangedEventArgs> Rendered { get; set; }

RowAdd

Section titled "RowAdd" 
[Parameter]
public EventCallback<IgbRowDataCancelableEventArgs> RowAdd { get; set; }

RowClick

Section titled "RowClick" 
[Parameter]
public EventCallback<IgbGridRowEventArgs> RowClick { get; set; }

RowDelete

Section titled "RowDelete" 
[Parameter]
public EventCallback<IgbRowDataCancelableEventArgs> RowDelete { get; set; }

RowDragEnd

Section titled "RowDragEnd" 
[Parameter]
public EventCallback<IgbRowDragEndEventArgs> RowDragEnd { get; set; }

RowDragStart

Section titled "RowDragStart" 
[Parameter]
public EventCallback<IgbRowDragStartEventArgs> RowDragStart { get; set; }

RowEdit

Section titled "RowEdit" 
[Parameter]
public EventCallback<IgbGridEditEventArgs> RowEdit { get; set; }

RowEditDone

Section titled "RowEditDone" 
[Parameter]
public EventCallback<IgbGridEditDoneEventArgs> RowEditDone { get; set; }

RowEditEnter

Section titled "RowEditEnter" 
[Parameter]
public EventCallback<IgbGridEditEventArgs> RowEditEnter { get; set; }

RowEditExit

Section titled "RowEditExit" 
[Parameter]
public EventCallback<IgbGridEditDoneEventArgs> RowEditExit { get; set; }

RowPinned

Section titled "RowPinned" 
[Parameter]
public EventCallback<IgbPinRowEventArgs> RowPinned { get; set; }

RowPinning

Section titled "RowPinning" 
[Parameter]
public EventCallback<IgbPinRowEventArgs> RowPinning { get; set; }

RowSelectionChanging

Section titled "RowSelectionChanging" 
[Parameter]
public EventCallback<IgbRowSelectionEventArgs> RowSelectionChanging { get; set; }

RowToggle

Section titled "RowToggle" 
[Parameter]
public EventCallback<IgbRowToggleEventArgs> RowToggle { get; set; }

Selected

Section titled "Selected" 
[Parameter]
public EventCallback<IgbGridCellEventArgs> Selected { get; set; }

SelectedRowsChange

Section titled "SelectedRowsChange" 
[Parameter]
public EventCallback<IgbComponentArrayDataValueChangedEventArgs> SelectedRowsChange { get; set; }

SelectedRowsChanged

Section titled "SelectedRowsChanged" 
[Parameter]
public EventCallback<object[]> SelectedRowsChanged { get; set; }

Sorting

Section titled "Sorting" 
[Parameter]
public EventCallback<IgbSortingEventArgs> Sorting { get; set; }

SortingDone

Section titled "SortingDone" 
[Parameter]
public EventCallback<IgbSortingExpressionEventArgs> SortingDone { get; set; }

SortingExpressionsChange

Section titled "SortingExpressionsChange" 
[Parameter]
public EventCallback<IgbSortingExpressionEventArgs> SortingExpressionsChange { get; set; }

ToolbarExporting

Section titled "ToolbarExporting" 
[Parameter]
public EventCallback<IgbGridToolbarExportEventArgs> ToolbarExporting { get; set; }

ValidationStatusChange

Section titled "ValidationStatusChange" 
[Parameter]
public EventCallback<IgbGridValidationStatusEventArgs> ValidationStatusChange { get; set; }

ActiveNodeChangeScript

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

AdvancedFilteringExpressionsTreeChangeScript

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

CellClickScript

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

CellEditEnterScript

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

CellEditExitScript

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

CellEditScript

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

ChildrenResolvedScript

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

ColumnInitScript

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

ColumnMovingEndScript

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

ColumnMovingScript

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

ColumnMovingStartScript

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

ColumnPinScript

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

ColumnPinnedScript

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

ColumnResizedScript

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

ColumnSelectionChangingScript

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

ColumnVisibilityChangedScript

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

ColumnVisibilityChangingScript

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

ColumnsAutogeneratedScript

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

ContextMenuScript

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

DataChangedScript

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

DataChangingScript

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

DataPreLoadScript

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

DoubleClickScript

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

FilteringDoneScript

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

FilteringExpressionsTreeChangeScript

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

FilteringScript

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

FormGroupCreatedScript

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

GridCopyScript

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

GridCreatedScript

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

GridInitializedScript

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

GridKeydownScript

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

GridScrollScript

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

RangeSelectedScript

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

RenderedScript

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

RowAddScript

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

RowClickScript

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

RowDeleteScript

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

RowDragEndScript

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

RowDragStartScript

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

RowEditDoneScript

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

RowEditEnterScript

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

RowEditExitScript

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

RowEditScript

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

RowPinnedScript

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

RowPinningScript

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

RowSelectionChangingScript

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

RowToggleScript

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

SelectedRowsChangeScript

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

SelectedScript

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

SortingDoneScript

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

SortingExpressionsChangeScript

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

SortingScript

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

ToolbarExportingScript

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

ValidationStatusChangeScript

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