Ignite UI for Angular Tree Grid - Documentation The Ignite UI Tree Grid displays and manipulates hierarchical data with consistent schema formatted as a table and provides features such as sorting, filtering, editing, column pinning, paging, column moving and hiding. Example:
Inheritance
object
ComponentBase
- IComponent
- IHandleEvent
- IHandleAfterRender
- JsonSerializable
- IDisposable
Constructors
Section titled "Constructors"constructor
public IgbTreeGrid()Returns IgbTreeGrid
Properties
Section titled "Properties"NeedsDynamicContent
Section titled "NeedsDynamicContent"Inherited from: IgbGridBaseDirective
protected override bool NeedsDynamicContent { get; }ContentColumnList
Section titled "ContentColumnList"Inherited from: IgbGridBaseDirective
public IgbColumnCollection ContentColumnList { get; }CellEditDone
Section titled "CellEditDone"Inherited from: IgbGridBaseDirective
[Parameter]
public Action<IgbGridEditDoneEventArgs> CellEditDone { get; set; }RowAdded
Section titled "RowAdded"Inherited from: IgbGridBaseDirective
[Parameter]
public Action<IgbRowDataEventArgs> RowAdded { get; set; }ItemRequested
Section titled "ItemRequested"Inherited from: IgbGridBaseDirective
[Parameter]
public Action<IgbItemRequestedEventArgs> ItemRequested { get; set; }RowDeleted
Section titled "RowDeleted"Inherited from: IgbGridBaseDirective
[Parameter]
public Action<IgbRowDataEventArgs> RowDeleted { get; set; }DefaultEventBehavior
Section titled "DefaultEventBehavior"Inherited from: IgbGridBaseDirective
Gets the components default event behavior.
protected override ControlEventBehavior DefaultEventBehavior { get; }ParentTypeName
Section titled "ParentTypeName"Inherited from: IgbGridBaseDirective
protected override string ParentTypeName { get; }ContentActionStripComponents
Section titled "ContentActionStripComponents"Inherited from: IgbGridBaseDirective
public IgbActionStripCollection ContentActionStripComponents { get; }ActualActionStripComponents
Section titled "ActualActionStripComponents"Inherited from: IgbGridBaseDirective
public IgbActionStripCollection ActualActionStripComponents { get; }ContentToolbar
Section titled "ContentToolbar"Inherited from: IgbGridBaseDirective
public IgbGridToolbarCollection ContentToolbar { get; }ActualToolbar
Section titled "ActualToolbar"Inherited from: IgbGridBaseDirective
public IgbGridToolbarCollection ActualToolbar { get; }ContentPaginationComponents
Section titled "ContentPaginationComponents"Inherited from: IgbGridBaseDirective
public IgbPaginatorCollection ContentPaginationComponents { get; }ActualPaginationComponents
Section titled "ActualPaginationComponents"Inherited from: IgbGridBaseDirective
public IgbPaginatorCollection ActualPaginationComponents { get; }ContentStateComponents
Section titled "ContentStateComponents"Inherited from: IgbGridBaseDirective
public IgbStateCollection ContentStateComponents { get; }ActualStateComponents
Section titled "ActualStateComponents"Inherited from: IgbGridBaseDirective
public IgbStateCollection ActualStateComponents { get; }SnackbarDisplayTime
Section titled "SnackbarDisplayTime"Inherited from: IgbGridBaseDirective
Gets/Sets the display time for the row adding snackbar notification.
[Parameter]
public double SnackbarDisplayTime { get; set; }AutoGenerate
Section titled "AutoGenerate"Inherited from: IgbGridBaseDirective
Gets/Sets whether to auto-generate the columns.
[Parameter]
public bool AutoGenerate { get; set; }AutoGenerateExclude
Section titled "AutoGenerateExclude"Inherited from: IgbGridBaseDirective
Gets/Sets a list of property keys to be excluded from the generated column collection
[Parameter]
public string[] AutoGenerateExclude { get; set; }Moving
Section titled "Moving"Inherited from: IgbGridBaseDirective
Controls whether columns moving is enabled in the grid.
[Parameter]
public bool Moving { get; set; }EmptyGridTemplate
Section titled "EmptyGridTemplate"Inherited from: IgbGridBaseDirective
Gets/Sets a custom template when empty.
[Parameter]
public RenderFragment<IgbGridTemplateContext> EmptyGridTemplate { get; set; }EmptyGridTemplateScript
Section titled "EmptyGridTemplateScript"Inherited from: IgbGridBaseDirective
Provides a means of setting EmptyGridTemplate in the JavaScript environment.
[Parameter]
public string EmptyGridTemplateScript { get; set; }AddRowEmptyTemplate
Section titled "AddRowEmptyTemplate"Inherited from: IgbGridBaseDirective
Gets/Sets a custom template for adding row UI when grid is empty.
[Parameter]
public RenderFragment<object> AddRowEmptyTemplate { get; set; }AddRowEmptyTemplateScript
Section titled "AddRowEmptyTemplateScript"Inherited from: IgbGridBaseDirective
Provides a means of setting AddRowEmptyTemplate in the JavaScript environment.
[Parameter]
public string AddRowEmptyTemplateScript { get; set; }LoadingGridTemplate
Section titled "LoadingGridTemplate"Inherited from: IgbGridBaseDirective
Gets/Sets a custom template when loading.
[Parameter]
public RenderFragment<IgbGridTemplateContext> LoadingGridTemplate { get; set; }LoadingGridTemplateScript
Section titled "LoadingGridTemplateScript"Inherited from: IgbGridBaseDirective
Provides a means of setting LoadingGridTemplate in the JavaScript environment.
[Parameter]
public string LoadingGridTemplateScript { get; set; }SummaryRowHeight
Section titled "SummaryRowHeight"Inherited from: IgbGridBaseDirective
Get/Set IgxSummaryRow height
[Parameter]
public double SummaryRowHeight { get; set; }DataCloneStrategy
Section titled "DataCloneStrategy"Inherited from: IgbGridBaseDirective
Gets/Sets the data clone strategy of the grid when in edit mode.
[Parameter]
public IgbDataCloneStrategy DataCloneStrategy { get; set; }ClipboardOptions
Section titled "ClipboardOptions"Inherited from: IgbGridBaseDirective
Controls the copy behavior of the grid.
[Parameter]
public IgbClipboardOptions ClipboardOptions { get; set; }RowClasses
Section titled "RowClasses"Inherited from: IgbGridBaseDirective
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"Inherited from: IgbGridBaseDirective
Provides a means of setting RowClasses in the JavaScript environment.
[Parameter]
public string RowClassesScript { get; set; }RowStyles
Section titled "RowStyles"Inherited from: IgbGridBaseDirective
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"Inherited from: IgbGridBaseDirective
Provides a means of setting RowStyles in the JavaScript environment.
[Parameter]
public string RowStylesScript { get; set; }PrimaryKey
Section titled "PrimaryKey"Inherited from: IgbGridBaseDirective
Gets/Sets the primary key.
[Parameter]
public string PrimaryKey { get; set; }ColumnList
Section titled "ColumnList"Inherited from: IgbGridBaseDirective
public IgbColumnCollection ColumnList { get; protected set; }ActionStripComponents
Section titled "ActionStripComponents"Inherited from: IgbGridBaseDirective
public IgbActionStripCollection ActionStripComponents { get; protected set; }DragGhostCustomTemplate
Section titled "DragGhostCustomTemplate"Inherited from: IgbGridBaseDirective
Gets the custom template, if any, used for row drag ghost.
[Parameter]
public RenderFragment<IgbGridRowDragGhostContext> DragGhostCustomTemplate { get; set; }DragGhostCustomTemplateScript
Section titled "DragGhostCustomTemplateScript"Inherited from: IgbGridBaseDirective
Provides a means of setting DragGhostCustomTemplate in the JavaScript environment.
[Parameter]
public string DragGhostCustomTemplateScript { get; set; }RowEditTextTemplate
Section titled "RowEditTextTemplate"Inherited from: IgbGridBaseDirective
Gets the row edit text template.
[Parameter]
public RenderFragment<IgbGridRowEditTextTemplateContext> RowEditTextTemplate { get; set; }RowEditTextTemplateScript
Section titled "RowEditTextTemplateScript"Inherited from: IgbGridBaseDirective
Provides a means of setting RowEditTextTemplate in the JavaScript environment.
[Parameter]
public string RowEditTextTemplateScript { get; set; }RowAddTextTemplate
Section titled "RowAddTextTemplate"Inherited from: IgbGridBaseDirective
Gets the row add text template.
[Parameter]
public RenderFragment<IgbGridEmptyTemplateContext> RowAddTextTemplate { get; set; }RowAddTextTemplateScript
Section titled "RowAddTextTemplateScript"Inherited from: IgbGridBaseDirective
Provides a means of setting RowAddTextTemplate in the JavaScript environment.
[Parameter]
public string RowAddTextTemplateScript { get; set; }RowEditActionsTemplate
Section titled "RowEditActionsTemplate"Inherited from: IgbGridBaseDirective
Gets the row edit actions template.
[Parameter]
public RenderFragment<IgbGridRowEditActionsTemplateContext> RowEditActionsTemplate { get; set; }RowEditActionsTemplateScript
Section titled "RowEditActionsTemplateScript"Inherited from: IgbGridBaseDirective
Provides a means of setting RowEditActionsTemplate in the JavaScript environment.
[Parameter]
public string RowEditActionsTemplateScript { get; set; }RowExpandedIndicatorTemplate
Section titled "RowExpandedIndicatorTemplate"Inherited from: IgbGridBaseDirective
Gets the row expand indicator template.
[Parameter]
public RenderFragment<IgbGridRowTemplateContext> RowExpandedIndicatorTemplate { get; set; }RowExpandedIndicatorTemplateScript
Section titled "RowExpandedIndicatorTemplateScript"Inherited from: IgbGridBaseDirective
Provides a means of setting RowExpandedIndicatorTemplate in the JavaScript environment.
[Parameter]
public string RowExpandedIndicatorTemplateScript { get; set; }RowCollapsedIndicatorTemplate
Section titled "RowCollapsedIndicatorTemplate"Inherited from: IgbGridBaseDirective
Gets the row collapse indicator template.
[Parameter]
public RenderFragment<IgbGridRowTemplateContext> RowCollapsedIndicatorTemplate { get; set; }RowCollapsedIndicatorTemplateScript
Section titled "RowCollapsedIndicatorTemplateScript"Inherited from: IgbGridBaseDirective
Provides a means of setting RowCollapsedIndicatorTemplate in the JavaScript environment.
[Parameter]
public string RowCollapsedIndicatorTemplateScript { get; set; }HeaderExpandedIndicatorTemplate
Section titled "HeaderExpandedIndicatorTemplate"Inherited from: IgbGridBaseDirective
Gets the header expand indicator template.
[Parameter]
public RenderFragment<IgbGridTemplateContext> HeaderExpandedIndicatorTemplate { get; set; }HeaderExpandedIndicatorTemplateScript
Section titled "HeaderExpandedIndicatorTemplateScript"Inherited from: IgbGridBaseDirective
Provides a means of setting HeaderExpandedIndicatorTemplate in the JavaScript environment.
[Parameter]
public string HeaderExpandedIndicatorTemplateScript { get; set; }HeaderCollapsedIndicatorTemplate
Section titled "HeaderCollapsedIndicatorTemplate"Inherited from: IgbGridBaseDirective
Gets the row collapse indicator template.
[Parameter]
public RenderFragment<IgbGridTemplateContext> HeaderCollapsedIndicatorTemplate { get; set; }HeaderCollapsedIndicatorTemplateScript
Section titled "HeaderCollapsedIndicatorTemplateScript"Inherited from: IgbGridBaseDirective
Provides a means of setting HeaderCollapsedIndicatorTemplate in the JavaScript environment.
[Parameter]
public string HeaderCollapsedIndicatorTemplateScript { get; set; }ExcelStyleHeaderIconTemplate
Section titled "ExcelStyleHeaderIconTemplate"Inherited from: IgbGridBaseDirective
Gets the excel style header icon.
[Parameter]
public RenderFragment<IgbGridHeaderTemplateContext> ExcelStyleHeaderIconTemplate { get; set; }ExcelStyleHeaderIconTemplateScript
Section titled "ExcelStyleHeaderIconTemplateScript"Inherited from: IgbGridBaseDirective
Provides a means of setting ExcelStyleHeaderIconTemplate in the JavaScript environment.
[Parameter]
public string ExcelStyleHeaderIconTemplateScript { get; set; }SortAscendingHeaderIconTemplate
Section titled "SortAscendingHeaderIconTemplate"Inherited from: IgbGridBaseDirective
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"Inherited from: IgbGridBaseDirective
Provides a means of setting SortAscendingHeaderIconTemplate in the JavaScript environment.
[Parameter]
public string SortAscendingHeaderIconTemplateScript { get; set; }SortDescendingHeaderIconTemplate
Section titled "SortDescendingHeaderIconTemplate"Inherited from: IgbGridBaseDirective
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"Inherited from: IgbGridBaseDirective
Provides a means of setting SortDescendingHeaderIconTemplate in the JavaScript environment.
[Parameter]
public string SortDescendingHeaderIconTemplateScript { get; set; }SortHeaderIconTemplate
Section titled "SortHeaderIconTemplate"Inherited from: IgbGridBaseDirective
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"Inherited from: IgbGridBaseDirective
Provides a means of setting SortHeaderIconTemplate in the JavaScript environment.
[Parameter]
public string SortHeaderIconTemplateScript { get; set; }Toolbar
Section titled "Toolbar"Inherited from: IgbGridBaseDirective
public IgbGridToolbarCollection Toolbar { get; protected set; }PaginationComponents
Section titled "PaginationComponents"Inherited from: IgbGridBaseDirective
public IgbPaginatorCollection PaginationComponents { get; protected set; }ResourceStrings
Section titled "ResourceStrings"Inherited from: IgbGridBaseDirective
Gets/Sets the resource strings.
[Parameter]
public IgbGridResourceStrings ResourceStrings { get; set; }ResourceStringsScript
Section titled "ResourceStringsScript"Inherited from: IgbGridBaseDirective
Provides a means of setting ResourceStrings in the JavaScript environment.
[Parameter]
public string ResourceStringsScript { get; set; }FilteringLogic
Section titled "FilteringLogic"Inherited from: IgbGridBaseDirective
Gets/Sets the filtering logic of the IgxGridComponent.
[Parameter]
public FilteringLogic FilteringLogic { get; set; }FilteringExpressionsTree
Section titled "FilteringExpressionsTree"Inherited from: IgbGridBaseDirective
Gets/Sets the filtering state.
[Parameter]
public IgbFilteringExpressionsTree FilteringExpressionsTree { get; set; }AdvancedFilteringExpressionsTree
Section titled "AdvancedFilteringExpressionsTree"Inherited from: IgbGridBaseDirective
Gets/Sets the advanced filtering state.
[Parameter]
public IgbFilteringExpressionsTree AdvancedFilteringExpressionsTree { get; set; }Locale
Section titled "Locale"Inherited from: IgbGridBaseDirective
Gets/Sets the locale.
[Parameter]
public string Locale { get; set; }PagingMode
Section titled "PagingMode"Inherited from: IgbGridBaseDirective
[Parameter]
public GridPagingMode PagingMode { get; set; }HideRowSelectors
Section titled "HideRowSelectors"Inherited from: IgbGridBaseDirective
Gets/Sets if the row selectors are hidden.
[Parameter]
public bool HideRowSelectors { get; set; }RowDraggable
Section titled "RowDraggable"Inherited from: IgbGridBaseDirective
Gets/Sets whether rows can be moved.
[Parameter]
public bool RowDraggable { get; set; }ValidationTrigger
Section titled "ValidationTrigger"Inherited from: IgbGridBaseDirective
Gets/Sets the trigger for validators used when editing the grid.
[Parameter]
public GridValidationTrigger ValidationTrigger { get; set; }RowEditable
Section titled "RowEditable"Inherited from: IgbGridBaseDirective
Gets/Sets whether the rows are editable.
[Parameter]
public bool RowEditable { get; set; }RowHeight
Section titled "RowHeight"Inherited from: IgbGridBaseDirective
Gets/Sets the row height.
[Parameter]
public double RowHeight { get; set; }ColumnWidth
Section titled "ColumnWidth"Inherited from: IgbGridBaseDirective
Gets/Sets the default width of the columns.
[Parameter]
public string ColumnWidth { get; set; }EmptyGridMessage
Section titled "EmptyGridMessage"Inherited from: IgbGridBaseDirective
Get/Sets the message displayed when there are no records.
[Parameter]
public string EmptyGridMessage { get; set; }IsLoading
Section titled "IsLoading"Inherited from: IgbGridBaseDirective
Gets/Sets whether the grid is going to show a loading indicator.
[Parameter]
public bool IsLoading { get; set; }ShouldGenerate
Section titled "ShouldGenerate"Inherited from: IgbGridBaseDirective
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; }EmptyFilteredGridMessage
Section titled "EmptyFilteredGridMessage"Inherited from: IgbGridBaseDirective
Gets/Sets the message displayed when there are no records and the grid is filtered.
[Parameter]
public string EmptyFilteredGridMessage { get; set; }Pinning
Section titled "Pinning"Inherited from: IgbGridBaseDirective
Gets/Sets the initial pinning configuration.
[Parameter]
public IgbPinningConfig Pinning { get; set; }AllowFiltering
Section titled "AllowFiltering"Inherited from: IgbGridBaseDirective
Gets/Sets if the filtering is enabled.
[Parameter]
public bool AllowFiltering { get; set; }AllowAdvancedFiltering
Section titled "AllowAdvancedFiltering"Inherited from: IgbGridBaseDirective
Gets/Sets a value indicating whether the advanced filtering is enabled.
[Parameter]
public bool AllowAdvancedFiltering { get; set; }FilterMode
Section titled "FilterMode"Inherited from: IgbGridBaseDirective
Gets/Sets the filter mode.
[Parameter]
public FilterMode FilterMode { get; set; }SummaryPosition
Section titled "SummaryPosition"Inherited from: IgbGridBaseDirective
Gets/Sets the summary position.
[Parameter]
public GridSummaryPosition SummaryPosition { get; set; }SummaryCalculationMode
Section titled "SummaryCalculationMode"Inherited from: IgbGridBaseDirective
Gets/Sets the summary calculation mode.
[Parameter]
public GridSummaryCalculationMode SummaryCalculationMode { get; set; }ShowSummaryOnCollapse
Section titled "ShowSummaryOnCollapse"Inherited from: IgbGridBaseDirective
Controls whether the summary row is visible when groupBy/parent row is collapsed.
[Parameter]
public bool ShowSummaryOnCollapse { get; set; }FilterStrategy
Section titled "FilterStrategy"Inherited from: IgbGridBaseDirective
Gets/Sets the filtering strategy of the grid.
[Parameter]
public IgbFilteringStrategy FilterStrategy { get; set; }SortStrategy
Section titled "SortStrategy"Inherited from: IgbGridBaseDirective
Gets/Sets the sorting strategy of the grid.
[Parameter]
public IgbGridSortingStrategy SortStrategy { get; set; }SortingOptions
Section titled "SortingOptions"Inherited from: IgbGridBaseDirective
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; }SelectedRows
Section titled "SelectedRows"Inherited from: IgbGridBaseDirective
Gets/Sets the current selection state.
[Parameter]
public object[] SelectedRows { get; set; }HeadSelectorTemplate
Section titled "HeadSelectorTemplate"Inherited from: IgbGridBaseDirective
Gets the header row selector template.
[Parameter]
public RenderFragment<IgbHeadSelectorTemplateContext> HeadSelectorTemplate { get; set; }HeadSelectorTemplateScript
Section titled "HeadSelectorTemplateScript"Inherited from: IgbGridBaseDirective
Provides a means of setting HeadSelectorTemplate in the JavaScript environment.
[Parameter]
public string HeadSelectorTemplateScript { get; set; }RowSelectorTemplate
Section titled "RowSelectorTemplate"Inherited from: IgbGridBaseDirective
Gets the row selector template.
[Parameter]
public RenderFragment<IgbRowSelectorTemplateContext> RowSelectorTemplate { get; set; }RowSelectorTemplateScript
Section titled "RowSelectorTemplateScript"Inherited from: IgbGridBaseDirective
Provides a means of setting RowSelectorTemplate in the JavaScript environment.
[Parameter]
public string RowSelectorTemplateScript { get; set; }DragIndicatorIconTemplate
Section titled "DragIndicatorIconTemplate"Inherited from: IgbGridBaseDirective
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"Inherited from: IgbGridBaseDirective
Provides a means of setting DragIndicatorIconTemplate in the JavaScript environment.
[Parameter]
public string DragIndicatorIconTemplateScript { get; set; }SortingExpressions
Section titled "SortingExpressions"Inherited from: IgbGridBaseDirective
Gets/Sets the sorting state.
[Parameter]
public IgbSortingExpression[] SortingExpressions { get; set; }BatchEditing
Section titled "BatchEditing"Inherited from: IgbGridBaseDirective
Gets/Sets whether the grid has batch editing enabled. When batch editing is enabled, changes are not made directly to the underlying data. Instead, they are stored as transactions, which can later be committed w/ the commit method.
[Parameter]
public bool BatchEditing { get; set; }CellSelection
Section titled "CellSelection"Inherited from: IgbGridBaseDirective
Gets/Sets cell selection mode. selectionMode: GridSelectionMode
[Parameter]
public GridSelectionMode CellSelection { get; set; }CellMergeMode
Section titled "CellMergeMode"Inherited from: IgbGridBaseDirective
Gets/Sets cell merge mode.
[Parameter]
public GridCellMergeMode CellMergeMode { get; set; }RowSelection
Section titled "RowSelection"Inherited from: IgbGridBaseDirective
Gets/Sets row selection mode
[Parameter]
public GridSelectionMode RowSelection { get; set; }ColumnSelection
Section titled "ColumnSelection"Inherited from: IgbGridBaseDirective
Gets/Sets column selection mode selectionMode: GridSelectionMode
[Parameter]
public GridSelectionMode ColumnSelection { get; set; }Outlet
Section titled "Outlet"Inherited from: IgbGridBaseDirective
Gets/Sets the outlet used to attach the grid's overlays to.
[Parameter]
[Obsolete("Overlays now use the HTML Popover API and no longer move to the document body by default, so using outlet is also no longer needed.")]
public IgbOverlayOutletDirective Outlet { get; set; }TotalRecords
Section titled "TotalRecords"Inherited from: IgbGridBaseDirective
Returns the total number of records.
[Parameter]
public double TotalRecords { get; set; }SelectRowOnClick
Section titled "SelectRowOnClick"Inherited from: IgbGridBaseDirective
Gets/Sets whether clicking over a row should select/deselect it enabled: boolean
[Parameter]
public bool SelectRowOnClick { get; set; }ActualColumnList
Section titled "ActualColumnList"Inherited from: IgbGridBaseDirective
public IgbColumnCollection ActualColumnList { get; protected set; }StateComponents
Section titled "StateComponents"Inherited from: IgbGridBaseDirective
public IgbStateCollection StateComponents { get; protected set; }IgBlazor
Section titled "IgBlazor"Inherited from: BaseRendererControl
[Inject]
protected IIgniteUIBlazor IgBlazor { get; set; }Height
Section titled "Height"Inherited from: BaseRendererControl
[Parameter]
public string Height { get; set; }Width
Section titled "Width"Inherited from: BaseRendererControl
[Parameter]
public string Width { get; set; }Class
Section titled "Class"Inherited from: BaseRendererControl
[Parameter]
public string Class { get; set; }AdditionalAttributes
Section titled "AdditionalAttributes"Inherited from: BaseRendererControl
[Parameter(CaptureUnmatchedValues = true)]
public Dictionary<string, object> AdditionalAttributes { get; set; }EventBehavior
Section titled "EventBehavior"Inherited from: BaseRendererControl
Gets or sets how events are bubbled up from JavaScript to Blazor.
[Parameter]
public ControlEventBehavior EventBehavior { get; set; }ChildContent
Section titled "ChildContent"Inherited from: BaseRendererControl
[Parameter]
public RenderFragment ChildContent { get; set; }RoundTripDateConversion
Section titled "RoundTripDateConversion"Inherited from: BaseRendererControl
Gets or sets what type of date conversion to make when round tripping dates.
[Parameter]
public RoundTripDateConversion RoundTripDateConversion { get; set; }SupportsVisualChildren
Section titled "SupportsVisualChildren"Inherited from: BaseRendererControl
protected virtual bool SupportsVisualChildren { get; }UseDirectRender
Section titled "UseDirectRender"Inherited from: BaseRendererControl
protected virtual bool UseDirectRender { get; }DirectRenderElementName
Section titled "DirectRenderElementName"Inherited from: BaseRendererControl
protected virtual string DirectRenderElementName { get; }UseCamelEnumValues
Section titled "UseCamelEnumValues"Inherited from: BaseRendererControl
protected virtual bool UseCamelEnumValues { get; }CascadeOnDelete
Section titled "CascadeOnDelete"Sets whether child records should be deleted when their parent gets deleted. By default it is set to true and deletes all children along with the parent.
[Parameter]
public bool CascadeOnDelete { get; set; }ChildDataKey
Section titled "ChildDataKey"Sets the child data key of the IgxTreeGridComponent.
[Parameter]
public string ChildDataKey { get; set; }Gets/Sets the array of data that populates the component.
[Parameter]
public object Data { get; set; }DataScript
Section titled "DataScript"Provides a means of setting Data in the JavaScript environment.
[Parameter]
public string DataScript { get; set; }ExpansionDepth
Section titled "ExpansionDepth"Sets the count of levels to be expanded in the IgxTreeGridComponent. By default it is set to Infinity which means all levels would be expanded.
[Parameter]
public double ExpansionDepth { get; set; }ForeignKey
Section titled "ForeignKey"Sets the foreign key of the IgxTreeGridComponent.
[Parameter]
public string ForeignKey { get; set; }HasChildrenKey
Section titled "HasChildrenKey"Sets the key indicating whether a row has children. This property is only used for load on demand scenarios.
[Parameter]
public string HasChildrenKey { get; set; }Sets the value of the id attribute. If not provided it will be automatically generated.
[Parameter]
public string Id { get; set; }ProcessedRootRecords
Section titled "ProcessedRootRecords"Returns an array of processed (filtered and sorted) root ITreeGridRecords.
[Parameter]
public IgbTreeGridRecord[] ProcessedRootRecords { get; set; }RootRecords
Section titled "RootRecords"Returns an array of the root level ITreeGridRecords.
[Parameter]
public IgbTreeGridRecord[] RootRecords { get; set; }RowLoadingIndicatorTemplate
Section titled "RowLoadingIndicatorTemplate"Template for the row loading indicator when load on demand is enabled.
[Parameter]
public RenderFragment<object> RowLoadingIndicatorTemplate { get; set; }RowLoadingIndicatorTemplateScript
Section titled "RowLoadingIndicatorTemplateScript"Provides a means of setting RowLoadingIndicatorTemplate in the JavaScript environment.
[Parameter]
public string RowLoadingIndicatorTemplateScript { get; set; }public override string Type { get; }Accessors
Section titled "Accessors"eventCallbacksCache
Section titled "eventCallbacksCache"Inherited from: BaseRendererControl
protected Dictionary<Type, Dictionary<string, FieldInfo>> eventCallbacksCache_cachedSerializedContent
Section titled "_cachedSerializedContent"Inherited from: BaseRendererControl
protected string _cachedSerializedContentMethods
Section titled "Methods"SuspendNotifications()
Section titled "SuspendNotifications()"Inherited from: IgbGridBaseDirective
Prevents data change notifications from be propagated to the component.
public void SuspendNotifications()Returns any
ResumeNotifications()
Section titled "ResumeNotifications()"Inherited from: IgbGridBaseDirective
Resumes data change notifications.
public void ResumeNotifications()Returns any
UpdateProperty(object, string, object)
Section titled "UpdateProperty(object, string, object)"Inherited from: IgbGridBaseDirective
protected void UpdateProperty(object item, string propertyName, object value)Parameters
- item:
object - propertyName:
string - value:
object
Returns any
OnRowAddedOverride(IgbRowDataEventArgs)
Section titled "OnRowAddedOverride(IgbRowDataEventArgs)"Inherited from: IgbGridBaseDirective
protected virtual void OnRowAddedOverride(IgbRowDataEventArgs args)Parameters
- args:
IgbRowDataEventArgs
Returns any
PropagateValues(object, Dictionary<string, object>, bool)
Section titled "PropagateValues(object, Dictionary<string, object>, bool)"Inherited from: IgbGridBaseDirective
protected void PropagateValues(object item, Dictionary<string, object> props, bool createNewIfPossible)Parameters
- item:
object - props:
Dictionary - createNewIfPossible:
bool
Returns any
AddRow(object)
Section titled "AddRow(object)"Inherited from: IgbGridBaseDirective
Adds a new row to the grid. If the grid is bound to RemoteJson or LocalJson then you must provide a dictionary or json string with the row data to add.
public void AddRow(object item)Parameters
- item:
object
Returns any
AddRowAsync(object)
Section titled "AddRowAsync(object)"Inherited from: IgbGridBaseDirective
Adds a new row to the grid. If the grid is bound to RemoteJson or LocalJson then you must provide a dictionary or json string with the row data to add.
public Task AddRowAsync(object item)Parameters
- item:
object
Returns any
DeleteRow(object)
Section titled "DeleteRow(object)"Inherited from: IgbGridBaseDirective
Deletes a row from the grid.
public object DeleteRow(object rowSelector)Parameters
- rowSelector:
object
Returns any
DeleteRowAsync(object)
Section titled "DeleteRowAsync(object)"Inherited from: IgbGridBaseDirective
Deletes a row from the grid.
public Task<object> DeleteRowAsync(object rowSelector)Parameters
- rowSelector:
object
Returns any
UpdateCell(object, object, string)
Section titled "UpdateCell(object, object, string)"Inherited from: IgbGridBaseDirective
Updates the cell value at the specified location.
public void UpdateCell(object value, object rowSelector, string column)Parameters
- value:
object - rowSelector:
object - column:
string
Returns any
UpdateCellAsync(object, object, string)
Section titled "UpdateCellAsync(object, object, string)"Inherited from: IgbGridBaseDirective
Updates the cell value at the specified location.
public Task UpdateCellAsync(object value, object rowSelector, string column)Parameters
- value:
object - rowSelector:
object - column:
string
Returns any
UpdateRow(Dictionary<string, object>, object)
Section titled "UpdateRow(Dictionary<string, object>, object)"Inherited from: IgbGridBaseDirective
Updates the data in a row.
public void UpdateRow(Dictionary<string, object> value, object rowSelector)Parameters
- value:
Dictionary - rowSelector:
object
Returns any
UpdateRowAsync(Dictionary<string, object>, object)
Section titled "UpdateRowAsync(Dictionary<string, object>, object)"Inherited from: IgbGridBaseDirective
Updates the data in a row.
public Task UpdateRowAsync(Dictionary<string, object> value, object rowSelector)Parameters
- value:
Dictionary - rowSelector:
object
Returns any
GetCurrentSelectedRowsAsync()
Section titled "GetCurrentSelectedRowsAsync()"Inherited from: IgbGridBaseDirective
public Task<object[]> GetCurrentSelectedRowsAsync()Returns any
GetCurrentSelectedRows()
Section titled "GetCurrentSelectedRows()"Inherited from: IgbGridBaseDirective
public object[] GetCurrentSelectedRows()Returns any
GetHiddenColumnsCountAsync()
Section titled "GetHiddenColumnsCountAsync()"Inherited from: IgbGridBaseDirective
public Task<double> GetHiddenColumnsCountAsync()Returns any
GetHiddenColumnsCount()
Section titled "GetHiddenColumnsCount()"Inherited from: IgbGridBaseDirective
public double GetHiddenColumnsCount()Returns any
GetPinnedColumnsCountAsync()
Section titled "GetPinnedColumnsCountAsync()"Inherited from: IgbGridBaseDirective
public Task<double> GetPinnedColumnsCountAsync()Returns any
GetPinnedColumnsCount()
Section titled "GetPinnedColumnsCount()"Inherited from: IgbGridBaseDirective
public double GetPinnedColumnsCount()Returns any
GetLastSearchInfoAsync()
Section titled "GetLastSearchInfoAsync()"Inherited from: IgbGridBaseDirective
public Task<IgbSearchInfo> GetLastSearchInfoAsync()Returns any
GetLastSearchInfo()
Section titled "GetLastSearchInfo()"Inherited from: IgbGridBaseDirective
public IgbSearchInfo GetLastSearchInfo()Returns any
GetFilteredDataAsync()
Section titled "GetFilteredDataAsync()"Inherited from: IgbGridBaseDirective
public Task<object> GetFilteredDataAsync()Returns any
GetFilteredData()
Section titled "GetFilteredData()"Inherited from: IgbGridBaseDirective
public object GetFilteredData()Returns any
GetFilteredSortedDataAsync()
Section titled "GetFilteredSortedDataAsync()"Inherited from: IgbGridBaseDirective
public Task<object[]> GetFilteredSortedDataAsync()Returns any
GetFilteredSortedData()
Section titled "GetFilteredSortedData()"Inherited from: IgbGridBaseDirective
public object[] GetFilteredSortedData()Returns any
GetVirtualizationStateAsync()
Section titled "GetVirtualizationStateAsync()"Inherited from: IgbGridBaseDirective
public Task<IgbForOfState> GetVirtualizationStateAsync()Returns any
GetVirtualizationState()
Section titled "GetVirtualizationState()"Inherited from: IgbGridBaseDirective
public IgbForOfState GetVirtualizationState()Returns any
GetDefaultRowHeightAsync()
Section titled "GetDefaultRowHeightAsync()"Inherited from: IgbGridBaseDirective
public Task<double> GetDefaultRowHeightAsync()Returns any
GetDefaultRowHeight()
Section titled "GetDefaultRowHeight()"Inherited from: IgbGridBaseDirective
public double GetDefaultRowHeight()Returns any
GetColumnsAsync()
Section titled "GetColumnsAsync()"Inherited from: IgbGridBaseDirective
public Task<IgbColumn[]> GetColumnsAsync()Returns any
GetColumns()
Section titled "GetColumns()"Inherited from: IgbGridBaseDirective
public IgbColumn[] GetColumns()Returns any
GetPinnedColumnsAsync()
Section titled "GetPinnedColumnsAsync()"Inherited from: IgbGridBaseDirective
public Task<IgbColumn[]> GetPinnedColumnsAsync()Returns any
GetPinnedColumns()
Section titled "GetPinnedColumns()"Inherited from: IgbGridBaseDirective
public IgbColumn[] GetPinnedColumns()Returns any
GetPinnedStartColumnsAsync()
Section titled "GetPinnedStartColumnsAsync()"Inherited from: IgbGridBaseDirective
public Task<IgbColumn[]> GetPinnedStartColumnsAsync()Returns any
GetPinnedStartColumns()
Section titled "GetPinnedStartColumns()"Inherited from: IgbGridBaseDirective
public IgbColumn[] GetPinnedStartColumns()Returns any
GetPinnedEndColumnsAsync()
Section titled "GetPinnedEndColumnsAsync()"Inherited from: IgbGridBaseDirective
public Task<IgbColumn[]> GetPinnedEndColumnsAsync()Returns any
GetPinnedEndColumns()
Section titled "GetPinnedEndColumns()"Inherited from: IgbGridBaseDirective
public IgbColumn[] GetPinnedEndColumns()Returns any
GetUnpinnedColumnsAsync()
Section titled "GetUnpinnedColumnsAsync()"Inherited from: IgbGridBaseDirective
public Task<IgbColumn[]> GetUnpinnedColumnsAsync()Returns any
GetUnpinnedColumns()
Section titled "GetUnpinnedColumns()"Inherited from: IgbGridBaseDirective
public IgbColumn[] GetUnpinnedColumns()Returns any
GetVisibleColumnsAsync()
Section titled "GetVisibleColumnsAsync()"Inherited from: IgbGridBaseDirective
public Task<IgbColumn[]> GetVisibleColumnsAsync()Returns any
GetVisibleColumns()
Section titled "GetVisibleColumns()"Inherited from: IgbGridBaseDirective
public IgbColumn[] GetVisibleColumns()Returns any
GetDataViewAsync()
Section titled "GetDataViewAsync()"Inherited from: IgbGridBaseDirective
public Task<object[]> GetDataViewAsync()Returns any
GetDataView()
Section titled "GetDataView()"Inherited from: IgbGridBaseDirective
public object[] GetDataView()Returns any
GetCurrentActualColumnListAsync()
Section titled "GetCurrentActualColumnListAsync()"Inherited from: IgbGridBaseDirective
public Task<IgbColumnCollection> GetCurrentActualColumnListAsync()Returns any
GetCurrentActualColumnList()
Section titled "GetCurrentActualColumnList()"Inherited from: IgbGridBaseDirective
public IgbColumnCollection GetCurrentActualColumnList()Returns any
SetNativeElementAsync(object)
Section titled "SetNativeElementAsync(object)"Inherited from: IgbGridBaseDirective
public Task SetNativeElementAsync(object element)Parameters
- element:
object
Returns any
SetNativeElement(object)
Section titled "SetNativeElement(object)"Inherited from: IgbGridBaseDirective
public void SetNativeElement(object element)Parameters
- element:
object
Returns any
IsRecordPinnedByIndexAsync(double)
Section titled "IsRecordPinnedByIndexAsync(double)"Inherited from: IgbGridBaseDirective
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
IsRecordPinnedByIndex(double)
Section titled "IsRecordPinnedByIndex(double)"Inherited from: IgbGridBaseDirective
public void IsRecordPinnedByIndex(double rowIndex)Parameters
- rowIndex:
double
Returns any
ToggleColumnVisibilityAsync(IgbColumnVisibilityChangedEventArgs)
Section titled "ToggleColumnVisibilityAsync(IgbColumnVisibilityChangedEventArgs)"Inherited from: IgbGridBaseDirective
Toggles the specified column's visibility.
public Task ToggleColumnVisibilityAsync(IgbColumnVisibilityChangedEventArgs args)Parameters
- args:
IgbColumnVisibilityChangedEventArgs
Returns any
ToggleColumnVisibility(IgbColumnVisibilityChangedEventArgs)
Section titled "ToggleColumnVisibility(IgbColumnVisibilityChangedEventArgs)"Inherited from: IgbGridBaseDirective
public void ToggleColumnVisibility(IgbColumnVisibilityChangedEventArgs args)Parameters
- args:
IgbColumnVisibilityChangedEventArgs
Returns any
ExpandRowAsync(object)
Section titled "ExpandRowAsync(object)"Inherited from: IgbGridBaseDirective
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
ExpandRow(object)
Section titled "ExpandRow(object)"Inherited from: IgbGridBaseDirective
public void ExpandRow(object rowID)Parameters
- rowID:
object
Returns any
CollapseRowAsync(object)
Section titled "CollapseRowAsync(object)"Inherited from: IgbGridBaseDirective
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
CollapseRow(object)
Section titled "CollapseRow(object)"Inherited from: IgbGridBaseDirective
public void CollapseRow(object rowID)Parameters
- rowID:
object
Returns any
ToggleRowAsync(object)
Section titled "ToggleRowAsync(object)"Inherited from: IgbGridBaseDirective
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
ToggleRow(object)
Section titled "ToggleRow(object)"Inherited from: IgbGridBaseDirective
public void ToggleRow(object rowID)Parameters
- rowID:
object
Returns any
GetHeaderGroupWidthAsync(IgbColumn)
Section titled "GetHeaderGroupWidthAsync(IgbColumn)"Inherited from: IgbGridBaseDirective
Gets the width to be set on IgxGridHeaderGroupComponent.
public Task<string> GetHeaderGroupWidthAsync(IgbColumn column)Parameters
- column:
IgbColumn
Returns any
GetHeaderGroupWidth(IgbColumn)
Section titled "GetHeaderGroupWidth(IgbColumn)"Inherited from: IgbGridBaseDirective
public string GetHeaderGroupWidth(IgbColumn column)Parameters
- column:
IgbColumn
Returns any
GetColumnByNameAsync(string)
Section titled "GetColumnByNameAsync(string)"Inherited from: IgbGridBaseDirective
Returns the IgxColumnComponent by field name. name
public Task<IgbColumn> GetColumnByNameAsync(string name)Parameters
- name:
string
Returns any
GetColumnByName(string)
Section titled "GetColumnByName(string)"Inherited from: IgbGridBaseDirective
public IgbColumn GetColumnByName(string name)Parameters
- name:
string
Returns any
GetColumnByVisibleIndexAsync(double)
Section titled "GetColumnByVisibleIndexAsync(double)"Inherited from: IgbGridBaseDirective
public Task<IgbColumn> GetColumnByVisibleIndexAsync(double index)Parameters
- index:
double
Returns any
GetColumnByVisibleIndex(double)
Section titled "GetColumnByVisibleIndex(double)"Inherited from: IgbGridBaseDirective
public IgbColumn GetColumnByVisibleIndex(double index)Parameters
- index:
double
Returns any
RecalculateAutoSizesAsync()
Section titled "RecalculateAutoSizesAsync()"Inherited from: IgbGridBaseDirective
Recalculates all widths of columns that have size set to auto.
public Task RecalculateAutoSizesAsync()Returns any
RecalculateAutoSizes()
Section titled "RecalculateAutoSizes()"Inherited from: IgbGridBaseDirective
public void RecalculateAutoSizes()Returns any
MoveColumnAsync(IgbColumn, IgbColumn, DropPosition?)
Section titled "MoveColumnAsync(IgbColumn, IgbColumn, DropPosition?)"Inherited from: IgbGridBaseDirective
public Task MoveColumnAsync(IgbColumn column, IgbColumn target, DropPosition? pos = null)Parameters
- column:
IgbColumn - target:
IgbColumn - pos:
DropPosition?
Returns any
MoveColumn(IgbColumn, IgbColumn, DropPosition?)
Section titled "MoveColumn(IgbColumn, IgbColumn, DropPosition?)"Inherited from: IgbGridBaseDirective
public void MoveColumn(IgbColumn column, IgbColumn target, DropPosition? pos = null)Parameters
- column:
IgbColumn - target:
IgbColumn - pos:
DropPosition?
Returns any
MarkForCheckAsync()
Section titled "MarkForCheckAsync()"Inherited from: IgbGridBaseDirective
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
MarkForCheck()
Section titled "MarkForCheck()"Inherited from: IgbGridBaseDirective
public void MarkForCheck()Returns any
GetRowDataAsync(object)
Section titled "GetRowDataAsync(object)"Inherited from: IgbGridBaseDirective
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
GetRowData(object)
Section titled "GetRowData(object)"Inherited from: IgbGridBaseDirective
public object GetRowData(object rowSelector)Parameters
- rowSelector:
object
Returns any
SortAsync(IgbSortingExpression[])
Section titled "SortAsync(IgbSortingExpression[])"Inherited from: IgbGridBaseDirective
public Task SortAsync(IgbSortingExpression[] expression)Parameters
- expression:
IgbSortingExpression[]
Returns any
Sort(IgbSortingExpression[])
Section titled "Sort(IgbSortingExpression[])"Inherited from: IgbGridBaseDirective
public void Sort(IgbSortingExpression[] expression)Parameters
- expression:
IgbSortingExpression[]
Returns any
FilterAsync(string, object, IgbFilteringExpressionsTreeOrFilteringOperation, bool)
Section titled "FilterAsync(string, object, IgbFilteringExpressionsTreeOrFilteringOperation, bool)"Inherited from: IgbGridBaseDirective
public Task FilterAsync(string name, object value, IgbFilteringExpressionsTreeOrFilteringOperation conditionOrExpressionTree, bool ignoreCase = false)Parameters
- name:
string - value:
object - conditionOrExpressionTree:
IgbFilteringExpressionsTreeOrFilteringOperation - ignoreCase:
bool
Returns any
Filter(string, object, IgbFilteringExpressionsTreeOrFilteringOperation, bool)
Section titled "Filter(string, object, IgbFilteringExpressionsTreeOrFilteringOperation, bool)"Inherited from: IgbGridBaseDirective
public void Filter(string name, object value, IgbFilteringExpressionsTreeOrFilteringOperation conditionOrExpressionTree, bool ignoreCase = false)Parameters
- name:
string - value:
object - conditionOrExpressionTree:
IgbFilteringExpressionsTreeOrFilteringOperation - ignoreCase:
bool
Returns any
FilterGlobalAsync(object, object, object)
Section titled "FilterGlobalAsync(object, object, object)"Inherited from: IgbGridBaseDirective
public Task FilterGlobalAsync(object value, object condition, object ignoreCase)Parameters
- value:
object - condition:
object - ignoreCase:
object
Returns any
FilterGlobal(object, object, object)
Section titled "FilterGlobal(object, object, object)"Inherited from: IgbGridBaseDirective
public void FilterGlobal(object value, object condition, object ignoreCase)Parameters
- value:
object - condition:
object - ignoreCase:
object
Returns any
EnableSummariesAsync(object[])
Section titled "EnableSummariesAsync(object[])"Inherited from: IgbGridBaseDirective
public Task EnableSummariesAsync(object[] rest)Parameters
- rest:
object[]
Returns any
EnableSummaries(object[])
Section titled "EnableSummaries(object[])"Inherited from: IgbGridBaseDirective
public void EnableSummaries(object[] rest)Parameters
- rest:
object[]
Returns any
DisableSummariesAsync(object[])
Section titled "DisableSummariesAsync(object[])"Inherited from: IgbGridBaseDirective
public Task DisableSummariesAsync(object[] rest)Parameters
- rest:
object[]
Returns any
DisableSummaries(object[])
Section titled "DisableSummaries(object[])"Inherited from: IgbGridBaseDirective
public void DisableSummaries(object[] rest)Parameters
- rest:
object[]
Returns any
ClearFilterAsync(string)
Section titled "ClearFilterAsync(string)"Inherited from: IgbGridBaseDirective
If name is provided, clears the filtering state of the corresponding IgxColumnComponent. name
public Task ClearFilterAsync(string name = null)Parameters
- name:
string
Returns any
ClearFilter(string)
Section titled "ClearFilter(string)"Inherited from: IgbGridBaseDirective
public void ClearFilter(string name = null)Parameters
- name:
string
Returns any
ClearSortAsync(string)
Section titled "ClearSortAsync(string)"Inherited from: IgbGridBaseDirective
If name is provided, clears the sorting state of the corresponding IgxColumnComponent. name
public Task ClearSortAsync(string name = null)Parameters
- name:
string
Returns any
ClearSort(string)
Section titled "ClearSort(string)"Inherited from: IgbGridBaseDirective
public void ClearSort(string name = null)Parameters
- name:
string
Returns any
PinColumnAsync(string, double, ColumnPinningPosition?)
Section titled "PinColumnAsync(string, double, ColumnPinningPosition?)"Inherited from: IgbGridBaseDirective
public Task<bool> PinColumnAsync(string columnName, double index = -1, ColumnPinningPosition? pinningPosition = null)Parameters
- columnName:
string - index:
double - pinningPosition:
ColumnPinningPosition?
Returns any
PinColumn(string, double, ColumnPinningPosition?)
Section titled "PinColumn(string, double, ColumnPinningPosition?)"Inherited from: IgbGridBaseDirective
public bool PinColumn(string columnName, double index = -1, ColumnPinningPosition? pinningPosition = null)Parameters
- columnName:
string - index:
double - pinningPosition:
ColumnPinningPosition?
Returns any
UnpinColumnAsync(string, double)
Section titled "UnpinColumnAsync(string, double)"Inherited from: IgbGridBaseDirective
public Task<bool> UnpinColumnAsync(string columnName, double index = -1)Parameters
- columnName:
string - index:
double
Returns any
UnpinColumn(string, double)
Section titled "UnpinColumn(string, double)"Inherited from: IgbGridBaseDirective
public bool UnpinColumn(string columnName, double index = -1)Parameters
- columnName:
string - index:
double
Returns any
ReflowAsync()
Section titled "ReflowAsync()"Inherited from: IgbGridBaseDirective
Recalculates grid width/height dimensions.
public Task ReflowAsync()Returns any
Reflow()
Section titled "Reflow()"Inherited from: IgbGridBaseDirective
public void Reflow()Returns any
FindNextAsync(string, bool, bool)
Section titled "FindNextAsync(string, bool, bool)"Inherited from: IgbGridBaseDirective
public Task<double> FindNextAsync(string text, bool caseSensitive = false, bool exactMatch = false)Parameters
- text:
string - caseSensitive:
bool - exactMatch:
bool
Returns any
FindNext(string, bool, bool)
Section titled "FindNext(string, bool, bool)"Inherited from: IgbGridBaseDirective
public double FindNext(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)"Inherited from: IgbGridBaseDirective
public Task<double> FindPrevAsync(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)"Inherited from: IgbGridBaseDirective
public double FindPrev(string text, bool caseSensitive = false, bool exactMatch = false)Parameters
- text:
string - caseSensitive:
bool - exactMatch:
bool
Returns any
RefreshSearchAsync(bool, bool)
Section titled "RefreshSearchAsync(bool, bool)"Inherited from: IgbGridBaseDirective
public Task<double> RefreshSearchAsync(bool updateActiveInfo = false, bool endEdit = false)Parameters
- updateActiveInfo:
bool - endEdit:
bool
Returns any
RefreshSearch(bool, bool)
Section titled "RefreshSearch(bool, bool)"Inherited from: IgbGridBaseDirective
public double RefreshSearch(bool updateActiveInfo = false, bool endEdit = false)Parameters
- updateActiveInfo:
bool - endEdit:
bool
Returns any
ClearSearchAsync()
Section titled "ClearSearchAsync()"Inherited from: IgbGridBaseDirective
Removes all the highlights in the cell.
public Task ClearSearchAsync()Returns any
ClearSearch()
Section titled "ClearSearch()"Inherited from: IgbGridBaseDirective
public void ClearSearch()Returns any
GetPinnedStartWidthAsync(bool)
Section titled "GetPinnedStartWidthAsync(bool)"Inherited from: IgbGridBaseDirective
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
GetPinnedStartWidth(bool)
Section titled "GetPinnedStartWidth(bool)"Inherited from: IgbGridBaseDirective
public void GetPinnedStartWidth(bool takeHidden = false)Parameters
- takeHidden:
bool
Returns any
GetPinnedEndWidthAsync(bool)
Section titled "GetPinnedEndWidthAsync(bool)"Inherited from: IgbGridBaseDirective
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
GetPinnedEndWidth(bool)
Section titled "GetPinnedEndWidth(bool)"Inherited from: IgbGridBaseDirective
public void GetPinnedEndWidth(bool takeHidden = false)Parameters
- takeHidden:
bool
Returns any
SelectRowsAsync(object[], bool)
Section titled "SelectRowsAsync(object[], bool)"Inherited from: IgbGridBaseDirective
public Task SelectRowsAsync(object[] rowIDs, bool clearCurrentSelection = false)Parameters
- rowIDs:
object[] - clearCurrentSelection:
bool
Returns any
SelectRows(object[], bool)
Section titled "SelectRows(object[], bool)"Inherited from: IgbGridBaseDirective
public void SelectRows(object[] rowIDs, bool clearCurrentSelection = false)Parameters
- rowIDs:
object[] - clearCurrentSelection:
bool
Returns any
DeselectRowsAsync(object[])
Section titled "DeselectRowsAsync(object[])"Inherited from: IgbGridBaseDirective
public Task DeselectRowsAsync(object[] rowIDs)Parameters
- rowIDs:
object[]
Returns any
DeselectRows(object[])
Section titled "DeselectRows(object[])"Inherited from: IgbGridBaseDirective
public void DeselectRows(object[] rowIDs)Parameters
- rowIDs:
object[]
Returns any
SelectAllRowsAsync(bool)
Section titled "SelectAllRowsAsync(bool)"Inherited from: IgbGridBaseDirective
Selects all rows onlyFilterData
public Task SelectAllRowsAsync(bool onlyFilterData = false)Parameters
- onlyFilterData:
bool
Returns any
SelectAllRows(bool)
Section titled "SelectAllRows(bool)"Inherited from: IgbGridBaseDirective
public void SelectAllRows(bool onlyFilterData = false)Parameters
- onlyFilterData:
bool
Returns any
DeselectAllRowsAsync(bool)
Section titled "DeselectAllRowsAsync(bool)"Inherited from: IgbGridBaseDirective
Deselects all rows onlyFilterData
public Task DeselectAllRowsAsync(bool onlyFilterData = false)Parameters
- onlyFilterData:
bool
Returns any
DeselectAllRows(bool)
Section titled "DeselectAllRows(bool)"Inherited from: IgbGridBaseDirective
public void DeselectAllRows(bool onlyFilterData = false)Parameters
- onlyFilterData:
bool
Returns any
ClearCellSelectionAsync()
Section titled "ClearCellSelectionAsync()"Inherited from: IgbGridBaseDirective
Deselect selected cells.
public Task ClearCellSelectionAsync()Returns any
ClearCellSelection()
Section titled "ClearCellSelection()"Inherited from: IgbGridBaseDirective
public void ClearCellSelection()Returns any
SelectRangeAsync(IgbGridSelectionRange[])
Section titled "SelectRangeAsync(IgbGridSelectionRange[])"Inherited from: IgbGridBaseDirective
public Task SelectRangeAsync(IgbGridSelectionRange[] arg)Parameters
- arg:
IgbGridSelectionRange[]
Returns any
SelectRange(IgbGridSelectionRange[])
Section titled "SelectRange(IgbGridSelectionRange[])"Inherited from: IgbGridBaseDirective
public void SelectRange(IgbGridSelectionRange[] arg)Parameters
- arg:
IgbGridSelectionRange[]
Returns any
GetSelectedRangesAsync()
Section titled "GetSelectedRangesAsync()"Inherited from: IgbGridBaseDirective
Get the currently selected ranges in the grid.
public Task<IgbGridSelectionRange[]> GetSelectedRangesAsync()Returns any
GetSelectedRanges()
Section titled "GetSelectedRanges()"Inherited from: IgbGridBaseDirective
public IgbGridSelectionRange[] GetSelectedRanges()Returns any
SelectedColumnsAsync()
Section titled "SelectedColumnsAsync()"Inherited from: IgbGridBaseDirective
Get current selected columns.
public Task<IgbColumn[]> SelectedColumnsAsync()Returns any
SelectedColumns()
Section titled "SelectedColumns()"Inherited from: IgbGridBaseDirective
public IgbColumn[] SelectedColumns()Returns any
SelectColumnsAsync(string[], bool)
Section titled "SelectColumnsAsync(string[], bool)"Inherited from: IgbGridBaseDirective
public Task SelectColumnsAsync(string[] columns, bool clearCurrentSelection = false)Parameters
- columns:
string[] - clearCurrentSelection:
bool
Returns any
SelectColumns(string[], bool)
Section titled "SelectColumns(string[], bool)"Inherited from: IgbGridBaseDirective
public void SelectColumns(string[] columns, bool clearCurrentSelection = false)Parameters
- columns:
string[] - clearCurrentSelection:
bool
Returns any
DeselectColumnsAsync(string[])
Section titled "DeselectColumnsAsync(string[])"Inherited from: IgbGridBaseDirective
public Task DeselectColumnsAsync(string[] columns)Parameters
- columns:
string[]
Returns any
DeselectColumns(string[])
Section titled "DeselectColumns(string[])"Inherited from: IgbGridBaseDirective
public void DeselectColumns(string[] columns)Parameters
- columns:
string[]
Returns any
DeselectAllColumnsAsync()
Section titled "DeselectAllColumnsAsync()"Inherited from: IgbGridBaseDirective
Deselects all columns
public Task DeselectAllColumnsAsync()Returns any
DeselectAllColumns()
Section titled "DeselectAllColumns()"Inherited from: IgbGridBaseDirective
public void DeselectAllColumns()Returns any
SelectAllColumnsAsync()
Section titled "SelectAllColumnsAsync()"Inherited from: IgbGridBaseDirective
Selects all columns
public Task SelectAllColumnsAsync()Returns any
SelectAllColumns()
Section titled "SelectAllColumns()"Inherited from: IgbGridBaseDirective
public void SelectAllColumns()Returns any
GetSelectedColumnsDataAsync(bool, bool)
Section titled "GetSelectedColumnsDataAsync(bool, bool)"Inherited from: IgbGridBaseDirective
public Task GetSelectedColumnsDataAsync(bool formatters = false, bool headers = false)Parameters
- formatters:
bool - headers:
bool
Returns any
GetSelectedColumnsData(bool, bool)
Section titled "GetSelectedColumnsData(bool, bool)"Inherited from: IgbGridBaseDirective
public void GetSelectedColumnsData(bool formatters = false, bool headers = false)Parameters
- formatters:
bool - headers:
bool
Returns any
NavigateToAsync(double, double, object)
Section titled "NavigateToAsync(double, double, object)"Inherited from: IgbGridBaseDirective
public Task NavigateToAsync(double rowIndex, double visibleColIndex, object cb)Parameters
- rowIndex:
double - visibleColIndex:
double - cb:
object
Returns any
NavigateTo(double, double, object)
Section titled "NavigateTo(double, double, object)"Inherited from: IgbGridBaseDirective
public void NavigateTo(double rowIndex, double visibleColIndex, object cb)Parameters
- rowIndex:
double - visibleColIndex:
double - cb:
object
Returns any
GetNextCellAsync(double, double, object)
Section titled "GetNextCellAsync(double, double, object)"Inherited from: IgbGridBaseDirective
public Task<IgbCellPosition> GetNextCellAsync(double currRowIndex, double curVisibleColIndex, object callback)Parameters
- currRowIndex:
double - curVisibleColIndex:
double - callback:
object
Returns any
GetNextCell(double, double, object)
Section titled "GetNextCell(double, double, object)"Inherited from: IgbGridBaseDirective
public IgbCellPosition GetNextCell(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)"Inherited from: IgbGridBaseDirective
public Task<IgbCellPosition> GetPreviousCellAsync(double currRowIndex, double curVisibleColIndex, object callback)Parameters
- currRowIndex:
double - curVisibleColIndex:
double - callback:
object
Returns any
GetPreviousCell(double, double, object)
Section titled "GetPreviousCell(double, double, object)"Inherited from: IgbGridBaseDirective
public IgbCellPosition GetPreviousCell(double currRowIndex, double curVisibleColIndex, object callback)Parameters
- currRowIndex:
double - curVisibleColIndex:
double - callback:
object
Returns any
OpenAdvancedFilteringDialogAsync(IgbOverlaySettings)
Section titled "OpenAdvancedFilteringDialogAsync(IgbOverlaySettings)"Inherited from: IgbGridBaseDirective
Opens the advanced filtering dialog.
public Task OpenAdvancedFilteringDialogAsync(IgbOverlaySettings overlaySettings)Parameters
- overlaySettings:
IgbOverlaySettings
Returns any
OpenAdvancedFilteringDialog(IgbOverlaySettings)
Section titled "OpenAdvancedFilteringDialog(IgbOverlaySettings)"Inherited from: IgbGridBaseDirective
public void OpenAdvancedFilteringDialog(IgbOverlaySettings overlaySettings)Parameters
- overlaySettings:
IgbOverlaySettings
Returns any
CloseAdvancedFilteringDialogAsync(bool)
Section titled "CloseAdvancedFilteringDialogAsync(bool)"Inherited from: IgbGridBaseDirective
Closes the advanced filtering dialog. applyChanges indicates whether the changes should be applied
public Task CloseAdvancedFilteringDialogAsync(bool applyChanges)Parameters
- applyChanges:
bool
Returns any
CloseAdvancedFilteringDialog(bool)
Section titled "CloseAdvancedFilteringDialog(bool)"Inherited from: IgbGridBaseDirective
public void CloseAdvancedFilteringDialog(bool applyChanges)Parameters
- applyChanges:
bool
Returns any
BeginAddRowByIdAsync(object, bool)
Section titled "BeginAddRowByIdAsync(object, bool)"Inherited from: IgbGridBaseDirective
public Task BeginAddRowByIdAsync(object rowID, bool asChild = false)Parameters
- rowID:
object - asChild:
bool
Returns any
BeginAddRowById(object, bool)
Section titled "BeginAddRowById(object, bool)"Inherited from: IgbGridBaseDirective
public void BeginAddRowById(object rowID, bool asChild = false)Parameters
- rowID:
object - asChild:
bool
Returns any
ResolveEventBehavior()
Section titled "ResolveEventBehavior()"Inherited from: BaseRendererControl
Resolves the components event behavior if Auto is selected.
protected ControlEventBehavior ResolveEventBehavior()Returns any
ResolveDisplay()
Section titled "ResolveDisplay()"Inherited from: BaseRendererControl
protected virtual string ResolveDisplay()Returns any
ToSpinal(string)
Section titled "ToSpinal(string)"Inherited from: BaseRendererControl
protected string ToSpinal(string value)Parameters
- value:
string
Returns any
TransformSimpleKey(string)
Section titled "TransformSimpleKey(string)"Inherited from: BaseRendererControl
protected virtual string TransformSimpleKey(string key)Parameters
- key:
string
Returns any
IsTransformedEnumValue(string)
Section titled "IsTransformedEnumValue(string)"Inherited from: BaseRendererControl
protected virtual bool IsTransformedEnumValue(string key)Parameters
- key:
string
Returns any
TransformPotentialEnumValue(string, object)
Section titled "TransformPotentialEnumValue(string, object)"Inherited from: BaseRendererControl
protected virtual object TransformPotentialEnumValue(string key, object value)Parameters
- key:
string - value:
object
Returns any
BuildSequenceInfo(int)
Section titled "BuildSequenceInfo(int)"Inherited from: BaseRendererControl
protected virtual SequenceInfo BuildSequenceInfo(int startSequence)Parameters
- startSequence:
int
Returns any
BuildRenderTree(RenderTreeBuilder)
Section titled "BuildRenderTree(RenderTreeBuilder)"Inherited from: BaseRendererControl
protected override void BuildRenderTree(RenderTreeBuilder builder)Parameters
- builder:
RenderTreeBuilder
Returns any
TemplateContentType(string)
Section titled "TemplateContentType(string)"Inherited from: BaseRendererControl
protected Type TemplateContentType(string templateId)Parameters
- templateId:
string
Returns any
OnAfterRenderAsync(bool)
Section titled "OnAfterRenderAsync(bool)"Inherited from: BaseRendererControl
protected override Task OnAfterRenderAsync(bool firstRender)Parameters
- firstRender:
bool
Returns any
EnsureReady()
Section titled "EnsureReady()"Inherited from: BaseRendererControl
public Task EnsureReady()Returns any
MarkPropDirty(string)
Section titled "MarkPropDirty(string)"Inherited from: BaseRendererControl
protected void MarkPropDirty(string propertyName)Parameters
- propertyName:
string
Returns any
IsPropDirty(string)
Section titled "IsPropDirty(string)"Inherited from: BaseRendererControl
protected bool IsPropDirty(string propertyName)Parameters
- propertyName:
string
Returns any
Serialize(SerializationContext, string)
Section titled "Serialize(SerializationContext, string)"Inherited from: BaseRendererControl
public void Serialize(SerializationContext context, string propertyName = null)Parameters
- context:
SerializationContext - propertyName:
string
Returns any
Serialize()
Section titled "Serialize()"Inherited from: BaseRendererControl
public string Serialize()Returns any
InvokeMethod(string, object[], string[], ElementReference[])
Section titled "InvokeMethod(string, object[], string[], ElementReference[])"Inherited from: BaseRendererControl
protected Task<object> InvokeMethod(string methodName, object[] arguments, string[] types, ElementReference[] nativeElements = null)Parameters
- methodName:
string - arguments:
object[] - types:
string[] - nativeElements:
ElementReference[]
Returns any
InvokeMethodSync(string, object[], string[], ElementReference[])
Section titled "InvokeMethodSync(string, object[], string[], ElementReference[])"Inherited from: BaseRendererControl
protected object InvokeMethodSync(string methodName, object[] arguments, string[] types, ElementReference[] nativeElements = null)Parameters
- methodName:
string - arguments:
object[] - types:
string[] - nativeElements:
ElementReference[]
Returns any
SuspendNotifications(object)
Section titled "SuspendNotifications(object)"Inherited from: BaseRendererControl
Prevents data change notifications from be propagated to the component.
public void SuspendNotifications(object dataSource)Parameters
- dataSource:
object
Returns any
ResumeNotifications(object, bool)
Section titled "ResumeNotifications(object, bool)"Inherited from: BaseRendererControl
Resumes data change notifications.
public void ResumeNotifications(object dataSource, bool notify = true)Parameters
- dataSource:
object - notify:
bool
Returns any
NotifyInsertItem(object, int, object)
Section titled "NotifyInsertItem(object, int, object)"Inherited from: BaseRendererControl
public void NotifyInsertItem(object dataSource, int index, object refItem)Parameters
- dataSource:
object - index:
int - refItem:
object
Returns any
NotifyRemoveItem(object, int, object)
Section titled "NotifyRemoveItem(object, int, object)"Inherited from: BaseRendererControl
public void NotifyRemoveItem(object dataSource, int index, object oldItem)Parameters
- dataSource:
object - index:
int - oldItem:
object
Returns any
NotifyClearItems(object)
Section titled "NotifyClearItems(object)"Inherited from: BaseRendererControl
public void NotifyClearItems(object dataSource)Parameters
- dataSource:
object
Returns any
NotifySetItem(object, int, object, object)
Section titled "NotifySetItem(object, int, object, object)"Inherited from: BaseRendererControl
public void NotifySetItem(object dataSource, int index, object oldItem, object newItem)Parameters
- dataSource:
object - index:
int - oldItem:
object - newItem:
object
Returns any
NotifyUpdateItem(object, int, object, bool)
Section titled "NotifyUpdateItem(object, int, object, bool)"Inherited from: BaseRendererControl
public void NotifyUpdateItem(object dataSource, int index, object refItem, bool syncDataOnly = false)Parameters
- dataSource:
object - index:
int - refItem:
object - syncDataOnly:
bool
Returns any
OnRefChanged(string, object)
Section titled "OnRefChanged(string, object)"Inherited from: BaseRendererControl
public void OnRefChanged(string refName, object refValue)Parameters
- refName:
string - refValue:
object
Returns any
OnInvokeReturn(long, object)
Section titled "OnInvokeReturn(long, object)"Inherited from: BaseRendererControl
public void OnInvokeReturn(long invokeId, object returnValue)Parameters
- invokeId:
long - returnValue:
object
Returns any
Camelize(string)
Section titled "Camelize(string)"Inherited from: BaseRendererControl
protected string Camelize(string value)Parameters
- value:
string
Returns any
ToPascal(string)
Section titled "ToPascal(string)"Inherited from: BaseRendererControl
protected string ToPascal(string value)Parameters
- value:
string
Returns any
OnElementNameChanged(BaseRendererElement, string, string)
Section titled "OnElementNameChanged(BaseRendererElement, string, string)"Inherited from: BaseRendererControl
protected void OnElementNameChanged(BaseRendererElement element, string oldName, string newName)Parameters
- element:
BaseRendererElement - oldName:
string - newName:
string
Returns any
Dispose(bool)
Section titled "Dispose(bool)"Inherited from: BaseRendererControl
protected virtual void Dispose(bool disposing)Parameters
- disposing:
bool
Returns any
SetResourceStringAsync(string, string, string)
Section titled "SetResourceStringAsync(string, string, string)"Inherited from: BaseRendererControl
public Task<object> SetResourceStringAsync(string grouping, string id, string value)Parameters
- grouping:
string - id:
string - value:
string
Returns any
SetResourceStringAsync(string, string)
Section titled "SetResourceStringAsync(string, string)"Inherited from: BaseRendererControl
public Task<object> SetResourceStringAsync(string grouping, string json)Parameters
- grouping:
string - json:
string
Returns any
SetPropertyValue(object, PropertyInfo, JsonElement)
Section titled "SetPropertyValue(object, PropertyInfo, JsonElement)"Inherited from: BaseRendererControl
protected void SetPropertyValue(object item, PropertyInfo property, JsonElement jsonElement)Parameters
- item:
object - property:
PropertyInfo - jsonElement:
JsonElement
Returns any
SetPropertyValue(object, PropertyInfo, object)
Section titled "SetPropertyValue(object, PropertyInfo, object)"Inherited from: BaseRendererControl
protected void SetPropertyValue(object item, PropertyInfo property, object value)Parameters
- item:
object - property:
PropertyInfo - value:
object
Returns any
Dispose()
Section titled "Dispose()"Inherited from: BaseRendererControl
public void Dispose()Returns any
AddRow(object, object)
Section titled "AddRow(object, object)"Adds a new row to the grid. If the grid is bound to RemoteJson or LocalJson then you must provide a dictionary or json string with the row data to add.
public void AddRow(object item, object parentRowID)Parameters
- item:
object - parentRowID:
object
Returns any
AddRowAsync(object, object)
Section titled "AddRowAsync(object, object)"Adds a new row to the grid. If the grid is bound to RemoteJson or LocalJson then you must provide a dictionary or json string with the row data to add.
public Task AddRowAsync(object item, object parentRowID)Parameters
- item:
object - parentRowID:
object
Returns any
BeginAddRowByIndex(double, bool)
Section titled "BeginAddRowByIndex(double, bool)"public void BeginAddRowByIndex(double index, bool asChild = false)Parameters
- index:
double - asChild:
bool
Returns any
BeginAddRowByIndexAsync(double, bool)
Section titled "BeginAddRowByIndexAsync(double, bool)"public Task BeginAddRowByIndexAsync(double index, bool asChild = false)Parameters
- index:
double - asChild:
bool
Returns any
CollapseAll()
Section titled "CollapseAll()"public void CollapseAll()Returns any
CollapseAllAsync()
Section titled "CollapseAllAsync()"Collapses all rows.
public Task CollapseAllAsync()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
FindByName(string)
Section titled "FindByName(string)"public override object FindByName(string name)Parameters
- name:
string
Returns any
GetCellByColumn(double, string)
Section titled "GetCellByColumn(double, string)"public IgbCellType GetCellByColumn(double rowIndex, string columnField)Parameters
- rowIndex:
double - columnField:
string
Returns any
GetCellByColumnAsync(double, string)
Section titled "GetCellByColumnAsync(double, string)"public Task<IgbCellType> GetCellByColumnAsync(double rowIndex, string columnField)Parameters
- rowIndex:
double - columnField:
string
Returns any
GetCellByKey(object, string)
Section titled "GetCellByKey(object, string)"public IgbCellType GetCellByKey(object rowSelector, string columnField)Parameters
- rowSelector:
object - columnField:
string
Returns any
GetCellByKeyAsync(object, string)
Section titled "GetCellByKeyAsync(object, string)"public Task<IgbCellType> GetCellByKeyAsync(object rowSelector, string columnField)Parameters
- rowSelector:
object - columnField:
string
Returns any
GetData()
Section titled "GetData()"protected override object GetData()Returns any
GetDefaultExpandState(IgbTreeGridRecord)
Section titled "GetDefaultExpandState(IgbTreeGridRecord)"public bool GetDefaultExpandState(IgbTreeGridRecord record)Parameters
- record:
IgbTreeGridRecord
Returns any
GetDefaultExpandStateAsync(IgbTreeGridRecord)
Section titled "GetDefaultExpandStateAsync(IgbTreeGridRecord)"public Task<bool> GetDefaultExpandStateAsync(IgbTreeGridRecord record)Parameters
- record:
IgbTreeGridRecord
Returns any
GetRowByIndex(double)
Section titled "GetRowByIndex(double)"public IgbRowType GetRowByIndex(double index)Parameters
- index:
double
Returns any
GetRowByIndexAsync(double)
Section titled "GetRowByIndexAsync(double)"Returns the IgxTreeGridRow by index. index
public Task<IgbRowType> GetRowByIndexAsync(double index)Parameters
- index:
double
Returns any
GetRowByKey(object)
Section titled "GetRowByKey(object)"public IgbRowType GetRowByKey(object key)Parameters
- key:
object
Returns any
GetRowByKeyAsync(object)
Section titled "GetRowByKeyAsync(object)"Returns the RowType object by the specified primary key. index
public Task<IgbRowType> GetRowByKeyAsync(object key)Parameters
- key:
object
Returns any
GetSelectedCells()
Section titled "GetSelectedCells()"public IgbCellType[] GetSelectedCells()Returns any
GetSelectedCellsAsync()
Section titled "GetSelectedCellsAsync()"public Task<IgbCellType[]> GetSelectedCellsAsync()Returns any
GetSelectedData(bool, bool)
Section titled "GetSelectedData(bool, bool)"public object[] GetSelectedData(bool formatters = false, bool headers = false)Parameters
- formatters:
bool - headers:
bool
Returns any
GetSelectedDataAsync(bool, bool)
Section titled "GetSelectedDataAsync(bool, bool)"public Task<object[]> GetSelectedDataAsync(bool formatters = false, bool headers = false)Parameters
- formatters:
bool - headers:
bool
Returns any
PinRow(object, double)
Section titled "PinRow(object, double)"public bool PinRow(object rowID, double index = -1)Parameters
- rowID:
object - index:
double
Returns any
PinRowAsync(object, double)
Section titled "PinRowAsync(object, double)"public Task<bool> PinRowAsync(object rowID, double index = -1)Parameters
- rowID:
object - index:
double
Returns any
UnpinRow(object)
Section titled "UnpinRow(object)"public bool UnpinRow(object rowID)Parameters
- rowID:
object
Returns any
UnpinRowAsync(object)
Section titled "UnpinRowAsync(object)"public Task<bool> UnpinRowAsync(object rowID)Parameters
- rowID:
object
Returns any
Events
Section titled "Events"SelectedRowsChanged
Section titled "SelectedRowsChanged"[Parameter]
public EventCallback<object[]> SelectedRowsChanged { get; set; }FilteringExpressionsTreeChange
Section titled "FilteringExpressionsTreeChange"[Parameter]
public EventCallback<IgbFilteringExpressionsTreeEventArgs> FilteringExpressionsTreeChange { get; set; }AdvancedFilteringExpressionsTreeChange
Section titled "AdvancedFilteringExpressionsTreeChange"[Parameter]
public EventCallback<IgbFilteringExpressionsTreeEventArgs> AdvancedFilteringExpressionsTreeChange { get; set; }GridScroll
Section titled "GridScroll"[Parameter]
public EventCallback<IgbGridScrollEventArgs> GridScroll { get; set; }CellClick
Section titled "CellClick"[Parameter]
public EventCallback<IgbGridCellEventArgs> CellClick { get; set; }RowClick
Section titled "RowClick"[Parameter]
public EventCallback<IgbGridRowEventArgs> RowClick { get; set; }FormGroupCreated
Section titled "FormGroupCreated"[Parameter]
public EventCallback<IgbGridFormGroupCreatedEventArgs> FormGroupCreated { get; set; }ValidationStatusChange
Section titled "ValidationStatusChange"[Parameter]
public EventCallback<IgbGridValidationStatusEventArgs> ValidationStatusChange { get; set; }Selected
Section titled "Selected"[Parameter]
public EventCallback<IgbGridCellEventArgs> Selected { get; set; }RowSelectionChanging
Section titled "RowSelectionChanging"[Parameter]
public EventCallback<IgbRowSelectionEventArgs> RowSelectionChanging { get; set; }ColumnSelectionChanging
Section titled "ColumnSelectionChanging"[Parameter]
public EventCallback<IgbColumnSelectionEventArgs> ColumnSelectionChanging { get; set; }ColumnPin
Section titled "ColumnPin"[Parameter]
public EventCallback<IgbPinColumnCancellableEventArgs> ColumnPin { get; set; }ColumnPinned
Section titled "ColumnPinned"[Parameter]
public EventCallback<IgbPinColumnEventArgs> ColumnPinned { get; set; }CellEditEnter
Section titled "CellEditEnter"[Parameter]
public EventCallback<IgbGridEditEventArgs> CellEditEnter { get; set; }CellEditExit
Section titled "CellEditExit"[Parameter]
public EventCallback<IgbGridEditDoneEventArgs> CellEditExit { get; set; }CellEdit
Section titled "CellEdit"[Parameter]
public EventCallback<IgbGridEditEventArgs> CellEdit { get; set; }RowEditEnter
Section titled "RowEditEnter"[Parameter]
public EventCallback<IgbGridEditEventArgs> RowEditEnter { get; set; }RowEdit
Section titled "RowEdit"[Parameter]
public EventCallback<IgbGridEditEventArgs> RowEdit { get; set; }RowEditDone
Section titled "RowEditDone"[Parameter]
public EventCallback<IgbGridEditDoneEventArgs> RowEditDone { get; set; }RowEditExit
Section titled "RowEditExit"[Parameter]
public EventCallback<IgbGridEditDoneEventArgs> RowEditExit { get; set; }ColumnInit
Section titled "ColumnInit"[Parameter]
public EventCallback<IgbColumnComponentEventArgs> ColumnInit { get; set; }ColumnsAutogenerated
Section titled "ColumnsAutogenerated"[Parameter]
public EventCallback<IgbColumnsAutoGeneratedEventArgs> ColumnsAutogenerated { get; set; }Sorting
Section titled "Sorting"[Parameter]
public EventCallback<IgbSortingEventArgs> Sorting { get; set; }SortingDone
Section titled "SortingDone"[Parameter]
public EventCallback<IgbSortingExpressionEventArgs> SortingDone { get; set; }Filtering
Section titled "Filtering"[Parameter]
public EventCallback<IgbFilteringEventArgs> Filtering { get; set; }FilteringDone
Section titled "FilteringDone"[Parameter]
public EventCallback<IgbFilteringExpressionsTreeEventArgs> FilteringDone { get; set; }RowDelete
Section titled "RowDelete"[Parameter]
public EventCallback<IgbRowDataCancelableEventArgs> RowDelete { get; set; }RowAdd
Section titled "RowAdd"[Parameter]
public EventCallback<IgbRowDataCancelableEventArgs> RowAdd { get; set; }ColumnResized
Section titled "ColumnResized"[Parameter]
public EventCallback<IgbColumnResizeEventArgs> ColumnResized { get; set; }ContextMenu
Section titled "ContextMenu"[Parameter]
public EventCallback<IgbGridContextMenuEventArgs> ContextMenu { get; set; }DoubleClick
Section titled "DoubleClick"[Parameter]
public EventCallback<IgbGridCellEventArgs> DoubleClick { get; set; }ColumnVisibilityChanging
Section titled "ColumnVisibilityChanging"[Parameter]
public EventCallback<IgbColumnVisibilityChangingEventArgs> ColumnVisibilityChanging { get; set; }ColumnVisibilityChanged
Section titled "ColumnVisibilityChanged"[Parameter]
public EventCallback<IgbColumnVisibilityChangedEventArgs> ColumnVisibilityChanged { get; set; }ColumnMovingStart
Section titled "ColumnMovingStart"[Parameter]
public EventCallback<IgbColumnMovingStartEventArgs> ColumnMovingStart { get; set; }ColumnMoving
Section titled "ColumnMoving"[Parameter]
public EventCallback<IgbColumnMovingEventArgs> ColumnMoving { get; set; }ColumnMovingEnd
Section titled "ColumnMovingEnd"[Parameter]
public EventCallback<IgbColumnMovingEndEventArgs> ColumnMovingEnd { get; set; }GridKeydown
Section titled "GridKeydown"[Parameter]
public EventCallback<IgbGridKeydownEventArgs> GridKeydown { get; set; }RowDragStart
Section titled "RowDragStart"[Parameter]
public EventCallback<IgbRowDragStartEventArgs> RowDragStart { get; set; }RowDragEnd
Section titled "RowDragEnd"[Parameter]
public EventCallback<IgbRowDragEndEventArgs> RowDragEnd { get; set; }GridCopy
Section titled "GridCopy"[Parameter]
public EventCallback<IgbGridClipboardEventEventArgs> GridCopy { get; set; }SelectedRowsChange
Section titled "SelectedRowsChange"[Parameter]
public EventCallback<IgbComponentArrayDataValueChangedEventArgs> SelectedRowsChange { get; set; }ChildrenResolved
Section titled "ChildrenResolved"[Parameter]
public EventCallback<IgbVoidEventArgs> ChildrenResolved { get; set; }RowToggle
Section titled "RowToggle"[Parameter]
public EventCallback<IgbRowToggleEventArgs> RowToggle { get; set; }RowPinning
Section titled "RowPinning"[Parameter]
public EventCallback<IgbPinRowEventArgs> RowPinning { get; set; }RowPinned
Section titled "RowPinned"[Parameter]
public EventCallback<IgbPinRowEventArgs> RowPinned { get; set; }ActiveNodeChange
Section titled "ActiveNodeChange"[Parameter]
public EventCallback<IgbActiveNodeChangeEventArgs> ActiveNodeChange { get; set; }SortingExpressionsChange
Section titled "SortingExpressionsChange"[Parameter]
public EventCallback<IgbSortingExpressionEventArgs> SortingExpressionsChange { get; set; }ToolbarExporting
Section titled "ToolbarExporting"[Parameter]
public EventCallback<IgbGridToolbarExportEventArgs> ToolbarExporting { get; set; }RangeSelected
Section titled "RangeSelected"[Parameter]
public EventCallback<IgbGridSelectionRangeEventArgs> RangeSelected { get; set; }Rendered
Section titled "Rendered"[Parameter]
public EventCallback<IgbComponentBoolValueChangedEventArgs> Rendered { get; set; }DataChanging
Section titled "DataChanging"[Parameter]
public EventCallback<IgbForOfDataChangeEventArgs> DataChanging { get; set; }DataChanged
Section titled "DataChanged"[Parameter]
public EventCallback<IgbForOfDataChangeEventArgs> DataChanged { get; set; }FilteringExpressionsTreeChangeScript
Section titled "FilteringExpressionsTreeChangeScript"[Parameter]
public string FilteringExpressionsTreeChangeScript { get; set; }AdvancedFilteringExpressionsTreeChangeScript
Section titled "AdvancedFilteringExpressionsTreeChangeScript"[Parameter]
public string AdvancedFilteringExpressionsTreeChangeScript { get; set; }GridScrollScript
Section titled "GridScrollScript"[Parameter]
public string GridScrollScript { get; set; }CellClickScript
Section titled "CellClickScript"[Parameter]
public string CellClickScript { get; set; }RowClickScript
Section titled "RowClickScript"[Parameter]
public string RowClickScript { get; set; }FormGroupCreatedScript
Section titled "FormGroupCreatedScript"[Parameter]
public string FormGroupCreatedScript { get; set; }ValidationStatusChangeScript
Section titled "ValidationStatusChangeScript"[Parameter]
public string ValidationStatusChangeScript { get; set; }SelectedScript
Section titled "SelectedScript"[Parameter]
public string SelectedScript { get; set; }RowSelectionChangingScript
Section titled "RowSelectionChangingScript"[Parameter]
public string RowSelectionChangingScript { get; set; }ColumnSelectionChangingScript
Section titled "ColumnSelectionChangingScript"[Parameter]
public string ColumnSelectionChangingScript { get; set; }ColumnPinScript
Section titled "ColumnPinScript"[Parameter]
public string ColumnPinScript { get; set; }ColumnPinnedScript
Section titled "ColumnPinnedScript"[Parameter]
public string ColumnPinnedScript { 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; }RowEditEnterScript
Section titled "RowEditEnterScript"[Parameter]
public string RowEditEnterScript { get; set; }RowEditScript
Section titled "RowEditScript"[Parameter]
public string RowEditScript { get; set; }RowEditDoneScript
Section titled "RowEditDoneScript"[Parameter]
public string RowEditDoneScript { get; set; }RowEditExitScript
Section titled "RowEditExitScript"[Parameter]
public string RowEditExitScript { get; set; }ColumnInitScript
Section titled "ColumnInitScript"[Parameter]
public string ColumnInitScript { get; set; }ColumnsAutogeneratedScript
Section titled "ColumnsAutogeneratedScript"[Parameter]
public string ColumnsAutogeneratedScript { get; set; }SortingScript
Section titled "SortingScript"[Parameter]
public string SortingScript { get; set; }SortingDoneScript
Section titled "SortingDoneScript"[Parameter]
public string SortingDoneScript { get; set; }FilteringScript
Section titled "FilteringScript"[Parameter]
public string FilteringScript { get; set; }FilteringDoneScript
Section titled "FilteringDoneScript"[Parameter]
public string FilteringDoneScript { get; set; }RowDeleteScript
Section titled "RowDeleteScript"[Parameter]
public string RowDeleteScript { get; set; }RowAddScript
Section titled "RowAddScript"[Parameter]
public string RowAddScript { get; set; }ColumnResizedScript
Section titled "ColumnResizedScript"[Parameter]
public string ColumnResizedScript { get; set; }ContextMenuScript
Section titled "ContextMenuScript"[Parameter]
public string ContextMenuScript { get; set; }DoubleClickScript
Section titled "DoubleClickScript"[Parameter]
public string DoubleClickScript { get; set; }ColumnVisibilityChangingScript
Section titled "ColumnVisibilityChangingScript"[Parameter]
public string ColumnVisibilityChangingScript { get; set; }ColumnVisibilityChangedScript
Section titled "ColumnVisibilityChangedScript"[Parameter]
public string ColumnVisibilityChangedScript { get; set; }ColumnMovingStartScript
Section titled "ColumnMovingStartScript"[Parameter]
public string ColumnMovingStartScript { get; set; }ColumnMovingScript
Section titled "ColumnMovingScript"[Parameter]
public string ColumnMovingScript { get; set; }ColumnMovingEndScript
Section titled "ColumnMovingEndScript"[Parameter]
public string ColumnMovingEndScript { get; set; }GridKeydownScript
Section titled "GridKeydownScript"[Parameter]
public string GridKeydownScript { get; set; }RowDragStartScript
Section titled "RowDragStartScript"[Parameter]
public string RowDragStartScript { get; set; }RowDragEndScript
Section titled "RowDragEndScript"[Parameter]
public string RowDragEndScript { get; set; }GridCopyScript
Section titled "GridCopyScript"[Parameter]
public string GridCopyScript { get; set; }SelectedRowsChangeScript
Section titled "SelectedRowsChangeScript"[Parameter]
public string SelectedRowsChangeScript { get; set; }ChildrenResolvedScript
Section titled "ChildrenResolvedScript"[Parameter]
public string ChildrenResolvedScript { get; set; }RowToggleScript
Section titled "RowToggleScript"[Parameter]
public string RowToggleScript { get; set; }RowPinningScript
Section titled "RowPinningScript"[Parameter]
public string RowPinningScript { get; set; }RowPinnedScript
Section titled "RowPinnedScript"[Parameter]
public string RowPinnedScript { get; set; }ActiveNodeChangeScript
Section titled "ActiveNodeChangeScript"[Parameter]
public string ActiveNodeChangeScript { get; set; }SortingExpressionsChangeScript
Section titled "SortingExpressionsChangeScript"[Parameter]
public string SortingExpressionsChangeScript { get; set; }ToolbarExportingScript
Section titled "ToolbarExportingScript"[Parameter]
public string ToolbarExportingScript { get; set; }RangeSelectedScript
Section titled "RangeSelectedScript"[Parameter]
public string RangeSelectedScript { get; set; }RenderedScript
Section titled "RenderedScript"[Parameter]
public string RenderedScript { get; set; }DataChangingScript
Section titled "DataChangingScript"[Parameter]
public string DataChangingScript { get; set; }DataChangedScript
Section titled "DataChangedScript"[Parameter]
public string DataChangedScript { get; set; }