C# Class Eto.Forms.Control

Inheritance: Eto.Forms.BindableWidget, IMouseInputSource, IKeyboardInputSource, ICallbackSource

Mostrar archivo Open project: picoe/Eto Class Usage Examples

Private Properties

Property	Type	Description
Control	System
TriggerLoad	void
TriggerLoadComplete	void
TriggerPreLoad	void
TriggerUnLoad	void

Public Methods

Method	Description
AttachNative ( ) : void	Attaches the control for direct use in a native application Use this to use a control directly in a native application. Note that the native application must be running the same framework as the current platform. E.g. a WinForms application can use an Eto.Forms control when using the Eto.WinForms platform. This prepares the control by firing the PreLoad, Load, etc. events.
Control ( IHandler handler ) : System	Initializes a new instance of the Container with the specified handler
Detach ( ) : void	Detaches the control by removing it from its parent This is essentially a shortcut to myControl.Parent.Remove(myControl);
FindParent ( Type type, string id = null ) : Container	Finds a control in the parent hierarchy with the specified type and Widget.ID if specified
FindParent ( string id ) : Container	Finds a control in the parent hierarchy with the specified id
Focus ( ) : void	Attempts to set the keyboard input focus to this control, or the first child that accepts focus
Invalidate ( ) : void	Queues a repaint of the entire control on the screen This is only useful when the control is visible.
Invalidate ( Eto.Drawing.Rectangle rect ) : void	Queues a repaint of the specified rect of the control This is only useful when the control is visible.
MapPlatformCommand ( string systemCommand, Eto.Forms.Command command ) : void	Specifies a command to execute for a platform-specific command Some platforms have specific system-defined commands that can be associated with a control. For example, the Mac platform's cut/copy/paste functionality is defined by the system, and if you want to hook into it, you can use this to map it to your own defined logic. The valid values of the systemCommand parameter are defined by each platform, and a list can be retrieved using Control.SupportedPlatformCommands
PointFromScreen ( Eto.Drawing.PointF point ) : Eto.Drawing.PointF	Converts a point from screen space to control space.
PointToScreen ( Eto.Drawing.PointF point ) : Eto.Drawing.PointF	Converts a point from control space to screen space
RectangleFromScreen ( Eto.Drawing.RectangleF rect ) : Eto.Drawing.RectangleF	Converts a rectangle from control space to screen space
RectangleToScreen ( Eto.Drawing.RectangleF rect ) : Eto.Drawing.RectangleF	Converts a rectangle from screen space to control space.
ResumeLayout ( ) : void	Resumes the layout after it has been suspended, and performs a layout This can be used to optimize some platforms while adding, removing, or changing many child controls at once. Each call to ResumeLayout() must be balanced with a call to SuspendLayout before it.
SuspendLayout ( ) : void	Suspends the layout of child controls This can be used to optimize some platforms while adding, removing, or changing many child controls at once. It disables the calculation of control positioning until ResumeLayout is called. Each call to SuspendLayout() must be balanced with a call to ResumeLayout.

Protected Methods

Method	Description
Dispose ( bool disposing ) : void	Handles the disposal of this control
GetCallback ( ) : object	Gets an instance of an object used to perform callbacks to the widget from handler implementations
OnEnabledChanged ( EventArgs e ) : void	Raises the EnabledChanged event.
OnGotFocus ( EventArgs e ) : void	Raises the GotFocus event.
OnKeyDown ( Eto.Forms.KeyEventArgs e ) : void	Raises the Control.KeyDown event.
OnKeyUp ( Eto.Forms.KeyEventArgs e ) : void	Raises the Control.KeyUp event.
OnLoad ( EventArgs e ) : void	Raises the Load event.
OnLoadComplete ( EventArgs e ) : void	Raises the LoadComplete event.
OnLostFocus ( EventArgs e ) : void	Raises the LostFocus event.
OnMouseDoubleClick ( Eto.Forms.MouseEventArgs e ) : void	Raises the mouse MouseDoubleClick event.
OnMouseDown ( Eto.Forms.MouseEventArgs e ) : void	Raises the Control.MouseDown event. To override default behaviour of the control, set MouseEventArgs.Handled property to `true`.
OnMouseEnter ( Eto.Forms.MouseEventArgs e ) : void	Raises the MouseEnter event.
OnMouseLeave ( Eto.Forms.MouseEventArgs e ) : void	Raises the MouseLeave event.
OnMouseMove ( Eto.Forms.MouseEventArgs e ) : void	Raises the MouseMove event.
OnMouseUp ( Eto.Forms.MouseEventArgs e ) : void	Raises the Control.MouseUp event.
OnMouseWheel ( Eto.Forms.MouseEventArgs e ) : void	Raises the MouseWheel event.
OnPreLoad ( EventArgs e ) : void	Raises the PreLoad event.
OnShown ( EventArgs e ) : void	Raises the Shown event.
OnSizeChanged ( EventArgs e ) : void	Raises the Control.SizeChanged event.
OnTextInput ( Eto.Forms.TextInputEventArgs e ) : void	Raises the TextInput event.
OnUnLoad ( EventArgs e ) : void	Raises the UnLoad event.

Private Methods

Method	Description
Control ( ) : System
TriggerLoad ( EventArgs e ) : void
TriggerLoadComplete ( EventArgs e ) : void
TriggerPreLoad ( EventArgs e ) : void
TriggerUnLoad ( EventArgs e ) : void

Method Details

AttachNative() public method

Attaches the control for direct use in a native application

Use this to use a control directly in a native application. Note that the native application must be running the same framework as the current platform. E.g. a WinForms application can use an Eto.Forms control when using the Eto.WinForms platform. This prepares the control by firing the PreLoad, Load, etc. events.

public AttachNative ( ) : void
return	void

Control() public method

Initializes a new instance of the Container with the specified handler

public Control ( IHandler handler ) : System
handler	IHandler	Pre-created handler to attach to this instance
return	System

Detach() public method

Detaches the control by removing it from its parent

This is essentially a shortcut to myControl.Parent.Remove(myControl);

public Detach ( ) : void
return	void

Dispose() protected method

Handles the disposal of this control

protected Dispose ( bool disposing ) : void
disposing	bool	True if the caller called manually, false if being called from a finalizer
return	void

FindParent() public method

Finds a control in the parent hierarchy with the specified type and Widget.ID if specified

public FindParent ( Type type, string id = null ) : Container
type	System.Type	The type of control to find.
id	string	Identifier of the parent control to find, or null to find by type only.
return	Container

FindParent() public method

Finds a control in the parent hierarchy with the specified id

public FindParent ( string id ) : Container
id	string	Identifier of the parent control to find.
return	Container

Focus() public method

Attempts to set the keyboard input focus to this control, or the first child that accepts focus

public Focus ( ) : void
return	void

GetCallback() protected method

Gets an instance of an object used to perform callbacks to the widget from handler implementations

protected GetCallback ( ) : object
return	object

Invalidate() public method

Queues a repaint of the entire control on the screen

This is only useful when the control is visible.

public Invalidate ( ) : void
return	void

Invalidate() public method

Queues a repaint of the specified rect of the control

This is only useful when the control is visible.

public Invalidate ( Eto.Drawing.Rectangle rect ) : void
rect	Eto.Drawing.Rectangle	Rectangle to repaint
return	void

MapPlatformCommand() public method

Specifies a command to execute for a platform-specific command

Some platforms have specific system-defined commands that can be associated with a control. For example, the Mac platform's cut/copy/paste functionality is defined by the system, and if you want to hook into it, you can use this to map it to your own defined logic. The valid values of the systemCommand parameter are defined by each platform, and a list can be retrieved using Control.SupportedPlatformCommands

public MapPlatformCommand ( string systemCommand, Eto.Forms.Command command ) : void
systemCommand	string	System command
command	Eto.Forms.Command	Command to execute, or null to restore to the default behavior
return	void

OnEnabledChanged() protected method

Raises the EnabledChanged event.

protected OnEnabledChanged ( EventArgs e ) : void
e	System.EventArgs	Event arguments
return	void

OnGotFocus() protected method

Raises the GotFocus event.

protected OnGotFocus ( EventArgs e ) : void
e	System.EventArgs	Event arguments
return	void

OnKeyDown() protected method

Raises the Control.KeyDown event.

protected OnKeyDown ( Eto.Forms.KeyEventArgs e ) : void
e	Eto.Forms.KeyEventArgs	Key event arguments
return	void

OnKeyUp() protected method

Raises the Control.KeyUp event.

protected OnKeyUp ( Eto.Forms.KeyEventArgs e ) : void
e	Eto.Forms.KeyEventArgs	Key event arguments
return	void

OnLoad() protected method

Raises the Load event.

protected OnLoad ( EventArgs e ) : void
e	System.EventArgs	Event arguments
return	void

OnLoadComplete() protected method

Raises the LoadComplete event.

protected OnLoadComplete ( EventArgs e ) : void
e	System.EventArgs	Event arguments
return	void

OnLostFocus() protected method

Raises the LostFocus event.

protected OnLostFocus ( EventArgs e ) : void
e	System.EventArgs	Event arguments
return	void

OnMouseDoubleClick() protected method

Raises the mouse MouseDoubleClick event.

protected OnMouseDoubleClick ( Eto.Forms.MouseEventArgs e ) : void
e	Eto.Forms.MouseEventArgs	Mouse event arguments
return	void

OnMouseDown() protected method

Raises the Control.MouseDown event.

To override default behaviour of the control, set MouseEventArgs.Handled property to true.

protected OnMouseDown ( Eto.Forms.MouseEventArgs e ) : void
e	Eto.Forms.MouseEventArgs	Event arguments
return	void

OnMouseEnter() protected method

Raises the MouseEnter event.

protected OnMouseEnter ( Eto.Forms.MouseEventArgs e ) : void
e	Eto.Forms.MouseEventArgs	Mouse event arguments
return	void

OnMouseLeave() protected method

Raises the MouseLeave event.

protected OnMouseLeave ( Eto.Forms.MouseEventArgs e ) : void
e	Eto.Forms.MouseEventArgs	Mouse event arguments
return	void

OnMouseMove() protected method

Raises the MouseMove event.

protected OnMouseMove ( Eto.Forms.MouseEventArgs e ) : void
e	Eto.Forms.MouseEventArgs	Mouse event args
return	void

OnMouseUp() protected method

Raises the Control.MouseUp event.

protected OnMouseUp ( Eto.Forms.MouseEventArgs e ) : void
e	Eto.Forms.MouseEventArgs	Event arguments
return	void

OnMouseWheel() protected method

Raises the MouseWheel event.

protected OnMouseWheel ( Eto.Forms.MouseEventArgs e ) : void
e	Eto.Forms.MouseEventArgs	Event arguments
return	void

OnPreLoad() protected method

Raises the PreLoad event.

protected OnPreLoad ( EventArgs e ) : void
e	System.EventArgs	Event arguments
return	void

OnShown() protected method

Raises the Shown event.

protected OnShown ( EventArgs e ) : void
e	System.EventArgs	Event arguments
return	void

OnSizeChanged() protected method

Raises the Control.SizeChanged event.

protected OnSizeChanged ( EventArgs e ) : void
e	System.EventArgs	Event arguments
return	void

OnTextInput() protected method

Raises the TextInput event.

protected OnTextInput ( Eto.Forms.TextInputEventArgs e ) : void
e	Eto.Forms.TextInputEventArgs	Event arguments
return	void

OnUnLoad() protected method

Raises the UnLoad event.

protected OnUnLoad ( EventArgs e ) : void
e	System.EventArgs	Event arguments
return	void

PointFromScreen() public method

Converts a point from screen space to control space.

public PointFromScreen ( Eto.Drawing.PointF point ) : Eto.Drawing.PointF
point	Eto.Drawing.PointF	Point in screen space
return	Eto.Drawing.PointF

PointToScreen() public method

Converts a point from control space to screen space

public PointToScreen ( Eto.Drawing.PointF point ) : Eto.Drawing.PointF
point	Eto.Drawing.PointF	Point in control space
return	Eto.Drawing.PointF

RectangleFromScreen() public method

Converts a rectangle from control space to screen space

public RectangleFromScreen ( Eto.Drawing.RectangleF rect ) : Eto.Drawing.RectangleF
rect	Eto.Drawing.RectangleF	Rectangle in control space
return	Eto.Drawing.RectangleF

RectangleToScreen() public method

Converts a rectangle from screen space to control space.

public RectangleToScreen ( Eto.Drawing.RectangleF rect ) : Eto.Drawing.RectangleF
rect	Eto.Drawing.RectangleF	Rectangle in screen space
return	Eto.Drawing.RectangleF

ResumeLayout() public method

Resumes the layout after it has been suspended, and performs a layout

This can be used to optimize some platforms while adding, removing, or changing many child controls at once. Each call to ResumeLayout() must be balanced with a call to SuspendLayout before it.

public ResumeLayout ( ) : void
return	void

SuspendLayout() public method

Suspends the layout of child controls

This can be used to optimize some platforms while adding, removing, or changing many child controls at once. It disables the calculation of control positioning until ResumeLayout is called. Each call to SuspendLayout() must be balanced with a call to ResumeLayout.

public SuspendLayout ( ) : void
return	void