C# Class XPTable.Editors.DropDownCellEditor

A base class for editing Cells that contain drop down buttons

Inheritance: XPTable.Editors.CellEditor, IEditorUsesRendererButtons

Mostra file Open project: binaryage/xrefresh Class Usage Examples

Public Methods

Method	Description
CancelEditing ( ) : void	Stops editing the Cell and ignores any changes
DropDownCellEditor ( ) : System	Initializes a new instance of the DropDownCellEditor class with default settings
OnEditorButtonMouseDown ( object sender, XPTable.Events.CellMouseEventArgs e ) : void	Handler for the editors drop down button MouseDown event
OnEditorButtonMouseUp ( object sender, XPTable.Events.CellMouseEventArgs e ) : void	Handler for the editors drop down button MouseUp event
PrepareForEditing ( Cell cell, Table table, XPTable.Models.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
HideDropDown ( ) : void	Conceals the drop down portion from the user
OnKeyPress ( object sender, KeyPressEventArgs e ) : void	Handler for the editors TextBox.KeyPress event
OnLostFocus ( object sender, EventArgs e ) : void	Handler for the editors TextBox.LostFocus event
ShouldStopEditing ( Control target, Point cursorPos ) : bool	Gets whether the editor should stop editing if a mouse click occurs outside of the DropDownContainer while it is dropped down
ShowDropDown ( ) : void	Displays the drop down portion to the user

Private Methods

Method	Description
textbox_MouseEnter ( object sender, EventArgs e ) : void	Handler for the editors textbox MouseEnter event

Method Details

CancelEditing() public method

Stops editing the Cell and ignores any changes

public CancelEditing ( ) : void
return	void

DropDownCellEditor() public method

Initializes a new instance of the DropDownCellEditor class with default settings

public DropDownCellEditor ( ) : System
return	System

HideDropDown() protected method

Conceals the drop down portion from the user

protected HideDropDown ( ) : void
return	void

OnEditorButtonMouseDown() public method

Handler for the editors drop down button MouseDown event

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

OnEditorButtonMouseUp() public method

Handler for the editors drop down button MouseUp event

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

OnKeyPress() protected method

Handler for the editors TextBox.KeyPress event

protected OnKeyPress ( 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

OnLostFocus() protected method

Handler for the editors TextBox.LostFocus event

protected OnLostFocus ( 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

PrepareForEditing() public method

Prepares the CellEditor to edit the specified Cell

public PrepareForEditing ( Cell cell, Table table, XPTable.Models.CellPos cellPos, Rectangle cellRect, bool userSetEditorValues ) : bool
cell	XPTable.Models.Cell	The Cell to be edited
table	XPTable.Models.Table	The Table that contains the Cell
cellPos	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

ShouldStopEditing() protected method

Gets whether the editor should stop editing if a mouse click occurs outside of the DropDownContainer while it is dropped down

protected ShouldStopEditing ( Control target, Point cursorPos ) : bool
target	System.Windows.Forms.Control	The Control that will receive the message
cursorPos	Point	The current position of the mouse cursor
return	bool

ShowDropDown() protected method

Displays the drop down portion to the user

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