MVCxClientVerticalGrid Members
A client-side counterpart of the VerticalGrid extension.Properties
| Name | Description |
|---|---|
| batchEditApi | Provides access to the batch editing client API. Inherited from ASPxClientVerticalGrid. |
| name | Gets the unique, hierarchically-qualified identifier for the control. Inherited from ASPxClientControlBase. |
Methods
| Name | Description |
|---|---|
| AddNewRecord | Adds a new record. Inherited from ASPxClientVerticalGrid. |
| 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 ASPxVerticalGrid. Inherited from ASPxClientVerticalGrid. |
| ApplySearchPanelFilter(value) | Applies the specified search panel filter criterion to grid data. Inherited from ASPxClientVerticalGrid. |
| CancelEdit | Cancels all the changes made and switches the ASPxVerticalGrid to browse mode. Inherited from ASPxClientVerticalGrid. |
| Cast(obj) static | Converts the specified object to the MVCxClientVerticalGrid type. |
| ClearFilter | Clears the filter expression applied to a client vertical grid. Inherited from ASPxClientVerticalGrid. |
| CloseFilterControl | Hides the Filter Control. Inherited from ASPxClientVerticalGrid. |
| DeleteRecord(visibleIndex) | Deletes the specified record. Inherited from ASPxClientVerticalGrid. |
| DeleteRecordByKey(key) | Deletes a record with the specified key value. Inherited from ASPxClientVerticalGrid. |
| ExportTo(format) | Exports a grid data to a file in the specified format. Inherited from ASPxClientVerticalGrid. |
| Focus | Sets input focus to the grid. Inherited from ASPxClientVerticalGrid. |
| GetClientVisible | Obsolete. Returns a value specifying whether a control is displayed. Inherited from ASPxClientControlBase. |
| GetControlCollection static | Returns a collection of client web control objects. Inherited from ASPxClientControl. |
| GetEditor(row) | Returns the editor used to edit the specified row’s values. Inherited from ASPxClientVerticalGrid. |
| GetHeight | Returns the control’s height. Inherited from ASPxClientControl. |
| GetHorizontalScrollPosition | Returns the current horizontal scroll position of the grid’s content. Inherited from ASPxClientVerticalGrid. |
| 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 ASPxClientVerticalGrid. |
| GetPageIndex | Gets the index of the page currently being selected. Inherited from ASPxClientVerticalGrid. |
| GetPageRecordValues(fieldNames, onCallback) | Returns the record values displayed within the current page. Inherited from ASPxClientVerticalGrid. |
| GetParentControl | Returns a client instance of the control that is the parent for a specified control. Inherited from ASPxClientControlBase. |
| GetRecordKey(visibleIndex) | Returns the key value of the specified data row (record in the vertical grid). Inherited from ASPxClientVerticalGrid. |
| GetRecordValues(visibleIndex, fieldNames, onCallback) | Returns the values of the specified data source fields within the specified record. Inherited from ASPxClientVerticalGrid. |
| GetRow(rowIndex) | Returns the client row that resides at the specified position within the row collection. Inherited from ASPxClientVerticalGrid. |
| GetRowByField(rowFieldName) | Returns the client row which is bound to the specified data source field. Inherited from ASPxClientVerticalGrid. |
| GetRowById(rowId) | Returns the row with the specified unique identifier. Inherited from ASPxClientVerticalGrid. |
| GetRowCount | Returns the number of rows within the client vertical grid. Inherited from ASPxClientVerticalGrid. |
| GetRowExpanded(row) | Gets the value that specifies whether the required row is expanded. Inherited from ASPxClientVerticalGrid. |
| GetSelectedFieldValues(fieldNames, onCallback) | Returns the record values displayed within all selected records. Inherited from ASPxClientVerticalGrid. |
| GetSelectedKeysOnPage | Returns key values of selected records displayed within the current page. Inherited from ASPxClientVerticalGrid. |
| GetSelectedRecordCount | Returns the number of selected records. Inherited from ASPxClientVerticalGrid. |
| 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 record displayed within the vertical grid’s active page. Inherited from ASPxClientVerticalGrid. |
| GetValuesOnCustomCallback(data, onCallback) | Sends a callback with a parameter to process the passed information on the server, in an Action specified via the VerticalGrid’s GridSettingsBase.CustomDataActionRouteValues property, and then process the returned result in the specified client function. This method does not update the VerticalGrid. |
| GetVerticalScrollPosition | Returns the current vertical scroll position of the grid’s content. Inherited from ASPxClientVerticalGrid. |
| GetVisible | Returns a value specifying whether a control is displayed. Inherited from ASPxClientControlBase. |
| GetVisibleRecordsOnPage | Returns the number of records actually displayed on the active page. Inherited from ASPxClientVerticalGrid. |
| GetWidth | Returns the control’s width. Inherited from ASPxClientControl. |
| GotoPage(pageIndex) | Selects the specified page. Inherited from ASPxClientVerticalGrid. |
| 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. |
| IsRecordSelectedOnPage(visibleIndex) | Indicates whether or not the specified record is selected within the current page. Inherited from ASPxClientVerticalGrid. |
| NextPage | Activates the next page. Inherited from ASPxClientVerticalGrid. |
| PerformCallback(data) | Sends a callback with a parameter to update the VerticalGrid 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 ASPxClientVerticalGrid. |
| Refresh | Updates vertical grid data. Inherited from ASPxClientVerticalGrid. |
| SelectAllRecordsOnPage | Allows you to select or deselect all records displayed on the current page based on the parameter passed. Inherited from ASPxClientVerticalGrid. |
| SelectRecordOnPage(visibleIndex) | Selects or deselects the specified record displayed on the current page. Inherited from ASPxClientVerticalGrid. |
| SelectRecords | Selects or deselects the specified records within the grid. Inherited from ASPxClientVerticalGrid. |
| SelectRecordsByKey(keys) | Selects or deselects the specified records displayed within the grid. Inherited from ASPxClientVerticalGrid. |
| 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. |
| SetFilterEnabled(isFilterEnabled) | Enables or disables the current filter. Inherited from ASPxClientVerticalGrid. |
| SetFixedRowsTopOffset(offset) | Sets the offset from the container’s top border to fixed rows while scrolling the page. Inherited from ASPxClientVerticalGrid. |
| 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 ASPxClientVerticalGrid. |
| SetRowExpanded(row, value) | Sets a value indicating whether the row is expanded. Inherited from ASPxClientVerticalGrid. |
| SetSearchPanelCustomEditor(editor) | Specifies a custom editor for the search panel on the client side. Inherited from ASPxClientVerticalGrid. |
| SetVerticalScrollPosition(position) | Specifies the vertical scroll position for the grid’s content. Inherited from ASPxClientVerticalGrid. |
| SetVisible(visible) | Specifies whether a control is displayed. Inherited from ASPxClientControlBase. |
| SetWidth(width) | Specifies the control’s width in pixels. Inherited from ASPxClientControl. |
| ShowFilterControl | Displays the Filter Control. Inherited from ASPxClientVerticalGrid. |
| SortBy(row) | Sorts data by the specified data row‘s values, and places the row to the specified position among the sorted rows. Inherited from ASPxClientVerticalGrid. |
| UnselectAllRecordsOnPage | Deselects all selected records displayed on the current page. Inherited from ASPxClientVerticalGrid. |
| UnselectFilteredRecords | Deselects all grid records that match the filter criteria currently applied to the grid. Inherited from ASPxClientVerticalGrid. |
| UnselectRecordOnPage(visibleIndex) | Deselects the specified record (if selected) displayed on the current page. Inherited from ASPxClientVerticalGrid. |
| UnselectRecords | Deselects the specified records (if selected) within the grid. Inherited from ASPxClientVerticalGrid. |
| UnselectRecordsByKey(keys) | Deselects the specified records displayed within the grid. Inherited from ASPxClientVerticalGrid. |
| UpdateEdit | Saves all the changes made and switches the grid to browse mode. Inherited from ASPxClientVerticalGrid. |
Events
| Name | Description |
|---|---|
| BatchEditChangesCanceling | Occurs on the client side before data changes are canceled in batch edit mode. Inherited from ASPxClientVerticalGrid. |
| BatchEditChangesSaving | Occurs on the client side before data changes are saved in batch edit mode. Inherited from ASPxClientVerticalGrid. |
| BatchEditConfirmShowing | Enables you to prevent a batch edit confirmation message from being displayed. Inherited from ASPxClientVerticalGrid. |
| BatchEditEndEditing | Occurs when a grid leaves the batch edit mode. Inherited from ASPxClientVerticalGrid. |
| BatchEditRecordChangesCanceling | Allows you to handle a Cancel button click for a record in batch edit mode. Inherited from ASPxClientVerticalGrid. |
| BatchEditRecordDeleting | Occurs on the client side before a record is deleted in batch edit mode. Inherited from ASPxClientVerticalGrid. |
| BatchEditRecordInserting | Occurs on the client side before a record is inserted in batch edit mode. Inherited from ASPxClientVerticalGrid. |
| BatchEditRecordRecovering | Occurs on the client side before a record is deleted in batch edit mode. Inherited from ASPxClientVerticalGrid. |
| BatchEditRecordValidating | Enables you to specify whether record data is valid and provide an error text. Inherited from ASPxClientVerticalGrid. |
| BatchEditStartEditing | Occurs when a grid switches to batch edit mode. Inherited from ASPxClientVerticalGrid. |
| 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 ASPxClientVerticalGrid. |
| 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 ASPxClientVerticalGrid. Inherited from ASPxClientVerticalGrid. |
| CellSelectionChanging | Occurs when you select or deselect a cell. Inherited from ASPxClientVerticalGrid. |
| 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 ASPxClientVerticalGrid. |
| CustomButtonClick | Occurs when a custom command button has been clicked. Inherited from ASPxClientVerticalGrid. |
| EndCallback | Occurs on the client after a callback’s server-side processing has been completed. Inherited from ASPxClientVerticalGrid. |
| FocusedCellChanging | Occurs on the client side when the focused cell is about to be changed. Inherited from ASPxClientVerticalGrid. |
| 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. |
| RecordClick | Fires on the client when a record is clicked. Inherited from ASPxClientVerticalGrid. |
| RecordDblClick | Fires on the client when a record is double clicked. Inherited from ASPxClientVerticalGrid. |
| RowExpandedChanged | Fires on the client side after a row’s expansion state has been changed by end-user interaction. Inherited from ASPxClientVerticalGrid. |
| RowExpandedChanging | Fires on the client side before the expansion state of a row is changed by end-user interaction. Inherited from ASPxClientVerticalGrid. |
| RowSorting | Enables you to prevent rows from being sorted. Inherited from ASPxClientVerticalGrid. |
| SelectionChanged | Fires after the selection has been changed. Inherited from ASPxClientVerticalGrid. |
| ToolbarItemClick | Fires after a toolbar item has been clicked. Inherited from ASPxClientGridBase. |
See Also