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
propertySelectedRecords Array. Array containing all the selected records from the Grid.

See also working example.
propertyPageSelectedRecords Array. Array containing all the selected records from the current page of the Grid.

See also working example.
propertyRows/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.
propertyRecordInEditMode Int. The index of the record which is currently in edit mode.

Usage: alert(grid1.RecordInEditMode);
propertyGridMainContainer The client-side DIV object containing all the elements of the Grid.

Usage: grid1.GridMainContainer
propertyGridHeaderContainer The client-side DIV object containing the Header.

Usage: grid1.GridHeaderContainer
propertyGridBodyContainer The client-side DIV object containing the Body with records.

Usage: grid1.GridBodyContainer
propertyGridFooterContainer The client-side DIV object containing the Footer.

Usage: grid1.GridFooterContainer

Client-Side Methods - Populating With Data

Name Description
propertyrefresh Forces the Grid to refresh its records from the server.

See also working example.

Client-Side Methods - Record Selection

Name Description
propertyselectRecord Selects the record with the specified index.

See also working example.
propertydeselectRecord Deselects the record with the specified index.

See also working example.

Client-Side Methods - Columns

Name Description
propertyshowColumn Shows the column with the specified index/data field.

See also working example.
propertyhideColumn Hides the column with the specified index/data field.

See also working example.

Client-Side Methods - Add/Edit/Delete Records

Name Description
propertyexecuteInsert 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.
propertyexecuteUpdate 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.
propertyexecuteDelete 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.
propertyedit_record Puts a record in edit mode.

See also working example.
propertyupdate_record Updates a record that is in edit mode.

See also working example.
propertycancel_edit Cancels the editing of a record..

See also working example.
propertydelete_record Deletes the specified record.

See also working example.
propertyaddRecord Creates the row for the new record.

See also working example.
propertyinsertRecord Inserts the new record into the database.

See also working example.
propertycancelNewRecord Cancels the adding of the new record.

See also working example.
propertysaveAll Saves all the changes (when the multi-record add/edit/delete feature is used)

See also working example.
propertycancelAll Cancel all the changes (when the multi-record add/edit/delete feature is used)

See also working example.
propertymodifyTemporaryRecord Modifies a temporary added/edited record (when the multi-record add/edit/delete feature is used)

See also working example.
propertyremoveTemporaryRecord Removes a temporary added record (when the multi-record add/edit/delete feature is used)

See also working example.
propertyundeleteTemporaryRecord 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
propertyaddFilterCriteria 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.
propertyexecuteFilter Applies the filter criterias added with the addFilterCriteria method.

Usage: grid1.executeFilter();

See also working example.
propertyshowFilter Opens the filter.

See also working example.
propertyfilter Applies the filter based on the selected filter criterias.

See also working example.
propertyhideFilter Hides/closes the filter.

See also working example.
propertyremoveFilter Removes the previously applied filter.

See also working example.

Client-Side Methods - Paging

Name Description
propertychangePage Changes the page of the Grid to the specified index.

See also working example.
propertygetCurrentPageIndex Returns the index of the current page.
propertygetPageSize Returns the value selected in the page size selection dropdown
(the number of records displayed on each page)
propertygetTotalNumberOfRecords Returns the total number of records.

Client-Side Methods - Exporting

Name Description
propertyexportToExcel Exports the data from the Grid to an Excel file.

Usage: grid1.exportToExcel("OboutGrid", false, true, false, false);

Arguments:
  • fileName - the name of the file (without extension) where the data will be exported
  • keepFormatting - if set to true some of the properties of the columns will also be exported (Width, Align, HeaderAling, Wrap
  • usePaging - export all the records or just the current page
  • addTimeStamp - append a timestamp to the name of the file (for generating unique file names)
  • Office2007 - if set to true, the exported files will be compatible with MS Office 2007
  • useHiddenColumns - if set to true, the invisible columns will be exported too
  • columnsForExport - a string containing the columns that will be exported


See also working example.
propertyexportToWord Exports the data from the Grid to a Word file.

Usage: grid1.exportToWord("OboutGrid", true, false, true, false);

Arguments:
  • fileName - the name of the file (without extension) where the data will be exported
  • keepFormatting - if set to true some of the properties of the columns will also be exported (Width, Align, HeaderAling, Wrap
  • usePaging - export all the records or just the current page
  • addTimeStamp - append a timestamp to the name of the file (for generating unique file names)
  • Office2007 - if set to true, the exported files will be compatible with MS Office 2007
  • useHiddenColumns - if set to true, the invisible columns will be exported too
  • columnsForExport - a string containing the columns that will be exported


See also working example.

Client-Side Methods - Records

Name Description
propertygetRecordsIds Returns a list with the ids of all the records from the Grid.

See also working example.

Client-Side Methods - Printing

Name Description
propertyprint Prints the grid.

Usage: grid1.print();

See also working example.

Client-Side Properties / Methods - Master / Detail

Name Description
propertyDetailGrids A collection with all the detail grids of a master grid.

Usage: grid1.DetailGrids[index]

See also working example.
propertyForeignKeys A collection with all the foreign keys of a detail grid.

Usage: grid1.ForeignKeys.SomeColumnName.Value

See also working example.
propertygetDetailGrid 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.

"Your editor is excellent! It feels robust, the styles work, everything works! Really nice to find good software - and software that really works as shown!"

David Sheardown

Random testimonial   All testimonials

obout.com
obout.com Home
News
Grid Home 
Grid Home
Download
Site Map
Examples - 313
Appearance - 2
Live Styles
Populating with data - 16
Declaratively (Design-time) - 4
Binding to ObjectDataSource
Binding to SqlDataSource
Binding to XmlDataSource
Populating from Stored Procedures
At Run-time - 6
Binding to DataSet
Binding to DataReader
Binding to DataTable
Binding to Generic Collections
Binding to Linq
Binding to LinqDataSource
Best Performance - 3
DataSourceNeeded Event New
Paged ObjectDataSource
Partial Load
Miscellaneous - 3
Switching Data Sources New
Populate on Button Click New
Pivot Table
Add/Edit/Delete - 26
Standard - 3
Add/Edit/Delete Records
Multi-Record
Position for New Record/Links New
Custom Editors - 5
Using Custom Forms
Sliding Row Editor
Using Super Form
Using Super Form in Window
Using Flyout
Excel-Style - 2
Excel-Style New
Excel-Style with Autosave New
Custom Triggers - 4
Edit using Context Menu
Edit on Click
Edit on Double-Click
Edit on Dbl-Click with Auto-Save
Saving to Database - 8
Automatic Updates
Using SqlDataSource
Using ObjectDataSource
Using Stored Procedures New
Detect Unsaved Changes
Add to empty table
Default Values for Add/Edit
Save Changes on the Client Side New
User Confirmation - 2
Before Insert / Update / Delete
Confirmation Using Window
Handling Errors - 2
Handling Errors
Handling Errors with Row Templates
Record Selection - 13
Standard Selection - 2
Select Records
PostBack on Select
Custom Selection - 5
Select using Check Boxes New
Select using only Check Boxes New
Select using Radio Buttons
Select using Checkmark
Select All Group Records
Multiselect without CTRL/SHIFT New
Retrieve Selected Records - 2
Find Selected Records - Client-Side
Find Selected Records - Server-Side
Programmatic Selection - 3
Client-Side
Server-Side
Select All Records
Columns - 22
Manipulating Columns - 4
Resizing Columns
Dynamic Column Resizing New
Reordering Columns New
Show / Hide Columns
Column Types - 2
CheckBoxColumn New
CheckBoxSelectColumn New
Settings - 15
AutoGenerateColumns
Align / HeaderAlign
AllowEdit / AllowDelete
ApplyFormatInEditMode
DataFormatString
Index
NullDisplayText
ParseHTML
ReadOnly
Wrap
Visible
Width
Relative Widths
Relative Width for the Columns/Grid
Auto Resize Columns New
Miscellaneous - 1
Different Styles
Paging - 7
Mode - 2
Standard Paging
Manual Paging
Customization - 4
Position New
Customize Paging
Customize Numbers of Pages
Show ALL records
Client-Side API - 1
Change Page on Client
Sorting - 4
Sorting
Multi-Column Sorting
Sorting Week Days
Allow Sorting for Columns New
Filtering - 25
Standard Filtering - 1
Filtering Records
Custom Filtering - 8
Filter Templates
Filter with Date Picker New
Custom Filter Options with Templates
Between, By Year, By Month
Filter Localized Dates
Filter with On-Demand ComboBox
Live Search New
Filter All with Live Search New
Filter Settings - 3
Filter Position New
Initial State
ALL vs. ANY
Column Settings - 3
Enable/Disable Filtering for Columns
Show/Hide Filter Criterias
Customize Filter Options
Programmatic Filtering - 6
Initial Filter
Programmatic Filter - Client-Side
Alphabetic Filter
Keeping Filter State
External Filter Buttons
Filter On Blur
Best Performance - 2
Filter with DataSourceNeeded Event
Filter with Paged ObjectDataSource
Miscellaneous - 2
Validate Filters
Master/Detail with External Filters
Templates - 31
Templates for Add/Edit
Templates for the Filter
Format Dates
Grid With Images
Add/Edit/Delete Buttons
Add/Edit/Delete Images
Multi-Record Add/Edit/Delete
Filter Buttons
Combine Columns
Wrap the Headers
Manual Paging
Number the records
GroupHeaderTemplateId
Format Currencies
Custom Formatting
With Multiselect Listbox
Edit Using CheckBoxList
With Databound Controls
DropDownList with 'New'
View / Edit Details
Customize for Mobile Devices
Get values from textboxes
Detail View
Different Input Fields for Add/Edit
Different Row Fields for Add/Edit
Templates for Edit-Delete
Reports and Row Templates
Access checkboxes inside
Access radio buttons inside
Multiple Controls
Scrolling - 16
Vertical Scroll with Fixed Headers
Horizontal Scroll
Dynamic Horizontal Scroll New
Vertical & Horizontal
Automatic Scroll
Horizontal Scroll and Filter
Using Percentages
Full Window Width / Height
Automatic Resize with Splitter
Fixed (Frozen) Columns
Fixed (Frozen) Rows New
Fixed Height
Fixed Height in Percentages
Virtual Scrolling New
Virtual Scrolling with Paging New
Keep Scroll On PostBack New
Grouping - 14
Grouping the Records
Allow Grouping for Columns
Initial Grouping
Groups Information
Multi-Page Groups Information
Show Collapsed Groups
Hide Columns When Grouping
Keep Expanded
Format the Group Headers
Customize the Group Headers
Custom Data in Group Headers New
Expand/Collapse Groups
Allow Changes New
Group using CheckBoxes New
Totals / Sub-Totals - 6
Totals
Sub-Totals in Group Footers
Sub-Totals in Group Headers New
Aggregates
Totals of Selected Records
Summary Row
Master / Detail - 35
Loading Mode - 4
Load At Once (OnLoad)
Load On Demand (OnCallback)
Load On PostBack
Load On PostBack with UpdatePanel
Populate with Data - 1
Populate from Stored Procedures
Add / Edit / Delete - 6
Add / edit / delete at runtime
Declarative add / edit / delete New
Using Stored Procedures New
Excel Style New
Using Super Form inside Window New
Handling Errors New
Self-Reference Display - 1
TreeView Hierarchy New
Settings - 3
Show Empty Details - OnLoad
Show Empty Details - OnCallback New
Detail Grid State
Miscellaneous - 4
Multiple Details on the Same Level
Unlimited Number of Levels
Multiple Foreign Keys
Display Info in Flyout New
Templates - 4
Templates for Action Buttons
Detail Grid inside Row Template
Inline Templates inside Detail Grid
Row Template inside Detail Grid New
Customizations - 12
Expand/Collapse All
Client-Side Manipulation
Get Selected Records
Expand/Collapse on Select
Expand/Collapse using Hyperlinks New
Different Styles New
Select on Expand / Collapse
Expand a single detail grid
Keep Expanded Details New
Separated Master/Detail Grids
Expand / Collapse on client side
Auto-Expanding (Fluid) Width New
Column Sets - 4
Column Sets New
Column Sets on Multiple Levels New
Scroll Column Sets Horizontally New
Column Sets with Grouping New
Exporting - 20
Export to Excel / Word
Export to PDF New
Export to CSV New
Export Large Data Sets New
Export on Server Side
Export Master/Detail Grids
Export Groups
Export Totals / Subtotals
Export Templates
Export Images
Export Title / Footer
Export Selected Records New
Export CheckBoxColumn New
Export Multiple Grids as a Single File New
Export Column Sets New
Customize Exported Files
Customize Individual Rows
Exported files Life Time
OnClientExportStart/Finish
ExportedFilesTargetWindow
Accessibility - 2
Key Navigation
Customize the Keys
Localization - 2
Localization
Custom Localization
Client-Side Events - 2
Add / Edit / Delete
Expose the Sender
Server-Side Events - 3
RowCreated/RowDataBound
ColumnsCreated
Row Title
Printing - 5
Printing the Grid
Printing All Pages
Printing All Records without Scrollbars
Printing Selected Records New
Printing Selected Columns New
Validation - 3
Using ASP.NET Validators
Validate Super Form inside Grid
Type Validation
Integration - 21
E-Mail Client
File Browser
D-n-D to Tree
Linked with TreeView
Customers
With Easy Menu
With On-Demand ComboBox New
With Master/Detail ComboBox New
Context menu and CheckBoxes
With DatePicker
With Flyout
With File Upload Progress
With Tab Strip
HTML Editor Inline
HTML Editor in Row Template
With Color Picker
With Window
Using Tooltips
Inside Window
Task List
Purchase Order
ASP.NET AJAX - 8
Live Quotes
With AJAX MaskedEditExtender
With AJAX AlwaysVisible
Millions of Records
Populate Edit Fields
View Row Details
Cascading ComboBoxes New
Cascading ComboBoxes in Row Template
State Keeping - 3
Save Column Widths
Keep Current Page
Keep Current Sort Order
Other Features - 13
ShowLoadingMessage
Hover Effects
Multiple Grids
Refresh the Records
Clear the records
Generate IDs
Client-Side Model
Find and Replace
Using ASP.NET Themes/Skins
Multi columns validation
Validate unknown columns
Inline validation
Millions of Records
Mode - 2
Callback Mode
Postback Mode
Layout Customization- 4
Heading New
Rows - 4
Reorder Rows New
Reorder Rows using Drag and Drop New
Drag and Drop Rows between Grids New
Customize Individual Rows
Knowledge Base - 1
Knowledge Base
Documentation - 25
Server-Side
Column
ColumnCollection
ColumnTemplateSettings
DetailGridLoadingMode
DetailGridState
FilterOption
FilterOptionsCollection
FilterOptionType
Grid
GridAddEditDeleteSettings
GridClientSideEvents
GridCssSettings
GridExportingSettings
GridFilterSettings
GridGroupInformation
GridGroupingSettings
GridLocalizationSettings
GridMasterDetailSettings
GridPagingSettings
GridRecordEventArgs
GridRuntimeTemplate
GridRuntimeTemplateEventArgs
GridScrollingSettings
GridTemplate
GridTemplateSettings
SortOrderType
TemplateContainer
TemplatesCollection
Client-Side
Client-Side API
ChangeLog
Tutorials - 18
Add/Edit/Delete
Updating the Database
Updating using Linq
Appearance
Styles
Styles - Advanced
CSS Tutorial
Client-Side API
Client-Side Events
Columns
Columns
Configuration
Using the correct path
Design-Time Support
All Tutorials
Choosing Data Source
Changing Appearance
Populating with Data
Data-Binding
Serialize
Maximum Performance
Selecting Records
Access Selected Records
Templates
Templates
Runtime Templates
Templates for Buttons
Miscellaneous Tutorials - 14
Getting the Generated ID
Loading the details with AJAX Page
Selecting the inserted/updated record
Server-side validation using Ajax
Edit on Click
Hide "no-records" message
Sending parameters
Disable combobox in Edit mode
Bind data after specified the filter
Get Column Index in template
Custom readonly column
Auto-scroll during postback
Delete button
Move records between grids