OBOUT - ASP.NET Grid - Grid Class Documentation

ASP.NET Grid Documentation — Grid Class

Obout.Grid namespace

Obout.Grid.Grid class

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

Accessibility

Name	Description
AllowKeyNavigation	Bool. Enables the Key Navigation feature. Default: false See also working example.

Add/Edit/Delete

Name	Description
AllowAddingRecords	Bool. If set to true, the grid will have links for adding new records. Default: true See also working example.
AllowMultiRecordAdding	Bool. Enables/disables the multi-record adding feature. Default: false See also working example.
AllowMultiRecordEditing	Bool. Enables/disables the multi-record editing feature. Default: false See also working example.
AllowMultiRecordDeleting	Bool. Enables/disables the multi-record deleting feature. Default: false See also working example.
EnableTypeValidation	Bool. Enable/disable to Type Validation feature. Default: true See also working example.

Appearance

Name	Description
CssSettings	GridCssSettings. Complex property containing all the css settings for the Grid.
FolderStyle	String. Path to the folder with style to use.

Client-Side Events

Name	Description
ClientSideEvents	GridClientSideEvents. Complex property used for setting the client-side events.

Columns

Name	Description
AllowColumnResizing	Bool. Show/hide the tooltip that appears when columns are resized. Default: true See also working example.
AutoGenerateColumns	Bool. By setting this property to true, all the columns from the specified datasource will be added to the grid.To have more control over the columns of the grid you need to set AutoGenerateColumns to false. Default: true See also working example.
Columns	ColumnCollection. A collection of Column objects - the columns of the Grid.
ShowTooltipOnResize	Bool. Enable/disable column resizing. Default: true See also working example.

Data

Name	Description
DataSource	Object. Property used for setting the data source of the grid.
DataSourceID	String. The Control ID of an IDataSource that will be used as the data source.
ClearPreviousDataSource	Method that should be called before changing the data source of the Grid. See also working example.

Events

Name	Description
OnSelect	Server-side event that is executed when a record is selected.
OnInsertCommand	Server-side event that is executed when a new record is added.
OnUpdateCommand	Server-side event that is executed when a record is updated.
OnDeleteCommand	Server-side event that is executed when a record is deleted.
OnRebind	Server-side event that is executed after the OnInsertCommand, OnUpdateCommand and OnDeleteCommand events.
OnRowCreated	Server-side event that is raised when GridRow objects are created.
OnRowDataBound	Server-side event that is raised when GridRow objects are bound to their data.
OnColumnsCreated	Server-side event that is raised after the columns are created.

Exporting

Name	Description
ExportingSettings	GridExportingSettings. Gets or sets the settings for the exporting feature of the Grid.
FolderExports	String. The name of the folder where the exported Excel/Word files will be written. See also working example.
ExportToExcel	Method. Exports the data from the Grid to MS Excel. ExportToExcel ( FileName , KeepFormatting , UsePaging , AppendTimeStamp , Office2007 , UseHiddenColumns , ColumnsForExport ) 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. AppendTimeStamp - append a timestamp to the name of the file (for generating unique file names). Office2007 - if set to true, the generated file will be compatible with MS Excel 2007. UseHiddenColumns - if set to true, the invisible columns will be exported too. ColumnsForExport - a string containing the columns that will be exported. grid1.ExportToExcel("OboutGrid", true, false, true, false)
ExportToWord	Method. Exports the data from the Grid to MS Word. ExportToWord ( FileName , KeepFormatting , UsePaging , AppendTimeStamp , Office2007 , UseHiddenColumns , ColumnsForExport ) 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. AppendTimeStamp - append a timestamp to the name of the file (for generating unique file names). Office2007 - if set to true, the generated file will be compatible with MS Word 2007. UseHiddenColumns - if set to true, the invisible columns will be exported too. ColumnsForExport - a string containing the columns that will be exported. grid1.ExportToWord("OboutGrid", true, false, true, true)

Filtering

Name	Description
AllowFiltering	Bool. Enables/disables the filtering feature. Default: false See also working example.
EmbedFilterInSortExpression	Bool. Used for optimizing the performance when the Grid is bound to an ObjectDataSourceControl that has the paging feature enabled. Default: false See also working example.

Grouping

Name	Description
AllowGrouping	Bool. Enables/disables the Grouping feature. Default: false See also working example.
GroupBy	String. Used to group the Grid by the specified columns. See also working example.
ShowCollpasedGroups	Bool. If true, the groups will initially be collapsed. Default: false See also working example.
ShowMultiPageGroupsInfo	Bool. If true, the groups that spread on multiple pages will have additional information about the records in the header of the group. Default: true See also working example.

Layout

Name	Description
ShowHeader	Bool. Property used for showing/hiding the header of the grid. Default: true See also working example.
ShowFooter	Bool. Property used for showing/hiding the footer of the grid. Default: true See also working example.
Width	Unit. The width of the Grid. See also working example.

Localization

Name	Description
FolderLocalization	String. Path to folder with localization xml files. Default: grid/localization See also working example.
Language	String. Name of the language to be used. Default: en See also working example.
LocalizationSettings	GridLocalizationSettings. Complex property used to define the localization settings. See also working example.

Master / Detail

Name	Description
MasterDetailSettings	GridMasterDetailSettings. Defines the settings for the master/detail feature. See also working example.

Misc

Name	Description
ID	String. The ID of the Grid control.
IsCallback	Bool. Read-only property that indicates if a callback has occurred.

Paging

Name	Description
AllowManualPaging	Bool. Enables/disables the manual paging feature (which allows users to navigate through the pages by entering the page number into a textbox). Default: false See also working example.
AllowPageSizeSelection	Bool. Show/Hide the Page Size selection drop-down. Default: true See also working example.
AllowPaging	Bool. Show/Hide the buttons for changing the page. Default: true See also working example.
CurrentPageIndex	Int. The zero starting index of page that is displayed in the grid. Default: 0 See also working example.
NumberOfPagesShownInFooter	Int. Sets the number of pages displayed in the footer. Default: 5 See also working example.
PageSize	Int. The number of records to be displayed on a page. Default: 10 See also working example.
PageSizeOptions	String. The options for the "Records per page" drop-down list. Default: 1,2,3,4,5,6,7,8,9,10,50,100,500 See also working example.
ShowTotalNumberOfPages	Bool. If true, the total number of pages will be shown in the footer. Default: false See also working example.

Scrolling

Name	Description
ScrollingSettings	GridScrollingSettings. Property used to define the scrolling settings for the Grid.

Selecting Records

Name	Description
AllowMultiRecordSelection	Bool. Enable/disable the multi record selection feature. Default: true See also working example.
AllowRecordSelection	Bool. Enable/disable the record selection feature. Default: true See also working example.
AutoPostBackOnSelect	Bool. If true, the page will be posted back to the server when a record is selected. Default: false See also working example.
KeepSelectedRecords	Bool. If set to true, the selected records will keep their state between callbacks/postbacks. Default: true See also working example.
SelectedRecords	ArrayList. Collection which contains all the selected records. See also working example.

Settings

Name	Description
CallbackMode	Bool. Setting this property to true will make the Grid work in callback mode (all the actions will be executed with AJAX callbacks). If CallbackMode is set to false, each action will trigger a postback of the page. Default: true See also working example.
EnableRecordHover	Bool. Enables/disables hover effects when the mouse is over the records. See also working example.
GenerateRecordIds	Bool. If true, each record will have a unique ID that can be used on the client-side. See also working example.
ShowLoadingMessage	Bool. Enables/disables the displaying of the "Loading..." message. Default: true See also working example.
Serialize	Bool. Enables grid serialization into VIEWSTATE (this way, the grid is binded only once to the datasource). For grids with a large number of records, we recommend to set Serialize to false for better performance. Default: true See also Serialize tutorial.

Sorting

Name	Description
AllowSorting	Bool. If set to true, the grid will have sorting capabilities. Default: true See also working example.

Templates

Name	Description
Templates	TemplatesCollection. A collection of GridTemplate objects - the templates that will be used by the columns.
TemplateSettings	GridTemplateSettings. Property used to define the template settings for the Grid.

"Obout Combobox is a wonderful control!"

Shivani

Random testimonial All testimonials

obout.com

Grid Home

Examples - 313

Appearance - 2

Populating with data - 16

Add/Edit/Delete - 26

Record Selection - 13

Columns - 22

Paging - 7

Sorting - 4

Filtering - 25

Templates - 31

Scrolling - 16

Grouping - 14

Totals / Sub-Totals - 6

Master / Detail - 35

Column Sets - 4

Exporting - 20

Accessibility - 2

Localization - 2

Client-Side Events - 2

Server-Side Events - 3

Printing - 5

Validation - 3

Integration - 21

ASP.NET AJAX - 8

State Keeping - 3

Other Features - 13

Mode - 2

Layout Customization- 4

Rows - 4

Knowledge Base - 1

Documentation - 25

Server-Side

ColumnCollection

ColumnTemplateSettings

DetailGridLoadingMode

DetailGridState

FilterOptionsCollection

FilterOptionType

GridAddEditDeleteSettings

GridClientSideEvents

GridCssSettings

GridExportingSettings

GridFilterSettings

GridGroupInformation

GridGroupingSettings

GridLocalizationSettings

GridMasterDetailSettings

GridPagingSettings

GridRecordEventArgs

GridRuntimeTemplate

GridRuntimeTemplateEventArgs

GridScrollingSettings

GridTemplateSettings

TemplateContainer

TemplatesCollection

Client-Side

Client-Side API

Tutorials - 18

Miscellaneous Tutorials - 14