aspnet-js-aspxclientgridview-dot-underscore-methods.md
A client-side equivalent of the ASPxGridView object.
| Name | Description |
|---|---|
| AddNewRow | Adds a new record. |
| AdjustControl | Modifies the control’s size against the control’s container. Inherited from ASPxClientControl. |
| AdjustControls static | Modifies the controls size within the specified container. Inherited from ASPxClientControl. |
| ApplyFilter(filterExpression) | Applies the specified filter expression to the GridView. |
| ApplyOnClickRowFilter | Applies a filter specified in the filter row to the GridView. |
| ApplySearchPanelFilter(value) | Applies the specified search panel filter criterion to grid data. |
| AutoFilterByColumn(column, val) | Applies a filter to the specified data column. |
| CancelEdit | Cancels all the changes made and switches the GridView to browse mode. |
| Cast(obj) static | Converts the specified object to the ASPxClientGridView type. |
| ClearFilter | Clears the filter expression applied to a client GridView. |
| CloseFilterControl | Hides the Filter Control. |
| CollapseAll | Collapses all group rows. |
| CollapseAllDetailRows | Collapses all detail rows. |
| CollapseDetailRow(visibleIndex) | Collapses the specified detail row. |
| CollapseRow(visibleIndex) | Collapses the specified group row and optionally its child group rows at all nesting levels. |
| DeleteRow(visibleIndex) | Deletes the specified row. |
| DeleteRowByKey(key) | Deletes a row with the specified key value. |
| ExpandAll | Expands all group rows. |
| ExpandAllDetailRows | Expands all detail rows. |
| ExpandDetailRow(visibleIndex) | Expands the specified detail row. |
| ExpandRow(visibleIndex) | Expands the specified group row and optionally its child group rows at all nesting levels. |
| ExportTo(format) | Exports a grid data to a file in the specified format. |
| Focus | Sets input focus to the grid. |
| FocusEditor(column) | Moves focus to the specified edit cell within the edited row. |
| GetAutoFilterEditor(column) | Returns the editor used to edit the value in the auto filter row for the specified data column. |
| GetClientVisible | Obsolete. 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. |
| GetColumnByField(columnFieldName) | Returns the client column which is bound to the specified data source field. |
| GetColumnById(columnId) | Returns the column with the specified unique identifier. |
| GetColumnCount | Returns the number of columns within the client GridView. |
| GetColumnLayout | Returns an object specifying the grid column’s layout. |
| GetControlCollection static | Returns a collection of client web control objects. Inherited from ASPxClientControl. |
| GetEditFormLayout | Returns the edit form layout. |
| GetEditFormLayoutItemByColumn(column) | Returns the form layout item. |
| GetEditFormLayoutItemOrGroup(name) | Returns the form layout item or group. |
| GetEditor(column) | Returns the editor used to edit the specified column’s values. |
| GetEditValue(column) | Returns the value of the specified edit cell. |
| GetFocusedRowIndex | Returns the index of the focused row. |
| GetHeight | Returns the control’s height. Inherited from ASPxClientControl. |
| GetHorizontalScrollPosition | Returns the current horizontal scroll position of the grid’s content. |
| GetHorzScrollPos | Obsolete. Returns the current horizontal scroll position of the grid’s content. |
| GetMainElement | Returns an HTML element that is the root of the control’s hierarchy. Inherited from ASPxClientControlBase. |
| GetPageCount | Gets the number of pages to which the grid’s data is divided. |
| GetPageIndex | Gets the index of the page currently being selected. |
| GetPageRowValues(fieldNames, onCallback) | Returns the row values displayed within the current page. |
| GetParentControl | Returns a client instance of the control that is the parent for a specified control. Inherited from ASPxClientControlBase. |
| GetPopupEditForm | Gets the Popup Edit Form. |
| GetRowIndicesVisibleInViewPort(includePartiallyVisible) | Returns a value specifying the indices of the rows visible in the browser’s view port. |
| GetRowKey(visibleIndex) | Returns the key value of the specified data row. |
| GetRowValues(visibleIndex, fieldNames, onCallback) | Returns the value(s) of the specified data source field(s) in the specified row. |
| GetSelectedFieldValues(fieldNames, onCallback) | Returns the values of the specified fields within selected rows. |
| GetSelectedKeysOnPage | Returns the key values of selected rows. |
| GetSelectedRowCount | Returns the number of selected rows. |
| 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. |
| GetTopVisibleIndex | Returns the index of the first data row displayed within the GridView’s active page. |
| GetValuesOnCustomCallback(args, onCallback) | Sends a callback to the server and generates the server-side ASPxGridView.CustomDataCallback event. |
| GetVerticalScrollPosition | Returns the current vertical scroll position of the grid’s content. |
| GetVertScrollPos | Obsolete. Returns the current vertical scroll position of the grid’s content. |
| GetVisible | Returns a value specifying whether a control is displayed. Inherited from ASPxClientControlBase. |
| GetVisibleRowsOnPage | Returns the number of rows actually displayed within the active page. |
| GetWidth | Returns the control’s width. Inherited from ASPxClientControl. |
| GotoPage(pageIndex) | Selects the specified page. |
| GroupBy(column) | Groups data by the values of the specified data column. |
| HideCustomizationWindow | Closes the Customization Window. |
| InCallback | Returns a value that determines whether a callback request sent by a web control is being currently processed on the server side. Inherited from ASPxClientControlBase. |
| IsCustomizationWindowVisible | Indicates whether the Customization Window is displayed. |
| IsDataRow(visibleIndex) | Indicates whether the specified row is a data row. |
| IsEditing | Indicates whether the grid is in edit mode. |
| IsGroupRow(visibleIndex) | Indicates whether the specified row is a group row. |
| IsGroupRowExpanded(visibleIndex) | Indicates whether the specified group row is expanded. |
| IsNewRowEditing | Indicates whether or not a new row is being edited. |
| IsRowSelectedOnPage(visibleIndex) | Indicates whether the specified row is selected. |
| MakeRowVisible(visibleIndex) | Scrolls the view to the specified row. |
| 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. |
| NextPage | Activates the next page. |
| PerformCallback(args) | Sends a callback to the server and generates the server-side event, passing the specified argument to it. |
| PrevPage | Activates the previous page. |
| Refresh | Updates grid data. |
| SelectAllRowsOnPage | Selects or deselects the rows on the current page. |
| SelectRowOnPage(visibleIndex) | Selects or deselects the row specified by its visible index. |
| SelectRows | Selects or deselects rows. |
| SelectRowsByKey(keys) | Selects or deselects the rows specified by their key values. |
| 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. |
| SetEditValue(column, value) | Sets the value of the specified edit cell. |
| SetFilterEnabled(isFilterEnabled) | Enables or disables the current filter. |
| SetFixedColumnScrollableRows(scrollableRowSettings) | Sets the scrollability of various types of grid rows when the grid displays fixed columns. |
| SetFocusedRowIndex(visibleIndex) | Moves focus to the specified row. |
| 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. | | SetHorzScrollPos(position) | Obsolete. Specifies the horizontal scroll position for the grid’s content. | | SetSearchPanelCustomEditor(editor) | Specifies a custom editor for the search panel on the client side. | | SetVerticalScrollPosition(position) | Specifies the vertical scroll position for the grid’s content. | | SetVertScrollPos(position) | Obsolete. Specifies the vertical scroll position for the grid’s content. | | 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. | | ShowCustomizationWindow | Invokes the Customization Window and displays it over the specified HTML element. | | ShowFilterControl | Displays the Filter Control. | | SortBy(column) | Sorts data by the values of the specified data column. | | StartEditRow(visibleIndex) | Switches the grid to edit mode. | | StartEditRowByKey(key) | Switches the grid to edit mode. | | Ungroup(column) | Ungroups data by the values of a specified column. | | UnGroup(column) | Obsolete. Clears grouping applied to the specified column. | | UnselectAllRowsOnPage | Deselects the rows on the current page. | | UnselectFilteredRows | Deselects the rows that match the applied filter criteria. | | UnselectRowOnPage(visibleIndex) | Deselects the row specified by its visible index. | | UnselectRows | Deselects rows. | | UnselectRowsByKey(keys) | Deselects the rows specified by their key values. | | UpdateEdit | Saves changes and switches the grid to browse mode. |
See Also