ObjectGrid Control

The ObjectGrid control displays a collection of items on which a variety of operation can be performed. By default the properties with IsGridVisible set to true are displayed on the columns of the grid. The selected columns can be overridden by specifying them in the SelectedColumnNames property of the grid. The grid allows the items to be paged, filtered, sorted and searched. Items of the grid can then be selected individually for viewing, editing, changing status and getting history. It is also possible to add custom functionality by adding controls to each row of the grid.

Configuration

Property	Short Description
TargetObjectName	Name of the object in the TurnSystem that will be represented by this control.
TargetSystemName	Name of the TurnSystem that will be used by this control.

Appearance

Property	Short Description
AddButtonText	Text on the add items button.
BackButtonText	Text on the return to grid button.
PrevButtonText	PrevButtonText
NextButtonText	Text on the next item button.
ExportButtonText	Text on the export list button.
PageSize	Number of items displayed on each page of the grid.
CssPrefix	Controls will use the style with the specified prefix.

Behavior

Property	Short Description
EnableSecurity	Determines if the control will be constrained by the current users security rights.
EnableAdd	Allow new items to be added.
EnableNavigation	Allow navigation of next and previous items while in detail mode.
EnablePaging	Allow the items to be spread accross pages.
EnableHistory	Allow viewing the history of an items.
EnableSearch	Allow searching of items in the grid data.
EnableFilterSelect	Allow selecting a filter on the items.
FilterBy	String representing the value to filter the collection data by.
EnableMultiFilterModify	Allow selection of multiple items to preform an operation on.
EnableSort	Allow sorting by each column in the grid.
EnableSearch	Allow searching of items in the grid data.
EnableEmptySearch	Allow searches with no criteria, resulting in all data being returned. This could be a performance issue if the resulting data set is large.
EnableSummary	Adds a report summary line to the grid which will show the results of each property's ReportOperationType.
EnableEdit	Allow editing of the items in the grid.
EnableDetail	Allow viewing the details of an item in the grid.
DataCacheTime	Amount of time in seconds the data in the grid is cached. Set to zero for no data caching.
ExportFormat	Format to export the data in when the 'Export' button is selected.
SelectedColumnNames	Columns that will be displayed in the grid.

Grid Events

IGridCustomRowCells

It is possible to add custom controls to each row of the grid. These controls should be used to perform custom actions on the item in the selected row. The signature of the implemented call is described below. An example of using custom controls can be found in the CustomGrid.aspx page of the ContactDatabase example project.

void AddCellControls(TableCell td, int rowKey, TurnCss css);

Parameter	Description
td	The cell that will hold the custom controls.
rowKey	The CommandArgument of the custom controls should be set to the rowKey. The ID of the custom controls will use this to uniquely identify them.
css	Custom controls should use the TurnCss that has been set for them in the grid.