DbNetGrid

The DbNetGrid control is a database aware grid control that is designed to create a browser based interface for database information stored in a table, view or stored procedure.

Example code

<DNL:DbNetGrid ID="DbNetGrid1" runat="server" ConnectionString="SamplesDatabase" FromPart="Customers"> </DNL:DbNetGrid>

Below is an overview of the DbNetGrid server-side API, the complete server-side API reference can be found here

Basic Properties

The simplest grid can be created by specifying just the ConnectionString and FromPart properties

ConnectionString

The ConnectionString property provides the information necessary to connect to the database. The connection string can either be an actual connection string or an alias which is resolved by finding a matching entry in the <connectionStrings> section of the web.config file. For details of specifying connection strings see the database connectivity section.

FromPart

The FromPart property specifies the name of the table(s) or view(s) from which the grid data should be selected. Data from multiple tables can be selected by including the join statement with the tables e.g.

<DNL:DbNetGrid ID="DbNetGrid1" runat="server" ConnectionString="SamplesDatabase" FromPart="Customers"> </DNL:DbNetGrid>

Run Sample

Columns

The Columns collection allows you to specify the columns that you require from the table(s) and or view(s) specified in the FromPart property

<DNL:DbNetGrid ID="DbNetGrid1" runat="server" ConnectionString="SamplesDatabase" FromPart="Products inner join Categories on Products.CategoryID = Categories.CategoryID"> <Columns> <DNL:GridColumn ColumnExpression="Products.ProductName" /> <DNL:GridColumn ColumnExpression="Categories.CategoryName" /> </Columns> </DNL:DbNetGrid>

Run Sample

Additional Properties

Caption

Adds a heading row to the grid.

<DNL:DbNetGrid ... Caption="Beverage Sales (1997) "> </DNL:DbNetGrid>

Run Sample

EditDialogHeight

Fixes the height of the edit dialog when there are a lot of editable columns. Fields will scroll inside dialog

<DNL:DbNetGrid ... EditDialogHeight="200px"> </DNL:DbNetGrid>

Run Sample

FilterColumnMode

Controls the mode in which filter columns operate. Possible values are Simple (selected value is applied as a filter on its own) or Composite (selected value is applied in combination with other selected filter column values)

<DNL:DbNetGrid ... FilterColumnMode="Composite"> </DNL:DbNetGrid>

Run Sample

FixedFilter

Specifies a filter to applied to the selected grid rows.

<DNL:DbNetGrid ... FixedFilter="country = 'UK'"> </DNL:DbNetGrid>

FixedFilterParameters

Used in combination with the FixedFilter parameter to supply parameter values.

protected override void OnPreRender(EventArgs e) { base.OnPreRender(e); DbNetGrid1.FixedFilter = "country = @country"; DbNetGrid1.FixedFilterParameters["@country"] = "USA"; }

Run Sample

FixedOrderBy

Fixes the order in which rows are displayed in the grid. Column header sorting is nested inside the FixedOrderBy property

<DNL:DbNetGrid ... FixedOrderBy="Country,City"> </DNL:DbNetGrid>

Run Sample

GroupBy

Groups the results by all the non-aggregated columns

<DNL:DbNetGrid ... GroupBy="true"> </DNL:DbNetGrid>

Run Sample

InitialOrderBy

Set the initial order by which rows are returned. Clicking on a column header will override this order.

<DNL:DbNetGrid ... InitialOrderBy="Country,City"> </DNL:DbNetGrid>

MultiRowSelect

Creates the ability to select multiple rows.

<DNL:DbNetGrid ... MultiRowSelect="true"> </DNL:DbNetGrid>

Run Sample

NestedControls

Another way to link grids together is to nest a grid within a parent grid using a NextedControls collection.

<DNL:DbNetGrid> ... <NestedControls> <DNL:DbNetGrid> ... </DNL:DbNetGrid> </NestedControls> ... </DNL:DbNetGrid>

Run Sample

ParentControlID

This property is assigned to a child control and specifies the ID of the parent DbNetGrid or DbNetEdit control

<DNL:DbNetGrid ... ParentControlID="DbNetGrid1"> </DNL:DbNetGrid>

Run Sample

ProcedureName

The name of the stored procedure used as a data source for the grid

ProcedureParameters

The required parameters of the stored procedure used as a data source for the grid

<DNL:DbNetGrid ... ProcedureName="SalesByCategory" ... > <ProcedureParameters> <DNL:ProcedureParameter Name="CategoryName" Value="Beverages"/> <DNL:ProcedureParameter Name="OrdYear" Value="1997"/> </ProcedureParameters> ... </DNL:DbNetGrid>

Run Sample

SearchDialogHeight

Fixes the height of the search dialog when there are a lot of searchable columns. Fields will scroll inside dialog

<DNL:DbNetGrid ... SearchDialogHeight="200px"> </DNL:DbNetGrid>

Run Sample

Toolbar Properties

The following properties control the buttons and information displayed in the toolbar

Run Sample

Toolbar

Sets the location/visibility of the toolbar. Values are Top (toolbar displayed above grid), Bottom (toolbar displayed below grid) or Hidden (toolbar is hidden)

<DNL:DbNetGrid ... Toolbar="hidden"> </DNL:DbNetGrid>

Copy

Controls the appearance of the Copy To Clipboard button in the toolbar

<DNL:DbNetGrid ... Copy="false"> </DNL:DbNetGrid>

Delete

Controls the appearance of the Delete record button in the toolbar

<DNL:DbNetGrid ... Delete="false"> </DNL:DbNetGrid>

Export

Controls the appearance of the grid Export button in the toolbar

<DNL:DbNetGrid ... Export="false"> </DNL:DbNetGrid>

Insert

Controls the appearance of the Insert new record button in the toolbar

<DNL:DbNetGrid ... Insert="false"> </DNL:DbNetGrid>

Navigation

Controls the appearance of the Navigation buttons in the toolbar

<DNL:DbNetGrid ... Navigation="false"> </DNL:DbNetGrid>

OutputCurrentPageOption

Controls the appearance of the Output Current Page Only Export option in the toolbar

<DNL:DbNetGrid ... OutputCurrentPageOption="true"> </DNL:DbNetGrid>

PageInfo

Controls the appearance of the Page X of Y information in the toolbar

<DNL:DbNetGrid ... PageInfo="false"> </DNL:DbNetGrid>

Print

Controls the appearance of the Print grid button in the toolbar

<DNL:DbNetGrid ... Print="false"> </DNL:DbNetGrid>

RowInfo

Controls the appearance of the number of selected rows ( X Rows ) information in the toolbar

<DNL:DbNetGrid ... RowInfo="false"> </DNL:DbNetGrid>

Search

Controls the appearance of the Search dialog button in the toolbar

<DNL:DbNetGrid ... Search="false"> </DNL:DbNetGrid>

Update

Controls the Update record button in the toolbar

<DNL:DbNetGrid ... Update="false"> </DNL:DbNetGrid>