C# Class Habanero.Faces.Win.GridBaseWin

Provides a DataGridView that is adapted to show business objects

Inheritance: DataGridViewWin, IGridBase

Afficher le fichier Open project: Chillisoft/habanero.faces

Private Properties

Свойство	Type	Description
ApproachColor	byte
DetermineRequiredColumnWidths	void
DistributeAvailableColumnWidths	void
DoubleClickHandler	void
FireBusinessObjectSelected	void
FireCollectionChanged	void
FireFilterUpdated	void
GetBusinessObjectCollection	IBusinessObjectCollection
GetColumnHeaderRequiredWidths	List
ImplementAlternatRowColoring	void
SetBusinessObjectCollection	void
SetIDColumnVisibility	void

Méthodes publiques

Méthode	Description
ApplyFilter ( IFilterClause filterClause ) : void	Applies a filter clause to the data table and updates the filter. The filter allows you to determine which objects to display using some criteria. This is typically generated by an IFilterControl.
ApplySearch ( IFilterClause searchClause, string orderBy ) : void	Applies a search clause to the underlying collection and reloads the grid. The search allows you to determine which objects to display using some criteria. This is typically generated by the an IFilterControl.
ApplySearch ( string searchClause, string orderBy ) : void	Applies a search clause to the underlying collection and reloads the grid. The search allows you to determine which objects to display using some criteria. This is typically generated by the an IFilterControl.
CheckUserWantsToDelete ( ) : bool	Displays a message box to the user to check if they want to proceed with deleting the selected rows.
Clear ( ) : void	Clears the business object collection and the rows in the data table
CreateDataSetProvider ( IBusinessObjectCollection col ) : IDataSetProvider	Creates a dataset provider that is applicable to this grid. For example, a readonly grid would return a ReadOnlyDataSetProvider, while an editable grid would return an editable one.
FireRowDoubleClicked ( IBusinessObject selectedBo ) : void	Creates an event for a row being double-clicked
GetBusinessObjectAtRow ( int row ) : IBusinessObject	Returns the business object at the specified row number
GetBusinessObjectRow ( IBusinessObject businessObject ) : IDataGridViewRow	Returns the row for the specified IBusinessObject.
RefreshBusinessObjectRow ( IBusinessObject businessObject ) : void	Refreshes the row values for the specified IBusinessObject.
RefreshGrid ( ) : void	Reloads the grid based on the grid returned by GetBusinessObjectCollection

Méthodes protégées

Méthode	Description
GridBaseWin ( ) : System	Constructor for GridBaseWin
ImplementColumnAutoSizingStrategy ( ) : void
MustDelete ( ) : bool	Uses the ConfirmDeletion and CheckUserConfirmsDeletion to determine Whether the SelectedBusinessObject must be deleted or not.

Private Methods

Méthode	Description
ApproachColor ( byte fg, byte bg ) : byte
DetermineRequiredColumnWidths ( List requiredWidths, int columnCount ) : void
DistributeAvailableColumnWidths ( List requiredWidths ) : void
DoubleClickHandler ( object sender, EventArgs e ) : void	Handles the event of a double-click
FireBusinessObjectSelected ( ) : void
FireCollectionChanged ( ) : void
FireFilterUpdated ( ) : void	Calls the FilterUpdated() method, passing this instance as the sender
GetBusinessObjectCollection ( ) : IBusinessObjectCollection
GetColumnHeaderRequiredWidths ( ) : List
ImplementAlternatRowColoring ( ) : void
SetBusinessObjectCollection ( IBusinessObjectCollection col ) : void
SetIDColumnVisibility ( bool visible ) : void

Method Details

ApplyFilter() public méthode

Applies a filter clause to the data table and updates the filter. The filter allows you to determine which objects to display using some criteria. This is typically generated by an IFilterControl.

public ApplyFilter ( IFilterClause filterClause ) : void
filterClause	IFilterClause	The filter clause
Résultat	void

ApplySearch() public méthode

Applies a search clause to the underlying collection and reloads the grid. The search allows you to determine which objects to display using some criteria. This is typically generated by the an IFilterControl.

public ApplySearch ( IFilterClause searchClause, string orderBy ) : void
searchClause	IFilterClause	The search clause
orderBy	string
Résultat	void

ApplySearch() public méthode

public ApplySearch ( string searchClause, string orderBy ) : void
searchClause	string	The search clause
orderBy	string
Résultat	void

CheckUserWantsToDelete() public méthode

Displays a message box to the user to check if they want to proceed with deleting the selected rows.

public CheckUserWantsToDelete ( ) : bool
Résultat	bool

Clear() public méthode

Clears the business object collection and the rows in the data table

public Clear ( ) : void
Résultat	void

CreateDataSetProvider() public abstract méthode

Creates a dataset provider that is applicable to this grid. For example, a readonly grid would return a ReadOnlyDataSetProvider, while an editable grid would return an editable one.

public abstract CreateDataSetProvider ( IBusinessObjectCollection col ) : IDataSetProvider
col	IBusinessObjectCollection	The collection to create the datasetprovider for
Résultat	IDataSetProvider

FireRowDoubleClicked() public méthode

Creates an event for a row being double-clicked

public FireRowDoubleClicked ( IBusinessObject selectedBo ) : void
selectedBo	IBusinessObject	The business object to which the /// double-click applies
Résultat	void

GetBusinessObjectAtRow() public méthode

Returns the business object at the specified row number

public GetBusinessObjectAtRow ( int row ) : IBusinessObject
row	int	The row number in question
Résultat	IBusinessObject

GetBusinessObjectRow() public méthode

Returns the row for the specified IBusinessObject.

public GetBusinessObjectRow ( IBusinessObject businessObject ) : IDataGridViewRow
businessObject	IBusinessObject	The to search for.
Résultat	IDataGridViewRow

GridBaseWin() protected méthode

Constructor for GridBaseWin

protected GridBaseWin ( ) : System
Résultat	System

ImplementColumnAutoSizingStrategy() protected méthode

protected ImplementColumnAutoSizingStrategy ( ) : void
Résultat	void

MustDelete() protected méthode

Uses the ConfirmDeletion and CheckUserConfirmsDeletion to determine Whether the SelectedBusinessObject must be deleted or not.

protected MustDelete ( ) : bool
Résultat	bool

RefreshBusinessObjectRow() public méthode

Refreshes the row values for the specified IBusinessObject.

public RefreshBusinessObjectRow ( IBusinessObject businessObject ) : void
businessObject	IBusinessObject	The for which the row must be refreshed.
Résultat	void

RefreshGrid() public méthode

Reloads the grid based on the grid returned by GetBusinessObjectCollection

public RefreshGrid ( ) : void
Résultat	void