OBOUT - ASP.NET Grid - Grid Documentation

Quick Links

ASP.NET Grid Documentation - Client-Side API

Obout.Grid namespace

Obout.Grid.Grid class

<%@ Register TagPrefix="obout" Namespace="Obout.Grid" Assembly="obout_Grid_NET" %>

Client-Side Properties

Name	Description
SelectedRecords	Array. Array containing all the selected records from the Grid. See also working example.
PageSelectedRecords	Array. Array containing all the selected records from the current page of the Grid. See also working example.
Rows/Cells	Array. A collection of objects containing all the data from the Grid's cells. Usage: grid1.Rows[i].Cells[j].Value See also working example.
RecordInEditMode	Int. The index of the record which is currently in edit mode. Usage: alert(grid1.RecordInEditMode);
GridMainContainer	The client-side DIV object containing all the elements of the Grid. Usage: grid1.GridMainContainer
GridHeaderContainer	The client-side DIV object containing the Header. Usage: grid1.GridHeaderContainer
GridBodyContainer	The client-side DIV object containing the Body with records. Usage: grid1.GridBodyContainer
GridFooterContainer	The client-side DIV object containing the Footer. Usage: grid1.GridFooterContainer

Client-Side Methods - Populating With Data

Name	Description
refresh	Forces the Grid to refresh its records from the server. See also working example.

Client-Side Methods - Record Selection

Name	Description
selectRecord	Selects the record with the specified index. See also working example.
deselectRecord	Deselects the record with the specified index. See also working example.

Client-Side Methods - Columns

Name	Description
showColumn	Shows the column with the specified index/data field. See also working example.
hideColumn	Hides the column with the specified index/data field. See also working example.

Client-Side Methods - Add/Edit/Delete Records

Name	Description
executeInsert	Inserts a new record into the database. This function can be called from outside the Grid, by passing the data as a parameter. See also working example.
executeUpdate	Updates a record from the database. This function can be called from outside the Grid, by passing the data as a parameter. See also working example.
executeDelete	Deletes a record from the database. This function can be called from outside the Grid, by passing the data as a parameter. See also working example.
edit_record	Puts a record in edit mode. See also working example.
update_record	Updates a record that is in edit mode. See also working example.
cancel_edit	Cancels the editing of a record.. See also working example.
delete_record	Deletes the specified record. See also working example.
addRecord	Creates the row for the new record. See also working example.
insertRecord	Inserts the new record into the database. See also working example.
cancelNewRecord	Cancels the adding of the new record. See also working example.
saveAll	Saves all the changes (when the multi-record add/edit/delete feature is used) See also working example.
cancelAll	Cancel all the changes (when the multi-record add/edit/delete feature is used) See also working example.
modifyTemporaryRecord	Modifies a temporary added/edited record (when the multi-record add/edit/delete feature is used) See also working example.
removeTemporaryRecord	Removes a temporary added record (when the multi-record add/edit/delete feature is used) See also working example.
undeleteTemporaryRecord	Undeletes a temporary deleted record (when the multi-record add/edit/delete feature is used) See also working example.

Client-Side Methods - Filtering Records

Name	Description
addFilterCriteria	Adds a filter criteria that will be used when the executeFilter method will be called. Usage: grid1.addFilterCriteria(columnName, filterType, valueToFilter); Example: grid1.addFilterCriteria('ShipCountry', OboutGridFilterCriteria.EqualTo, 'USA'); Possible values for the filterType: OboutGridFilterCriteria.NoFilter OboutGridFilterCriteria.Contains OboutGridFilterCriteria.DoesNotContain OboutGridFilterCriteria.StartsWith OboutGridFilterCriteria.EndsWith OboutGridFilterCriteria.EqualTo OboutGridFilterCriteria.NotEqualTo OboutGridFilterCriteria.SmallerThan OboutGridFilterCriteria.GreaterThan OboutGridFilterCriteria.SmallerThanOrEqualTo OboutGridFilterCriteria.GreaterThanOrEqualTo OboutGridFilterCriteria.IsNull OboutGridFilterCriteria.IsNotNull OboutGridFilterCriteria.IsEmpty OboutGridFilterCriteria.IsNotEmpty See also working example.
executeFilter	Applies the filter criterias added with the addFilterCriteria method. Usage: grid1.executeFilter(); See also working example.
showFilter	Opens the filter. See also working example.
filter	Applies the filter based on the selected filter criterias. See also working example.
hideFilter	Hides/closes the filter. See also working example.
removeFilter	Removes the previously applied filter. See also working example.

Client-Side Methods - Paging

Name	Description
changePage	Changes the page of the Grid to the specified index. See also working example.
getCurrentPageIndex	Returns the index of the current page.
getPageSize	Returns the value selected in the page size selection dropdown (the number of records displayed on each page)
getTotalNumberOfRecords	Returns the total number of records.

Client-Side Methods - Exporting

Name	Description
exportToExcel	Exports the data from the Grid to an Excel file. Usage: grid1.exportToExcel("OboutGrid", false, true, false, false); See also working example.
exportToWord	Exports the data from the Grid to a Word file. Usage: grid1.exportToWord("OboutGrid", true, false, true, false); See also working example.

Client-Side Methods - Records

Name	Description
getRecordsIds	Returns a list with the ids of all the records from the Grid. See also working example.

Client-Side Methods - Printing

Name	Description
print	Prints the grid. Usage: grid1.print(); See also working example.

Client-Side Properties / Methods - Master / Detail

Name	Description
DetailGrids	A collection with all the detail grids of a master grid. Usage: grid1.DetailGrids[index] See also working example.
ForeignKeys	A collection with all the foreign keys of a detail grid. Usage: grid1.ForeignKeys.SomeColumnName.Value See also working example.
getDetailGrid	Retrieves a detail grid object, based on the value of the foreign key passed as the parameter. Usage: grid1.getDetailGrid({ForeignKey1: Value1, ForeignKey2: Value2, ...}); See also working example.

"I would like to thank the whole obout team for a great tool. Recently I have downloaded your tool and I believe that your controls are tremendous to work with. The usefulness and appearance is excellent."

Faruk Sikder

Spectrum Engineering Consortium Ltd.