C# Class ZForge.Controls.XPTable.Editors.CellEditor

Base class for Cell editors

Inheritance: ICellEditor, IMouseMessageFilterClient, IKeyMessageFilterClient

Public Methods

Method	Description
CancelEditing ( ) : void	Stops editing the Cell and ignores any changes
PrepareForEditing ( Cell cell, Table table, CellPos cellPos, Rectangle cellRect, bool userSetEditorValues ) : bool	Prepares the CellEditor to edit the specified Cell
ProcessKeyMessage ( Control target, WindowMessage msg, int wParam, int lParam ) : bool	Filters out a key message before it is dispatched
ProcessMouseMessage ( Control target, WindowMessage msg, int wParam, int lParam ) : bool	Filters out a mouse message before it is dispatched
StartEditing ( ) : void	Starts editing the Cell
StopEditing ( ) : void	Stops editing the Cell and commits any changes

Protected Methods

Method	Description
CellEditor ( ) : System	Initializes a new instance of the CellEditor class with default settings
HideEditControl ( ) : void	Conceals the editor from the user, but does not remove it from the Table's Control collection
OnBeginEdit ( CellEditEventArgs e ) : void	Raises the BeginEdit event
OnCancelEdit ( CellEditEventArgs e ) : void	Raises the CancelEdit event
OnEndEdit ( CellEditEventArgs e ) : void	Raises the EndEdit event
RemoveEditControl ( ) : void	Conceals the editor from the user and removes it from the Table's Control collection
SetCellValue ( ) : void	Sets the contents of the Cell being edited based on the value in the editor
SetEditLocation ( Rectangle cellRect ) : void	Sets the location and size of the CellEditor
SetEditValue ( ) : void	Sets the initial value of the editor based on the contents of the Cell being edited
ShowEditControl ( ) : void	Displays the editor to the user and adds it to the Table's Control collection

Method Details

CancelEditing() public method

Stops editing the Cell and ignores any changes

public CancelEditing ( ) : void
return	void

CellEditor() protected method

Initializes a new instance of the CellEditor class with default settings

protected CellEditor ( ) : System
return	System

HideEditControl() protected method

Conceals the editor from the user, but does not remove it from the Table's Control collection

protected HideEditControl ( ) : void
return	void

OnBeginEdit() protected method

Raises the BeginEdit event

protected OnBeginEdit ( CellEditEventArgs e ) : void
e	ZForge.Controls.XPTable.Events.CellEditEventArgs	A CellEditEventArgs that contains the event data
return	void

OnCancelEdit() protected method

Raises the CancelEdit event

protected OnCancelEdit ( CellEditEventArgs e ) : void
e	ZForge.Controls.XPTable.Events.CellEditEventArgs	A CellEditEventArgs that contains the event data
return	void

OnEndEdit() protected method

Raises the EndEdit event

protected OnEndEdit ( CellEditEventArgs e ) : void
e	ZForge.Controls.XPTable.Events.CellEditEventArgs	A CellEditEventArgs that contains the event data
return	void

PrepareForEditing() public method

Prepares the CellEditor to edit the specified Cell

public PrepareForEditing ( Cell cell, Table table, CellPos cellPos, Rectangle cellRect, bool userSetEditorValues ) : bool
cell	ZForge.Controls.XPTable.Models.Cell	The Cell to be edited
table	ZForge.Controls.XPTable.Models.Table	The Table that contains the Cell
cellPos	ZForge.Controls.XPTable.Models.CellPos	A CellPos representing the position of the Cell
cellRect	System.Drawing.Rectangle	The Rectangle that represents the Cells location and size
userSetEditorValues	bool	Specifies whether the ICellEditors /// starting value has already been set by the user
return	bool

ProcessKeyMessage() public method

Filters out a key message before it is dispatched

public ProcessKeyMessage ( Control target, WindowMessage msg, int wParam, int lParam ) : bool
target	System.Windows.Forms.Control	The Control that will receive the message
msg	WindowMessage	A WindowMessage that represents the message to process
wParam	int	Specifies the WParam field of the message
lParam	int	Specifies the LParam field of the message
return	bool

ProcessMouseMessage() public method

Filters out a mouse message before it is dispatched

public ProcessMouseMessage ( Control target, WindowMessage msg, int wParam, int lParam ) : bool
target	System.Windows.Forms.Control	The Control that will receive the message
msg	WindowMessage	A WindowMessage that represents the message to process
wParam	int	Specifies the WParam field of the message
lParam	int	Specifies the LParam field of the message
return	bool

RemoveEditControl() protected method

Conceals the editor from the user and removes it from the Table's Control collection

protected RemoveEditControl ( ) : void
return	void

SetCellValue() protected abstract method

Sets the contents of the Cell being edited based on the value in the editor

protected abstract SetCellValue ( ) : void
return	void

SetEditLocation() protected abstract method

Sets the location and size of the CellEditor

protected abstract SetEditLocation ( Rectangle cellRect ) : void
cellRect	System.Drawing.Rectangle	A Rectangle that represents the size and location /// of the Cell being edited
return	void

SetEditValue() protected abstract method

Sets the initial value of the editor based on the contents of the Cell being edited

protected abstract SetEditValue ( ) : void
return	void

ShowEditControl() protected method

Displays the editor to the user and adds it to the Table's Control collection

protected ShowEditControl ( ) : void
return	void

StartEditing() public method

Starts editing the Cell

public StartEditing ( ) : void
return	void

StopEditing() public method

Stops editing the Cell and commits any changes

public StopEditing ( ) : void
return	void