Back to Devexpress

BootstrapClientGridView Methods

aspnetbootstrap-js-bootstrapclientgridview-dot-underscore-methods.md

latest24.6 KB
Original Source

BootstrapClientGridView Methods

Represents the client BootstrapGridView.

NameDescription
AddNewRowAdds a new record. Inherited from ASPxClientGridView.
AdjustControlModifies the control’s size against the control’s container. Inherited from ASPxClientControl.
AdjustControls staticModifies the controls size within the specified container. Inherited from ASPxClientControl.
ApplyFilter(filterExpression)Applies the specified filter expression to the GridView. Inherited from ASPxClientGridView.
ApplyOnClickRowFilterApplies a filter specified in the filter row to the GridView. Inherited from ASPxClientGridView.
ApplySearchPanelFilter(value)Applies the specified search panel filter criterion to grid data. Inherited from ASPxClientGridView.
AutoFilterByColumn(column, val)Applies a filter to the specified data column. Inherited from ASPxClientGridView.
CancelEditCancels all the changes made and switches the GridView to browse mode. Inherited from ASPxClientGridView.
Cast(obj) staticConverts the specified object to the ASPxClientGridView type. Inherited from ASPxClientGridView.
ClearFilterClears the filter expression applied to a client GridView. Inherited from ASPxClientGridView.
CloseFilterControlHides the Filter Control. Inherited from ASPxClientGridView.
CollapseAllCollapses all group rows. Inherited from ASPxClientGridView.
CollapseAllDetailRowsCollapses all detail rows. Inherited from ASPxClientGridView.
CollapseDetailRow(visibleIndex)Collapses the specified detail row. Inherited from ASPxClientGridView.
CollapseRow(visibleIndex)Collapses the specified group row and optionally its child group rows at all nesting levels. Inherited from ASPxClientGridView.
DeleteRow(visibleIndex)Deletes the specified row. Inherited from ASPxClientGridView.
DeleteRowByKey(key)Deletes a row with the specified key value. Inherited from ASPxClientGridView.
ExpandAllExpands all group rows. Inherited from ASPxClientGridView.
ExpandAllDetailRowsExpands all detail rows. Inherited from ASPxClientGridView.
ExpandDetailRow(visibleIndex)Expands the specified detail row. Inherited from ASPxClientGridView.
ExpandRow(visibleIndex)Expands the specified group row and optionally its child group rows at all nesting levels. Inherited from ASPxClientGridView.
ExportTo(format)Exports a grid data to a file in the specified format. Inherited from ASPxClientGridView.
FocusSets input focus to the grid. Inherited from ASPxClientGridView.
FocusEditor(column)Moves focus to the specified edit cell within the edited row. Inherited from ASPxClientGridView.
GetAutoFilterEditor(column)Returns the editor used to edit the value in the auto filter row for the specified data column. Inherited from ASPxClientGridView.
GetClientVisibleObsolete. Returns a value specifying whether a control is displayed. Inherited from ASPxClientControlBase.
GetColumn(columnIndex)Returns the client column that resides at the specified position within the column collection. Inherited from ASPxClientGridView.
GetColumnByField(columnFieldName)Returns the client column which is bound to the specified data source field. Inherited from ASPxClientGridView.
GetColumnById(columnId)Returns the column with the specified unique identifier. Inherited from ASPxClientGridView.
GetColumnCountReturns the number of columns within the client GridView. Inherited from ASPxClientGridView.
GetColumnLayoutReturns an object specifying the grid column’s layout. Inherited from ASPxClientGridView.
GetControlCollection staticReturns a collection of client web control objects. Inherited from ASPxClientControl.
GetEditor(column)Returns the editor used to edit the specified column’s values. Inherited from ASPxClientGridView.
GetEditValue(column)Returns the value of the specified edit cell. Inherited from ASPxClientGridView.
GetFocusedRowIndexReturns the index of the focused row. Inherited from ASPxClientGridView.
GetHeightReturns the control’s height. Inherited from ASPxClientControl.
GetHorizontalScrollPositionReturns the current horizontal scroll position of the grid’s content. Inherited from ASPxClientGridView.
GetHorzScrollPosObsolete. Returns the current horizontal scroll position of the grid’s content. Inherited from ASPxClientGridView.
GetMainElementReturns an HTML element that is the root of the control’s hierarchy. Inherited from ASPxClientControlBase.
GetPageCountGets the number of pages to which the grid’s data is divided. Inherited from ASPxClientGridView.
GetPageIndexGets the index of the page currently being selected. Inherited from ASPxClientGridView.
GetPageRowValues(fieldNames, onCallback)Returns the row values displayed within the current page. Inherited from ASPxClientGridView.
GetParentControlReturns a client instance of the control that is the parent for a specified control. Inherited from ASPxClientControlBase.
GetPopupEditFormGets the Popup Edit Form. Inherited from ASPxClientGridView.
GetRowIndicesVisibleInViewPort(includePartiallyVisible)Returns a value specifying the indices of the rows visible in the browser’s view port. Inherited from ASPxClientGridView.
GetRowKey(visibleIndex)Returns the key value of the specified data row. Inherited from ASPxClientGridView.
GetRowValues(visibleIndex, fieldNames, onCallback)Returns the value(s) of the specified data source field(s) in the specified row. Inherited from ASPxClientGridView.
GetSelectedFieldValues(fieldNames, onCallback)Returns the values of the specified fields within selected rows. Inherited from ASPxClientGridView.
GetSelectedKeysOnPageReturns the key values of selected rows. Inherited from ASPxClientGridView.
GetSelectedRowCountReturns the number of selected rows. Inherited from ASPxClientGridView.
GetToolbar(index)Returns a grid’s toolbar specified by its index. Inherited from ASPxClientGridBase.
GetToolbarByName(name)Returns a toolbar specified by its name. Inherited from ASPxClientGridBase.
GetTopVisibleIndexReturns the index of the first data row displayed within the GridView’s active page. Inherited from ASPxClientGridView.
GetValuesOnCustomCallback(args, onCallback)Sends a callback to the server and generates the server-side ASPxGridView.CustomDataCallback event. Inherited from ASPxClientGridView.
GetVerticalScrollPositionReturns the current vertical scroll position of the grid’s content. Inherited from ASPxClientGridView.
GetVertScrollPosObsolete. Returns the current vertical scroll position of the grid’s content. Inherited from ASPxClientGridView.
GetVisibleReturns a value specifying whether a control is displayed. Inherited from ASPxClientControlBase.
GetVisibleRowsOnPageReturns the number of rows actually displayed within the active page. Inherited from ASPxClientGridView.
GetWidthReturns the control’s width. Inherited from ASPxClientControl.
GotoPage(pageIndex)Selects the specified page. Inherited from ASPxClientGridView.
GroupBy(column)Groups data by the values of the specified data column. Inherited from ASPxClientGridView.
HideCustomizationWindowCloses the Customization Window. Inherited from ASPxClientGridView.
InCallbackReturns a value that determines whether a callback request sent by a web control is being currently processed on the server side. Inherited from ASPxClientControlBase.
IsCustomizationWindowVisibleIndicates whether the Customization Window is displayed. Inherited from ASPxClientGridView.
IsDataRow(visibleIndex)Indicates whether the specified row is a data row. Inherited from ASPxClientGridView.
IsEditingIndicates whether the grid is in edit mode. Inherited from ASPxClientGridView.
IsGroupRow(visibleIndex)Indicates whether the specified row is a group row. Inherited from ASPxClientGridView.
IsGroupRowExpanded(visibleIndex)Indicates whether the specified group row is expanded. Inherited from ASPxClientGridView.
IsNewRowEditingIndicates whether or not a new row is being edited. Inherited from ASPxClientGridView.
IsRowSelectedOnPage(visibleIndex)Indicates whether the specified row is selected. Inherited from ASPxClientGridView.
MakeRowVisible(visibleIndex)Scrolls the view to the specified row. Inherited from ASPxClientGridView.
MoveColumn(column)Moves the specified column to the specified visual position within the grid and optionally groups or ungroups the grid’s data by this column. Inherited from ASPxClientGridView.
NextPageActivates the next page. Inherited from ASPxClientGridView.
PerformCallback(args)Sends a callback to the server and generates the server-side event, passing the specified argument to it. Inherited from ASPxClientGridView.
PrevPageActivates the previous page. Inherited from ASPxClientGridView.
RefreshUpdates grid data. Inherited from ASPxClientGridView.
SelectAllRowsOnPageSelects or deselects the rows on the current page. Inherited from ASPxClientGridView.
SelectRowOnPage(visibleIndex)Selects or deselects the row specified by its visible index. Inherited from ASPxClientGridView.
SelectRowsSelects or deselects rows. Inherited from ASPxClientGridView.
SelectRowsByKey(keys)Selects or deselects the rows specified by their key values. Inherited from ASPxClientGridView.
SendMessageToAssistiveTechnology(message)Specifies the text that Assistive Technologies (screen readers or braille display, for example) will provide to a user. Inherited from ASPxClientControlBase.
SetClientVisible(visible)Obsolete. Specifies whether a control is displayed. Inherited from ASPxClientControlBase.
SetColumnLayout(columnLayout)Applies the specified column layout to the grid. Inherited from ASPxClientGridView.
SetEditValue(column, value)Sets the value of the specified edit cell. Inherited from ASPxClientGridView.
SetFilterEnabled(isFilterEnabled)Enables or disables the current filter. Inherited from ASPxClientGridView.
SetFixedColumnScrollableRows(scrollableRowSettings)Sets the scrollability of various types of grid rows when the grid displays fixed columns. Inherited from ASPxClientGridView.
SetFocusedRowIndex(visibleIndex)Moves focus to the specified row. Inherited from ASPxClientGridView.
SetHeight(height)

Specifies the control’s height. Note that this method is not in effect for some controls.

Inherited from ASPxClientControl. | | SetHorizontalScrollPosition(position) | Specifies the horizontal scroll position for the grid’s content. Inherited from ASPxClientGridView. | | SetHorzScrollPos(position) | Obsolete. Specifies the horizontal scroll position for the grid’s content. Inherited from ASPxClientGridView. | | SetSearchPanelCustomEditor(editor) | Specifies a custom editor for the search panel on the client side. Inherited from ASPxClientGridView. | | SetVerticalScrollPosition(position) | Specifies the vertical scroll position for the grid’s content. Inherited from ASPxClientGridView. | | SetVertScrollPos(position) | Obsolete. Specifies the vertical scroll position for the grid’s content. Inherited from ASPxClientGridView. | | SetVisible(visible) | Specifies whether a control is displayed. Inherited from ASPxClientControlBase. | | SetWidth(width) | Specifies the control’s width in pixels. Inherited from ASPxClientControl. | | ShowCustomizationDialog | Invokes the Customization Dialog and displays it over the grid. Inherited from ASPxClientGridView. | | ShowCustomizationWindow | Invokes the Customization Window and displays it over the specified HTML element. Inherited from ASPxClientGridView. | | ShowFilterControl | Displays the Filter Control. Inherited from ASPxClientGridView. | | SortBy(column) | Sorts data by the values of the specified data column. Inherited from ASPxClientGridView. | | StartEditRow(visibleIndex) | Switches the grid to edit mode. Inherited from ASPxClientGridView. | | StartEditRowByKey(key) | Switches the grid to edit mode. Inherited from ASPxClientGridView. | | Ungroup(column) | Ungroups data by the values of a specified column. Inherited from ASPxClientGridView. | | UnGroup(column) | Obsolete. Clears grouping applied to the specified column. Inherited from ASPxClientGridView. | | UnselectAllRowsOnPage | Deselects the rows on the current page. Inherited from ASPxClientGridView. | | UnselectFilteredRows | Deselects the rows that match the applied filter criteria. Inherited from ASPxClientGridView. | | UnselectRowOnPage(visibleIndex) | Deselects the row specified by its visible index. Inherited from ASPxClientGridView. | | UnselectRows | Deselects rows. Inherited from ASPxClientGridView. | | UnselectRowsByKey(keys) | Deselects the rows specified by their key values. Inherited from ASPxClientGridView. | | UpdateEdit | Saves changes and switches the grid to browse mode. Inherited from ASPxClientGridView. |

See Also

BootstrapClientGridView Class

BootstrapClientGridView Members