The DbNetGrid class encapsulates functionality that allows database information to be presented in a grid
| C# | Visual Basic |
public class DbNetGrid : GridEditControl, INamingContainer
Public Class DbNetGrid _ Inherits GridEditControl _ Implements INamingContainer
| All Members | Constructors | Methods | Properties | Fields | Events |
| Icon | Member | Description |
|---|---|---|
| DbNetGrid()()() | Initializes a new instance of the DbNetGrid class | |
| AfterRecordDelete |
Fires after a record is deleted.
(Inherited from GridEditControl.) | |
| AfterRecordInsert |
Fires after a record is inserted.
If present the identity value (or primary keys) are provided in the Identity array.
The record DataTable is also passed.
(Inherited from GridEditControl.) | |
| AfterRecordUpdate |
Fires after a record is updated.
(Inherited from GridEditControl.) | |
| AggregateCellDataBind |
This event allows you to customise the contents of a grid aggregate cell
| |
| BeforeRecordDelete |
Fires before a record is deleted. return true to accept the delete or false to cancel it.
(Inherited from GridEditControl.) | |
| BeforeRecordInsert |
Fires before a record is inserted. return true to accept the insert or false to cancel it.
The record to be inserted is passed in a DataTable which can be modified during the event.
(Inherited from GridEditControl.) | |
| BeforeRecordUpdate |
Fires before a record is updated. return true to accept the update or false to cancel it.
(Inherited from GridEditControl.) | |
| BuildMode |
Indicates the style of output for which the grid is currently being built
| |
| Caption |
Adds a Caption element to the grid table
| |
| CellDataBind |
This event allows you to customise the contents of a grid data cell
| |
| ClientInfo | (Inherited from GridEditControl.) | |
| Columns | ||
| Columns | (Inherited from GridEditControl.) | |
| ColumnValidate |
Use the ColumnValidate event to validate a column value before the edit is applied. Returning false from the handler will prevent the edit from being applied.
(Inherited from GridEditControl.) | |
| ConfigValue(String) | (Inherited from Shared.) | |
| ConnectionString |
Can be either a full connection string or an alias from the web.config <connectionStrings> section.
(Inherited from DatabaseControl.) | |
| Copy |
Adds the copy button to the toolbar
| |
| Database |
Reference the data access layer
(Inherited from DatabaseControl.) | |
| Delete |
Enables deletion of records and adds the delete button to the toolbar
(Inherited from GridEditControl.) | |
| EditDialogHeight |
Fixes the maximum height of the Edit Dialog. If the number of edit fields causes the height to be exceeded
then the edit fields entry panel will scroll.
| |
| Export |
Adds the export button to the toolbar
| |
| FilterColumnMode |
Defines how FilterColumns operate.
Has no effect unless at least one column has its Filter property set to true.
| |
| FindColumn(String) |
Returns the column from the column collection that matches the supplied column name
(Inherited from GridEditControl.) | |
| FixedFilter |
Applies a filter to the data that cannot be modified or removed from the client.
FixedFilter cannot be viewed from the client so is safe to contain sensitive db information.
(Inherited from GridEditControl.) | |
| FixedFilterParameters |
Parameters used in conjunction with the FixedFilter property
(Inherited from GridEditControl.) | |
| FixedOrderBy |
Applies a order by to the data that cannot be modified or removed from the client.
FixedOrderBy will always be applied before any additional client ordering.
FixedOrderBy cannot be viewed from the client so is safe to contain sensitive db information.
| |
| FromPart |
Database table / tables.
FromPart cannot be viewed from the client so is safe to contain sensitive db information.
(Inherited from GridEditControl.) | |
| GetCallbackResult()()() | (Inherited from Shared.) | |
| GetColumnByName(String) |
Gets a reference to the Column object using the column name
(Inherited from GridEditControl.) | |
| GetColumns()()() | (Inherited from GridEditControl.) | |
| GetScriptDescriptors()()() | (Overrides GridEditControl.GetScriptDescriptors()()().) | |
| GetScriptReferences()()() | (Overrides GridEditControl.GetScriptReferences()()().) | |
| GridExport |
Fired after a grid has been constructed for export.
| |
| GridOverflow |
Defines what will happen when a grid cannot fit within a supplied height or width.
Has no effect unless a value is supplied for either height or width.
| |
| GroupBy |
Groups the values in all the non-aggregated columns
| |
| HeadingCellDataBind |
This event allows you to customise the contents of a grid heading cell
| |
| Height |
Sets the approximate height of the grid.
If the height is set then the grid will expand horizontally. If a width is also defined
then the grid will overflow / scroll depending on the GridOverflow property
| |
| InitialOrderBy |
Defines client sort order when page first loads.
(Inherited from GridEditControl.) | |
| Insert |
Enables record insertion and adds the insert button to the toolbar
(Inherited from GridEditControl.) | |
| LoadPostData(String, NameValueCollection) | (Inherited from Shared.) | |
| MultiRowSelect |
Adds checkboxes to the right edge of the grid. Allows multiple rows to be selected.
Delete operation is applied to all selected rows.
| |
| Navigation |
Sets if the page navigation buttons are added to the toolbar.
(Inherited from GridEditControl.) | |
| NestedControls |
Allows DbNetEdit and DbNetGrid controls to be nested within the grid. Possible to nest as many controls
as needed. Nested controls will automatically have their ConnectionString and ParentControlID set.
| |
| OutputCurrentPageOption |
Adds the output current page only option to the toolbar.
Has no effect unless Export is set to true.
| |
| PageInfo |
Sets if the page info ("Page X of Y") is displayed on the toolbar.
(Inherited from GridEditControl.) | |
| PageSize |
Num of rows on the grid.
| |
| ParentControlID |
Identifies a DbNetGrid / DbNetEdit that will be the parent control in a parent child relationship.
The ConnectionString property of the child grid will get set to same value as the parent automacally (if it hasnt been set).
When setting a ParentControlID is is necessary to define columns and set a ForeignKey(s).
If the controls has the same FromPart as its parent (1:1 relationship) and you havent specified any columns then the columns and most other
settings are copied from the parent.
(Inherited from GridEditControl.) | |
Adds the print button to the toolbar
| ||
| ProcedureName |
Provide the name of a procedure instead of using FromPart.
Procedure parameters can be added to the ProcedureParameters collection (in a similar
way to how columns are defined)
| |
| ProcedureParameters |
A collection of parameters to be used when working with a stored procedure.
| |
| RaiseCallbackEvent(String) | (Inherited from Shared.) | |
| RaisePostDataChangedEvent()()() | (Inherited from Shared.) | |
| RecordDeleteError |
Fires when a database error occurs during an delete.
(Inherited from GridEditControl.) | |
| RecordInsertError |
Fires when a database error occurs during an insert.
The exception is passed as a parameter along with the record DataTable.
Return a custom error message string.
(Inherited from GridEditControl.) | |
| RecordUpdateError |
Fires when a database error occurs during an update.
The exception is passed as a parameter along with the record DataTable's.
Return a custom error message string.
(Inherited from GridEditControl.) | |
| RowDataBind |
Fired after a grid row has been constructed.
RowDataBindEventArgs object is passed. RowDataBindEventArgs contains the TableRow object
and an array containing a reference to each of the cells.
| |
| RowInfo |
Sets if the row info ("x Rows") is displayed on the toolbar.
(Inherited from GridEditControl.) | |
| RowValidate |
Use the RowValidate event to validate all modified column values before the edit is applied. Returning false from the handler will prevent the edit from being applied.
(Inherited from GridEditControl.) | |
| Search |
Sets if the search button is added to the toolbar.
(Inherited from GridEditControl.) | |
| SearchDialogHeight |
Fixes the maximum height of the Search Dialog. If the number of search fields causes the height to be exceeded
then the search criteria entry panel will scroll.
(Inherited from GridEditControl.) | |
| SetCulture(String) | (Inherited from Shared.) | |
| SetCultureFromUserLanguage()()() | (Inherited from Shared.) | |
| Toolbar |
Sets the location/visibility of the Toolbar
| |
| Update |
Enables record updating and in the case of DbNetGrid, adds the update button to the toolbar
(Inherited from GridEditControl.) | |
| ValidationColumn |
A public property of the component that can be set during any of the custom edit validation events.
if validation fails then the column with the same index number will be highlighted. Leave at -1 to not highlight any column
(Inherited from GridEditControl.) | |
| ValidationMessage |
A public property of the component that can be set during any of the custom edit validation events.
This message will be displayed to the user in the case that custom validation returns false.
(Inherited from GridEditControl.) | |
| Width |
Sets the width of the grid.
If the width is set then the grid will expand vertically. If a height is also defined
then the grid will overflow / scroll depending on the GridOverFlow property.
|
| Object | |||||
| Control | |||||
| Shared | |||||
| DatabaseControl | |||||
| GridEditControl | |||||
| DbNetGrid | |||||