C# Class Habanero.Faces.Base.GridBaseInitialiser

Initialises the structure of a IGridBase. If a ClassDef is provided, the grid is initialised using the UI definition provided for that class. If no ClassDef is provided, it is assumed that the grid will be set up in code by the developer. This only initialises the GridBase i.e. the Columns on the Grid and does not initialise things like the FilterControlControl.

Inheritance: IGridInitialiser

ファイルを表示 Open project: Chillisoft/habanero.faces Class Usage Examples

Private Properties

Property	Type	Description
CreateColumnForUIDef	void
CreateCustomColumn	IDataGridViewColumn
CreateIDColumn	void
CreateStandardColumn	IDataGridViewColumn
GetGridDef	IUIGrid
GetGridIDColumnName	string
GetIDColumn	IDataGridViewColumn
GetPropDef	IPropDef
GetPropertyType	System.Type
SetUpGridColumns	void
SetupColumnWithDefParameters	void
SetupDateTimeWithParameters	void

Public Methods

Method	Description
GridBaseInitialiser ( IGridBase gridBase, IControlFactory controlFactory ) : System	Initialise the grid with the appropriate control factory.
InitialiseGrid ( ) : void	Initialises the grid without a ClassDef. This is typically used where the columns are set up manually for purposes such as adding a column with images to indicate the state of the object or adding a column with buttons/links. The grid must already have at least one column added. At least one column must be a column with the name "HABANERO_OBJECTID", which is used to synchronise the grid with the business objects.
InitialiseGrid ( IClassDef classDef ) : void	Initialises the grid with the default UI definition for the class, as provided in the ClassDef
InitialiseGrid ( IClassDef classDef, IUIGrid uiGridDef, string uiDefName ) : void	Initialises the grid with a given alternate UI definition for the class
InitialiseGrid ( IClassDef classDef, string uiDefName ) : void	Initialises the grid with a specified alternate UI definition for the class, as provided in the ClassDef

Protected Methods

Method	Description
SetupCurrencyWithParameters ( Type propertyType, IUIGridColumn gridColDef, IDataGridViewColumn column ) : void

Private Methods

Method	Description
CreateColumnForUIDef ( IClassDef classDef, IUIGrid gridDef ) : void
CreateCustomColumn ( IUIGridColumn columnDef ) : IDataGridViewColumn
CreateIDColumn ( ) : void
CreateStandardColumn ( string columnName, string columnHeader ) : IDataGridViewColumn
GetGridDef ( ClassDef classDef, string uiDefName ) : IUIGrid
GetGridIDColumnName ( ) : string
GetIDColumn ( ) : IDataGridViewColumn
GetPropDef ( IClassDef classDef, IUIGridColumn gridColumn ) : IPropDef
GetPropertyType ( IClassDef classDef, string propertyName ) : Type
SetUpGridColumns ( IClassDef classDef, IUIGrid gridDef ) : void
SetupColumnWithDefParameters ( IDataGridViewColumn col, IUIGridColumn gridColDef, Type propertyType ) : void
SetupDateTimeWithParameters ( Type propertyType, IUIGridColumn gridColDef, IDataGridViewColumn col ) : void

Method Details

GridBaseInitialiser() public method

Initialise the grid with the appropriate control factory.

public GridBaseInitialiser ( IGridBase gridBase, IControlFactory controlFactory ) : System
gridBase	IGridBase
controlFactory	IControlFactory
return	System

InitialiseGrid() public method

Initialises the grid without a ClassDef. This is typically used where the columns are set up manually for purposes such as adding a column with images to indicate the state of the object or adding a column with buttons/links.
The grid must already have at least one column added. At least one column must be a column with the name "HABANERO_OBJECTID", which is used to synchronise the grid with the business objects.

Thrown in the case where the columns /// have not already been defined for the grid Thrown in the case where the grid has already been initialised

public InitialiseGrid ( ) : void
return	void

InitialiseGrid() public method

Initialises the grid with the default UI definition for the class, as provided in the ClassDef

public InitialiseGrid ( IClassDef classDef ) : void
classDef	IClassDef	The ClassDef used to initialise the grid
return	void

InitialiseGrid() public method

Initialises the grid with a given alternate UI definition for the class

public InitialiseGrid ( IClassDef classDef, IUIGrid uiGridDef, string uiDefName ) : void
classDef	IClassDef	The Classdef used to initialise the grid
uiGridDef	IUIGrid	The that specifies the grid
uiDefName	string	The name of the
return	void

InitialiseGrid() public method

Initialises the grid with a specified alternate UI definition for the class, as provided in the ClassDef

public InitialiseGrid ( IClassDef classDef, string uiDefName ) : void
classDef	IClassDef	The Classdef used to initialise the grid
uiDefName	string	The name of the UI definition
return	void

SetupCurrencyWithParameters() protected static method

protected static SetupCurrencyWithParameters ( Type propertyType, IUIGridColumn gridColDef, IDataGridViewColumn column ) : void
propertyType	System.Type
gridColDef	IUIGridColumn
column	IDataGridViewColumn
return	void