ASPxClientGridView Members

A client-side equivalent of the ASPxGridView object.

Name	Description
batchEditApi	Provides access to the batch editing client API.
name	Gets the unique, hierarchically-qualified identifier for the control. Inherited from ASPxClientControlBase.

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 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 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.
GetColumnsCount	Obsolete. Returns the number of columns within the client GridView.
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.
GetFocusedCell	Gets information about a focused cell.
GetFocusedRowIndex	Returns the focused row’s index.
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 values of the specified data source fields within the specified row.
GetSelectedFieldValues(fieldNames, onCallback)	Returns the row values displayed within all selected rows.
GetSelectedKeysOnPage	Returns key values of selected rows displayed within the current page.
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 with the specified sort order. If several columns are involved in grouping, the specified column will reside at the specified grouping level.
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 or not the specified row is selected within the current page.
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 data displayed within the grid.
SelectAllRowsOnPage	Allows you to select or deselect all rows displayed on the current page based on the parameter passed.
SelectRowOnPage(visibleIndex)	Selects or deselects the specified row displayed on the current page.
SelectRows	Selects or deselects the specified rows within the grid.
SelectRowsByKey(keys)	Selects or deselects the specified row in 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.
SetColumnLayout(columnLayout)	Specifies the grid column’s layout.
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.
SetFocusedCell(rowVisibleIndex, columnIndex)	Focuses the specified cell.
SetFocusedCellByKey(key, columnIndex)	Focuses the specified cell.
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 specified data column‘s values, and places the column to the specified position among the sorted columns.
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. Ungroups data by the values of the specified column.
UnselectAllRowsOnPage	Deselects all selected rows displayed on the current page.
UnselectFilteredRows	Deselects all grid rows that match the filter criteria currently applied to the grid.
UnselectRowOnPage(visibleIndex)	Deselects the specified row (if selected) displayed on the current page.
UnselectRows	Deselects the specified row (if selected) within the grid.
UnselectRowsByKey(keys)	Deselects the specified row displayed within the grid.
UpdateEdit	Saves all the changes made and switches the grid to browse mode.

Name	Description
BatchEditChangesCanceling	Occurs on the client side before data changes are canceled in batch edit mode.
BatchEditChangesPreviewShowing	Occurs on the client side before the Changes Preview window is shown.
BatchEditChangesPreviewShown	Occurs on the client side when the Changes Preview window is shown.
BatchEditChangesSaving	Occurs on the client side before data changes are saved in batch edit mode.
BatchEditConfirmShowing	Enables you to prevent a batch edit confirmation message from being displayed.
BatchEditEndEditing	Occurs when a grid leaves the batch edit mode.
BatchEditRowDeleting	Occurs on the client side before a data row is deleted in batch edit mode.
BatchEditRowInserting	Occurs on the client side before a data row is inserted in batch edit mode.
BatchEditRowRecovering	Occurs on the client side before a row is recovered in batch edit mode.
BatchEditRowValidating	Enables you to specify whether row data is valid and provide an error text.
BatchEditStartEditing	Occurs when a grid switches to batch edit mode.
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.
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.
ColumnGrouping	Enables you to cancel data grouping.
ColumnMoving	Enables you to control column movement.
ColumnResized	Occurs after a column’s width has been changed by an end-user.
ColumnResizing	Enables you to prevent columns from being resized.
ColumnSorting	Enables you to prevent columns from being sorted.
ColumnStartDragging	Fires when an end-user starts dragging the column’s header and enables you to cancel this operation.
ContextMenu	Occurs after an end-user right clicks in the GridView, and enables you to provide a custom context menu.
ContextMenuItemClick	Fires on the client side when a context menu item has been clicked.
CustomButtonClick	Occurs when a user clicks a custom command button.
CustomizationWindowCloseUp	Fires after the Customization Window has been closed.
DetailRowCollapsing	Fires before a detail row is collapsed.
DetailRowExpanding	Fires before a detail row is expanded.
EndCallback	Occurs on the client after a callback’s server-side processing has been completed.
FocusedCellChanging	Occurs on the client side when the focused cell is about to be changed.
FocusedRowChanged	Fires in response to changing row focus.
Init	Occurs on the client side after the control has been initialized. Inherited from ASPxClientControlBase.
RowClick	Fires on the client when a data row is clicked.
RowCollapsing	Fires before a group row is collapsed.
RowDblClick	Fires on the client when a data row is double clicked.
RowExpanding	Fires before a group row is expanded.
RowFocusing	Fires before a row has been focused.
SelectionChanged	Fires when a user selects a row.
ToolbarItemClick	Fires after a toolbar item has been clicked. Inherited from ASPxClientGridBase.

Controls

Tools

Controls and Extensions

Tools

Maintenance Mode

Controls

Tools

Controls and Extensions

Tools

Maintenance Mode

ASPxClientGridView Members

Properties

Methods

Events