Definition
Namespace:Telerik.Web.UI
Inheritance: Sys.UI.ControlTelerik.Web.UI.GridTableView
Methods
Cancels the edit mode for all grid items that are switched in edit mode prior to the method call.
cancelAll(): voidMethod which cancels the insert action and switches the grid in regular mode.
cancelInsert(): voidMethod which cancels the update for the edited table row passed as an argument or the row corresponding to the index passed as an argument. If you have several items switched in edit mode, you can cancel the update for all of them with subsequent calls to this method.
cancelUpdate(Number index): voidMethod which clears the selected items for the respective GridTableView client object. This method will clear the selected items from the table's child tables (meaningful in hierarchical grid only).
clearSelectedItems(): voidExplicitly collapses an item.
collapseItem(Number index): voidMethod which will force client rebind of the grid and will refresh its state when a new data source is assigned using the set_dataSource() method. Meaningful in this scenario only.
dataBind(): voidMethod which deletes the table row passed as an argument or the row corresponding to the index passed as an argument.
deleteItem(Number index): voidMethod which deletes all selected items in the grid.
deleteSelectedItems(): voidDeselects the table row passed as an argument or the row corresponding to the index passed as an argument.
deselectItem(Object rowElement): voidMethod which switches all GridDataItems in edit mode.
editAllItems(): voidMethod which switches the table row passed as an argument or the row corresponding to the index passed as an argument in edit mode. If you set AllowMultiRowEdit to true, you can switch multiple grid items in edit mode with subsequent calls to this method.
editItem(Number index): voidMethod which switches all selected items in the grid in edit mode.
editSelectedItems(): voidExplicitly expands an item.
expandItem(Number index): voidExports the grid to CSV format (comma-separated values).
exportToCsv(): voidExports the grid to MS Excel 2003 or later
exportToExcel(): voidExports the grid to PDF format.
exportToPdf(): voidExports the grid to a Word document
exportToWord(): voidMethod which extracts the key values (added to the ClientDataKeyNames collection of the master/detail table) from the edited table row passed as an argument or the row corresponding to the index passed as an argument. The values will be fetched purely client-side and the data will be returned in an object array which can be traversed to get each individual data entry.
extractKeysFromItem(Number index): ObjectObject
Method which extracts the old values from the edited table row passed as an argument or the row corresponding to the index passed as an argument. The values will be fetched purely client-side and the data will be returned in an object array which can be traversed to get each individual data entry.
extractOldValuesFromItem(Number index): ObjectObject
Method which extracts the new values from the edited table row passed as an argument or the row corresponding to the index passed as an argument. The values will be fetched purely client-side and the data will be returned in an object array which can be traversed to get each individual data entry.
extractValuesFromItem(Number index): ObjectObject
Method which triggers filter command for the column with UniqueName (set on the server) passed as a first argument. The second argument should be value to compare (or two values separated by [space] for between filter pattern) or an empty string for EqualTo, NoFilter, IsNull, etc. The last third argument has to be a value from the Telerik.Web.UI.GridFilterFunction enumeration which internally recognizes the filter criteria that should be applied. All server-side filtering capabilities of RadGrid are applicable here as well. See the topic describing the fireCommand method for further details.
filter(String colUniqueName, String valueToCompare, String filterFunction, Boolean shouldUpdateFilterControl): voidMethod which triggers specific command for the grid when executed. The method is called for the GridTableView client instance and its arguments depend on the command which will be processed.
fireCommand(String comandName, String commandArgument): voidReturns a boolean value indicating whether multi-column sorting is enabled for the grid instance
get_allowMultiColumnSorting(): BooleanBoolean
Returns a one-dimensional array which holds the key fields set through the ClientDataKeyNames property of GridTableView on the server
get_clientDataKeyNames(): ArrayArray
Returns a collection of c
get_columns(): ArrayArray
Returns the current page index
get_currentPageIndex(): NumberNumber
Retuens a collection of all data items for the respective GridTableView instance.
get_dataItems(): ArrayArray
Array
get_editItems(): voidReturns HTML table which represents the respective table for the GridTableView object rendered on the client.
get_element(): ElementElement
A collection of Telerik.Web.UI.GridFilterExpression objects. Represents the filter expressions applied for the grid instance. The toString() javascript method executed over this collection will return SQL string representation of all filter expressions concatenated by "AND" reserved words. While filter expressions toString() method will create SQL syntax representing current grid filtering, you can also take advantage of the toDynamicLinq() method which will create LINQ expression that can be used directly with Dynamic LINQ library. Furthermore, you can also utilize the toList() method in order to pass an array of items (representing the filter expression elements) to the server and operate with them using GridFilterExpression server object.
get_filterExpressions(): Telerik.Web.UI.GridFilterExpressionsTelerik.Web.UI.GridFilterExpressions
HTML element
get_insertItem(): voidReturns a Boolean value, specifying whether the filtering item is visible
get_isFilterItemVisible(): BooleanBoolean
Returns a Boolean property. Gets a value indicating if the GridTableView is currently in insert mode.
get_isItemInserted(): BooleanBoolean
Returns a string which represents the Name property (set on the server) for the corresponding GridTableView client object. Can be used to identify table in grid hierarchy client-side
get_name(): StringString
Returns a property which is of type RadGrid and present the parent of the current object.
get_owner(): ObjectObject
Returns the page count for the respective GridTableView object, i.e. the number of pages
get_pageCount(): NumberNumber
Returns the page size for the respective GridTableView object
get_pageSize(): NumberNumber
If called from a nested GridTableView returns the parent item for the current nested hierarchical GridTableView; returns null if called from the MasterTableView.
get_parentRow(): ObjectObject
If called from a nested GridTableView returns the parent GridTableView in the grid hierarchy; returns null if called from the MasterTableView.
get_parentView(): ObjectObject
Returns a collection of all selected items (of type GridDataItem) for the respective GridTableView instance. This collection will include the selected items from the table's child tables (meaningful in hierarchical grid only).
get_selectedItems(): ArrayArray
A collection of Telerik.Web.UI.GridSortExpression objects. Represents the sort expressions applied for the grid instance. The toString() javascript method executed over this collection will return coma separated string of all expressions (in case of AllowMultiColumnSorting) or a single sort expression if multi-column sorting is disabled. You can also utilize the toList() method in order to pass an array of items (representing the sort expressions applied) to the server and operate with them using GridSortExpression server object. Each sort expression (of type Telerik.Web.UI.GridSortExpression) has fieldName and sortOrder properties which hold the DataField of the sorted column and the sort direction (Ascending, Descending or None). To retrieve the values from these properties use the get_fieldName() and get_sortOrder() properties of the corresponding GridSortExpression.
get_sortExpressions(): Telerik.Web.UI.GridSortExpressionsTelerik.Web.UI.GridSortExpressions
Returns the table filter row element
get_tableFilterRow(): ObjectObject
Gets the virtual item count value for the respective GridTableView object. Applies to client-side RadGrid binding only.
get_virtualItemCount(): NumberNumber
Returns a cell specified by a row and a column unique name.
getCellByColumnUniqueName(Telerik.Web.UI.GridDataItem rowObject, String uniqueName): ObjectObject
Returns a column, specified by the argument of the function
getColumnByUniqueName(String uniqueName): Telerik.Web.UI.GridColumnTelerik.Web.UI.GridColumn
Returns the unique name of the column by given header row and cell index passed as first and second arguments.
getColumnUniqueNameByCellIndex(Object rowEl, Number index): ObjectObject
The method will automatically send a result (holding all filter and sort expressions in appropriate format and will apply paging on server using skip and top) to the query method of the ADO.NET Data Service. The resulting value from the getDataServiceQuery(entityName) method will generate an expression that can be recognized by the corresponding data service.
getDataServiceQuery(String entityName): ObjectObject
Method which groups the grid by the column with UniqueName specified as an argument. All server grouping capabilities of RadGrid are applicable for this case as well.
groupColumn(String colUniqueName): voidExplicitly hides a column.
hideColumn(Number index): voidHides the filter item for the tableview instance
hideFilterItem(): voidExplicitly hides an item.
hideItem(Number index): voidMethod which inserts new table row to the grid. The new data will be taken from the insertion form editors fields.
insertItem(): voidMoves a column one position to the left.
moveColumnToLeft(Number columnIndex): voidMoves a column one position to the right.
moveColumnToRight(Number columnIndex): voidMethod which triggers paging action with page command passed as an argument. All server-side paging capabilities of RadGrid are applicable here as well. See the topic describing the fireCommand method for further details.
page(String pageCommand): voidForces a rebind of the grid and will refresh its state using internally the fireCommand() client-side method. Will invoke a postback for server-side bound grids.
rebind(): voidReorders two columns, specified by the two parameters to the function
reorderColumns(String columnName1, String columnName2): voidResizes a row in the grid to a specified height
resizeColumn(Number columnIndex, Number columnWidth): voidResizes a row in the grid to a specified height
resizeItem(Number rowIndex, Object rowHeight): voidSelects all items in the GridTableView for which the method is invoked.
selectAllItems(): voidSelects the table row passed as an argument or the row corresponding to the index passed as an argument.
selectItem(Object rowElement): voidSets a boolean value indicating whether multi-column sorting is enabled for the grid instance
set_allowMultiColumnSorting(Boolean size): voidSets the current page index
set_currentPageIndex(Number index): voidMethod which can be used to assign data source for the corresponding GridTableView client instance. This data source should be of JSON format which can be serialized by a web service or page method.
set_dataSource(Object dataSource): voidSets the page size for the respective GridTableView object
set_pageSize(Number size): voidSets the virtual item count value for the respective GridTableView object. Applies to client-side RadGrid binding only.
set_virtualItemCount(Number size): voidExplicitly shows a column.
showColumn(Number index): voidShows the filter item for the tableview instance
showFilterItem(): voidMethod which switches the grid in insert mode and displays the insertion form.
showInsertItem(): voidExplicitly shows an item.
showItem(Number index): voidMethod which triggers sort command for the column with DataField (set on the server) passed as an argument. If you set AllowMultiColumnSorting to true server-side, each subsequent call to this method will sort the corresponding column. All server-side sorting capabilities of RadGrid are applicable here as well.
sort(String sortExpression): voidSwaps the two columns, the names of which are passed as arguments to the method
swapColumns(String columnName1, String columnName2): voidMethod which performs ungroup action for the column with UniqueName specified as an argument.
ungroupColumn(String colUniqueName): voidMethod which updates all edited items in the grid. The new data will be taken from the edit form editors.
updateEditedItems(): voidMethod which updates the edited table row passed as an argument or the row corresponding to the index passed as an argument. If you have several items switched in edit mode, you can update all of them with subsequent calls to this method. The updated data will be taken from the edit form editors.
updateItem(Number index): void