C# Class Habanero.Faces.Win.EditableGridWin

Provides a grid on which the user can edit data and add new business objects directly.
IMPORTANT: This grid does not provide any buttons or menus for users to save the changes they have made, and all changes will be lost if the form is closed and changes are not saved programmatically. Either carry out a dirty check when the parent form is closed and take appropriate save action using SaveChanges(), or use an IEditableGridControl, which provides Save and Cancel buttons.

Inheritance: GridBaseWin, IEditableGrid

Show file Open project: Chillisoft/habanero.faces Class Usage Examples

Public Methods

Method	Description
CellClickHandler ( object sender, System.Windows.Forms.DataGridViewCellEventArgs e ) : void	Carries out additional actions when a cell is clicked. Specifically, if a combobox cell is clicked, the cell goes into edit mode immediately.
CheckIfComboBoxShouldSetToEditMode ( int columnIndex, int rowIndex ) : bool	Checks whether this is a comboboxcolumn and whether it should begin edit immediately (to circumvent the pain of having to click a cell multiple times to edit the value). This method is typically called by the cell click handler. This method was extracted from the handler in order to make testing possible, since calling BeginEdit at testing time causes an STA thread error.
CreateDataSetProvider ( IBusinessObjectCollection col ) : IDataSetProvider	Creates a dataset provider that is applicable to this grid. For example, a readonly grid would return a read only datasetprovider, while an editable grid would return an editable one.
DeleteKeyHandler ( ) : void	Carries out actions when the delete key on the keyboard is pressed
EditableGridWin ( ) : System	Constructs the EditableGridWin
RejectChanges ( ) : void	Restore the objects in the grid to their last saved state
SaveChanges ( ) : void	Saves the changes made to the data in the grid

Protected Methods

Method	Description
ProcessDataGridViewKey ( KeyEventArgs e ) : bool	A Microsoft-suggested override to catch key presses, since KeyPress does not work correctly on DataGridView
ProcessDialogKey ( Keys keyData ) : bool	A Microsoft-suggested override to catch key presses, since KeyPress does not work correctly on DataGridView

Private Methods

Method	Description
CheckRowEvent ( System.Windows.Forms.DataGridViewRowCancelEventArgs e ) : void
ConfirmRowDeletion ( object sender, System.Windows.Forms.DataGridViewRowCancelEventArgs e ) : void	If deletion is to be confirmed, checks deletion with the user before continuing. This applies only to the default delete behaviour where a full row is selected by clicking on the column.
GetRowObjectIDValue ( System.Windows.Forms.DataGridViewRow row ) : System.Guid
ResetBOCollection ( ) : void

Method Details

CellClickHandler() public method

Carries out additional actions when a cell is clicked. Specifically, if a combobox cell is clicked, the cell goes into edit mode immediately.

public CellClickHandler ( object sender, System.Windows.Forms.DataGridViewCellEventArgs e ) : void
sender	object
e	System.Windows.Forms.DataGridViewCellEventArgs
return	void

CheckIfComboBoxShouldSetToEditMode() public method

Checks whether this is a comboboxcolumn and whether it should begin edit immediately (to circumvent the pain of having to click a cell multiple times to edit the value). This method is typically called by the cell click handler.

This method was extracted from the handler in order to make testing possible, since calling BeginEdit at testing time causes an STA thread error.

public CheckIfComboBoxShouldSetToEditMode ( int columnIndex, int rowIndex ) : bool
columnIndex	int
rowIndex	int
return	bool

CreateDataSetProvider() public method

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

public CreateDataSetProvider ( IBusinessObjectCollection col ) : IDataSetProvider
col	IBusinessObjectCollection	The collection to create the datasetprovider for
return	IDataSetProvider

DeleteKeyHandler() public method

Carries out actions when the delete key on the keyboard is pressed

public DeleteKeyHandler ( ) : void
return	void

EditableGridWin() public method

Constructs the EditableGridWin

public EditableGridWin ( ) : System
return	System

ProcessDataGridViewKey() protected method

A Microsoft-suggested override to catch key presses, since KeyPress does not work correctly on DataGridView

protected ProcessDataGridViewKey ( KeyEventArgs e ) : bool
e	System.Windows.Forms.KeyEventArgs
return	bool

ProcessDialogKey() protected method

A Microsoft-suggested override to catch key presses, since KeyPress does not work correctly on DataGridView

protected ProcessDialogKey ( Keys keyData ) : bool
keyData	Keys
return	bool

RejectChanges() public method

Restore the objects in the grid to their last saved state

public RejectChanges ( ) : void
return	void

SaveChanges() public method

Saves the changes made to the data in the grid

public SaveChanges ( ) : void
return	void