MVCxClientGridView Members
A client-side counterpart of the GridView extension.Properties
| Name | Description |
|---|---|
| batchEditApi | Provides access to the batch editing client API. Inherited from ASPxClientGridView. |
| name | Gets the unique, hierarchically-qualified identifier for the control. Inherited from ASPxClientControlBase. |
Methods
| Name | Description |
|---|---|
| AddNewRow | Adds a new record. Inherited from ASPxClientGridView. |
| 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. Inherited from ASPxClientGridView. |
| ApplyOnClickRowFilter | Applies 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. |
| CancelEdit | Cancels all the changes made and switches the GridView to browse mode. Inherited from ASPxClientGridView. |
| Cast(obj) static | Converts the specified object to the MVCxClientGridView type. |
| ClearFilter | Clears the filter expression applied to a client GridView. Inherited from ASPxClientGridView. |
| CloseFilterControl | Hides the Filter Control. Inherited from ASPxClientGridView. |
| CollapseAll | Collapses all group rows. Inherited from ASPxClientGridView. |
| CollapseAllDetailRows | Collapses 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. |
| ExpandAll | Expands all group rows. Inherited from ASPxClientGridView. |
| ExpandAllDetailRows | Expands 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. |
| Focus | Sets 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. |
| 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. 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. |
| GetColumnCount | Returns the number of columns within the client GridView. Inherited from ASPxClientGridView. |
| GetColumnLayout | Returns an object specifying the grid column’s layout. Inherited from ASPxClientGridView. |
| GetControlCollection static | Returns a collection of client web control objects. Inherited from ASPxClientControl. |
| GetEditFormLayout | Returns the edit form layout. Inherited from ASPxClientGridView. |
| GetEditFormLayoutItemByColumn(column) | Returns the form layout item. Inherited from ASPxClientGridView. |
| GetEditFormLayoutItemOrGroup(name) | Returns the form layout item or group. Inherited from ASPxClientGridView. |
| 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. |
| GetFocusedRowIndex | Returns the index of the focused row. Inherited from ASPxClientGridView. |
| GetHeight | Returns the control’s height. Inherited from ASPxClientControl. |
| GetHorizontalScrollPosition | Returns the current horizontal scroll position of the grid’s content. Inherited from ASPxClientGridView. |
| GetHorzScrollPos | Obsolete. Returns the current horizontal scroll position of the grid’s content. Inherited from ASPxClientGridView. |
| 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. Inherited from ASPxClientGridView. |
| GetPageIndex | Gets 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. |
| 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. 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. |
| GetSelectedKeysOnPage | Returns the key values of selected rows. Inherited from ASPxClientGridView. |
| GetSelectedRowCount | Returns 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. |
| GetTopVisibleIndex | Returns the index of the first data row displayed within the GridView’s active page. Inherited from ASPxClientGridView. |
| GetValuesOnCustomCallback(data, onCallback) | Sends a callback with a parameter to process the passed information on the server, in an Action specified via the GridView’s GridSettingsBase.CustomDataActionRouteValues property, and then process the returned result in the specified client function. This method does not update the GridView. |
| GetVerticalScrollPosition | Returns the current vertical scroll position of the grid’s content. Inherited from ASPxClientGridView. |
| GetVertScrollPos | Obsolete. Returns the current vertical scroll position of the grid’s content. Inherited from ASPxClientGridView. |
| 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. Inherited from ASPxClientGridView. |
| GetWidth | Returns 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. |
| HideCustomizationWindow | Closes the Customization Window. Inherited from ASPxClientGridView. |
| 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. Inherited from ASPxClientGridView. |
| IsDataRow(visibleIndex) | Indicates whether the specified row is a data row. Inherited from ASPxClientGridView. |
| IsEditing | Indicates 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. |
| IsNewRowEditing | Indicates 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. |
| NextPage | Activates the next page. Inherited from ASPxClientGridView. |
| PerformCallback(data) | Sends a callback with a parameter to update the GridView by processing the passed information on the server, in an Action specified via the grid’s GridSettingsBase.CustomActionRouteValues property. |
| PrevPage | Activates the previous page. Inherited from ASPxClientGridView. |
| Refresh | Updates grid data. Inherited from ASPxClientGridView. |
| SelectAllRowsOnPage | Selects 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. |
| SelectRows | Selects 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. |
Events
| Name | Description |
|---|---|
| BatchEditChangesCanceling | Fires before the grid discards changes in batch edit mode. Inherited from ASPxClientGridView. |
| BatchEditChangesPreviewShowing | Fires before the grid switches to Preview Changes mode. Inherited from ASPxClientGridView. |
| BatchEditChangesPreviewShown | Fires after the grid switches to Preview Changes mode. Inherited from ASPxClientGridView. |
| BatchEditChangesSaving | Fires before the grid saves batch changes and allows you to discard them. Inherited from ASPxClientGridView. |
| BatchEditConfirmShowing | Fires before the grid shows the Confirmation dialog box. Inherited from ASPxClientGridView. |
| BatchEditEndEditing | Fires before a cell/row switches from edit to browse mode. Inherited from ASPxClientGridView. |
| BatchEditRowChangesCanceling | Fires when a user clicks a row’s Cancel button in batch edit mode. Inherited from ASPxClientGridView. |
| BatchEditRowDeleting | Fires on the client side before a data row is marked as deleted in batch edit mode. Inherited from ASPxClientGridView. |
| BatchEditRowInserting | Fires before a data row is inserted in batch edit mode. Inherited from ASPxClientGridView. |
| BatchEditRowRecovering | Fires on the client side before a data row is recovered in batch edit mode. Inherited from ASPxClientGridView. |
| BatchEditRowValidating | Fires to validate data on the client side and allows you to implement custom validation rules. Inherited from ASPxClientGridView. |
| BatchEditStartEditing | Fires when a cell/row switches to batch edit mode and allows you to disable cell/row editing. Inherited from ASPxClientGridView. |
| BatchEditSummaryDisplayText | Fires when a user changes the summary item value. Inherited from ASPxClientGridBase. |
| BatchEditTemplateCellFocused | Enables you to provide navigation for editors contained in a templated cell in Batch Edit mode. Inherited from ASPxClientGridView. |
| BeginCallback | Occurs when a callback for server-side processing is initiated. |
| CallbackError | Fires on the client if any unhandled server error occurs during server-side processing of a callback sent by the ASPxClientGridView. Inherited from ASPxClientGridView. |
| CellSelectionChanging | Occurs when you select or deselect a cell. Inherited from ASPxClientGridView. |
| ClipboardCellPasting | Occurs before a cell is pasted to the control from the clipboard. Allows you to update the pasted data or skip a cell. Inherited from ASPxClientGridView. |
| ColumnGrouping | Fires before the grid groups its data by column values. Inherited from ASPxClientGridView. |
| ColumnMoving | Enables you to control column movement. Inherited from ASPxClientGridView. |
| ColumnResized | Occurs after a column’s width has been changed by an end-user. Inherited from ASPxClientGridView. |
| ColumnResizing | Enables you to prevent columns from being resized. Inherited from ASPxClientGridView. |
| ColumnSorting | Fires before the grid sorts its data by column values. Inherited from ASPxClientGridView. |
| ColumnStartDragging | Fires when an end-user starts dragging the column’s header and enables you to cancel this operation. Inherited from ASPxClientGridView. |
| ContextMenu | Occurs after an end-user right clicks in the GridView, and enables you to provide a custom context menu. Inherited from ASPxClientGridView. |
| ContextMenuItemClick | Fires on the client side when a context menu item has been clicked. Inherited from ASPxClientGridView. |
| CustomButtonClick | Occurs when a user clicks a custom command button. Inherited from ASPxClientGridView. |
| CustomizationWindowCloseUp | Fires after the Customization Window has been closed. Inherited from ASPxClientGridView. |
| DetailRowCollapsing | Fires before a detail row is collapsed. Inherited from ASPxClientGridView. |
| DetailRowExpanding | Fires before a detail row is expanded. Inherited from ASPxClientGridView. |
| EndCallback | Occurs on the client after a callback’s server-side processing has been completed. Inherited from ASPxClientGridView. |
| FocusedCellChanging | Fires before the focused cell is changed. Inherited from ASPxClientGridView. |
| FocusedRowChanged | Fires when the row focus changes. Inherited from ASPxClientGridView. |
| Init | Occurs on the client side after the control has been initialized. Inherited from ASPxClientControlBase. |
| KeyDown | Occurs when a user presses a key while the control has focus. Inherited from ASPxClientGridBase. |
| KeyPress | Occurs when a user presses and releases a key while the control has focus. Inherited from ASPxClientGridBase. |
| KeyUp | Occurs when a user releases the pressed key while the control has focus. Inherited from ASPxClientGridBase. |
| RowClick | Fires when a user clicks a data row. Inherited from ASPxClientGridView. |
| RowCollapsing | Fires when a user collapses a group row. Inherited from ASPxClientGridView. |
| RowDblClick | Fires when a user double-clicks a data row. Inherited from ASPxClientGridView. |
| RowExpanding | Fires when a user expands a group row. Inherited from ASPxClientGridView. |
| RowFocusing | Fires before a row has been focused. Inherited from ASPxClientGridView. |
| SelectionChanged | Fires when the row selection changes. Inherited from ASPxClientGridView. |
| ToolbarItemClick | Fires after a toolbar item has been clicked. Inherited from ASPxClientGridBase. |
See Also