ASPxClientVerticalGrid Methods

A client-side equivalent of the ASPxVerticalGrid object.

Name	Description
AddNewRecord	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 ASPxVerticalGrid.
ApplySearchPanelFilter(value)	Applies the specified search panel filter criterion to grid data.
CancelEdit	Cancels all the changes made and switches the ASPxVerticalGrid to browse mode.
Cast(obj) static	Converts the specified object to the ASPxClientVerticalGrid type.
ClearFilter	Clears the filter expression applied to a client vertical grid.
CloseFilterControl	Hides the Filter Control.
DeleteRecord(visibleIndex)	Deletes the specified record.
DeleteRecordByKey(key)	Deletes a record with the specified key value.
ExportTo(format)	Exports a grid data to a file in the specified format.
Focus	Sets input focus to the grid.
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.
GetHeight	Returns the control’s height. Inherited from ASPxClientControl.
GetHorizontalScrollPosition	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.
GetPageRecordValues(fieldNames, onCallback)	Returns the record 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.
GetRecordKey(visibleIndex)	Returns the key value of the specified data row (record in the vertical grid).
GetRecordValues(visibleIndex, fieldNames, onCallback)	Returns the values of the specified data source fields within the specified record.
GetRow(rowIndex)	Returns the client row that resides at the specified position within the row collection.
GetRowByField(rowFieldName)	Returns the client row which is bound to the specified data source field.
GetRowById(rowId)	Returns the row with the specified unique identifier.
GetRowCount	Returns the number of rows within the client vertical grid.
GetRowExpanded(row)	Gets the value that specifies whether the required row is expanded.
GetSelectedFieldValues(fieldNames, onCallback)	Returns the record values displayed within all selected records.
GetSelectedKeysOnPage	Returns key values of selected records displayed within the current page.
GetSelectedRecordCount	Returns the number of selected records.
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.
GetValuesOnCustomCallback(args, onCallback)	Sends a callback to the server and generates the server-side ASPxVerticalGrid.CustomDataCallback event.
GetVerticalScrollPosition	Returns the current vertical scroll position of the grid’s content.
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.
GetWidth	Returns the control’s width. Inherited from ASPxClientControl.
GotoPage(pageIndex)	Selects the specified page.
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.
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 data displayed within the grid.
SelectAllRecordsOnPage	Allows you to select or deselect all records displayed on the current page based on the parameter passed.
SelectRecordOnPage(visibleIndex)	Selects or deselects the specified record displayed on the current page.
SelectRecords	Selects or deselects the specified records within the grid.
SelectRecordsByKey(keys)	Selects or deselects the specified records displayed within the grid.
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.
SetFixedRowsTopOffset(offset)	Sets the offset from the container’s top border to fixed rows while scrolling the page.
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.
SetRowExpanded(row, value)	Sets a value indicating whether the row is expanded.
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.
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.
SortBy(row)	Sorts data by the specified data row‘s values, and places the row to the specified position among the sorted rows.
UnselectAllRecordsOnPage	Deselects all selected records displayed on the current page.
UnselectFilteredRecords	Deselects all grid records that match the filter criteria currently applied to the grid.
UnselectRecordOnPage(visibleIndex)	Deselects the specified record (if selected) displayed on the current page.
UnselectRecords	Deselects the specified records (if selected) within the grid.
UnselectRecordsByKey(keys)	Deselects the specified records displayed within the grid.
UpdateEdit	Saves all the changes made and switches the grid to browse mode.