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

A class for editing Cells that contain numbers

Inheritance: CellEditor, IEditorUsesRendererButtons

Protected Properties

Property	Type	Description
DownButtonID	int
UpButtonID	int

Public Methods

Method	Description
CancelEditing ( ) : void	Stops editing the Cell and ignores any changes
NumberCellEditor ( ) : System	Initializes a new instance of the NumberCellEditor class with default settings
OnEditorButtonMouseDown ( object sender, CellMouseEventArgs e ) : void	Handler for the editors buttons MouseDown event
OnEditorButtonMouseUp ( object sender, CellMouseEventArgs e ) : void	Handler for the editors buttons MouseUp event
PrepareForEditing ( Cell cell, Table table, CellPos cellPos, Rectangle cellRect, bool userSetEditorValues ) : bool	Prepares the CellEditor to edit the specified Cell
StartEditing ( ) : void	Starts editing the Cell
StopEditing ( ) : void	Stops editing the Cell and commits any changes

Protected Methods

Method	Description
DownButton ( ) : void	Simulates the down button being pressed
OnMouseWheel ( object sender, MouseEventArgs e ) : void	Handler for the editors TextBox.MouseWheel event
OnTextBoxKeyDown ( object sender, KeyEventArgs e ) : void	Handler for the editors TextBox.KeyDown event
OnTextBoxKeyPress ( object sender, KeyPressEventArgs e ) : void	Handler for the editors TextBox.KeyPress event
OnTextBoxLostFocus ( object sender, EventArgs e ) : void	Handler for the editors TextBox.LostFocus event
ParseEditText ( ) : void	Converts the editors current value to a number
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
StartTimer ( ) : void	Starts the Timer
StopTimer ( ) : void	Stops the Timer
UpButton ( ) : void	Simulates the up button being pressed
UpdateEditText ( ) : void	Updates the editors text value to the current value
ValidateEditText ( ) : void	Checks the current value and updates the editors text value

Private Methods

Method	Description
Constrain ( decimal value ) : decimal	Ensures that the specified value is between the editors Maximun and Minimum values
TimerHandler ( object sender, EventArgs e ) : void	Handler for the editors Timer event

Method Details

CancelEditing() public method

Stops editing the Cell and ignores any changes

public CancelEditing ( ) : void
return	void

DownButton() protected method

Simulates the down button being pressed

protected DownButton ( ) : void
return	void

NumberCellEditor() public method

Initializes a new instance of the NumberCellEditor class with default settings

public NumberCellEditor ( ) : System
return	System

OnEditorButtonMouseDown() public method

Handler for the editors buttons MouseDown event

public OnEditorButtonMouseDown ( object sender, CellMouseEventArgs e ) : void
sender	object	The object that raised the event
e	ZForge.Controls.XPTable.Events.CellMouseEventArgs	A CellMouseEventArgs that contains the event data
return	void

OnEditorButtonMouseUp() public method

Handler for the editors buttons MouseUp event

public OnEditorButtonMouseUp ( object sender, CellMouseEventArgs e ) : void
sender	object	The object that raised the event
e	ZForge.Controls.XPTable.Events.CellMouseEventArgs	A CellMouseEventArgs that contains the event data
return	void

OnMouseWheel() protected method

Handler for the editors TextBox.MouseWheel event

protected OnMouseWheel ( object sender, MouseEventArgs e ) : void
sender	object	The object that raised the event
e	MouseEventArgs	A MouseEventArgs that contains the event data
return	void

OnTextBoxKeyDown() protected method

Handler for the editors TextBox.KeyDown event

protected OnTextBoxKeyDown ( object sender, KeyEventArgs e ) : void
sender	object	The object that raised the event
e	System.Windows.Forms.KeyEventArgs	A KeyEventArgs that contains the event data
return	void

OnTextBoxKeyPress() protected method

Handler for the editors TextBox.KeyPress event

protected OnTextBoxKeyPress ( object sender, KeyPressEventArgs e ) : void
sender	object	The object that raised the event
e	System.Windows.Forms.KeyPressEventArgs	A KeyPressEventArgs that contains the event data
return	void

OnTextBoxLostFocus() protected method

Handler for the editors TextBox.LostFocus event

protected OnTextBoxLostFocus ( object sender, EventArgs e ) : void
sender	object	The object that raised the event
e	System.EventArgs	An EventArgs that contains the event data
return	void

ParseEditText() protected method

Converts the editors current value to a number

protected ParseEditText ( ) : void
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

SetCellValue() protected method

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

protected SetCellValue ( ) : void
return	void

SetEditLocation() protected method

Sets the location and size of the CellEditor

protected 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 method

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

protected SetEditValue ( ) : void
return	void

StartEditing() public method

Starts editing the Cell

public StartEditing ( ) : void
return	void

StartTimer() protected method

Starts the Timer

protected StartTimer ( ) : void
return	void

StopEditing() public method

Stops editing the Cell and commits any changes

public StopEditing ( ) : void
return	void

StopTimer() protected method

Stops the Timer

protected StopTimer ( ) : void
return	void

UpButton() protected method

Simulates the up button being pressed

protected UpButton ( ) : void
return	void

UpdateEditText() protected method

Updates the editors text value to the current value

protected UpdateEditText ( ) : void
return	void

ValidateEditText() protected method

Checks the current value and updates the editors text value

protected ValidateEditText ( ) : void
return	void

Property Details

DownButtonID protected_oe static_oe property

ID number for the down button

protected static int DownButtonID
return	int

UpButtonID protected_oe static_oe property

ID number for the up button

protected static int UpButtonID
return	int