Class EvergineForm

Default Rendering Form.

Inheritance
object
MarshalByRefObject
Component
Control
ScrollableControl
ContainerControl
Form
EvergineForm
Namespace: Evergine.Forms
Assembly: Evergine.Forms.dll
Syntax
public class EvergineForm : Form

Constructors

EvergineForm()

Initializes a new instance of the EvergineForm class.

Declaration
public EvergineForm()

EvergineForm(string, int, int)

Initializes a new instance of the EvergineForm class.

Declaration
public EvergineForm(string text, int width, int height)
Parameters
Type Name Description
string text

The text.
int width

Windows width.
int height

Windows height.

Properties

AllowUserResizing

Gets or sets a value indicating whether this form can be resized by the user. See remarks.

Declaration
public bool AllowUserResizing { get; set; }
Property Value
Type Description
bool

true if this form can be resized by the user (by default); otherwise, false.
Remarks

This property alters FormBorderStyle, for true value it is Sizable, for false - FixedSingle.

IsFullscreen

Gets or sets a value indicating whether gets or sets a value indicationg whether the current render form is in fullscreen mode. See remarks.

Declaration
public bool IsFullscreen { get; set; }
Property Value
Type Description
bool
Remarks

If Toolkit is used, this property is set automatically, otherwise user should maintain it himself as it affects the behavior of AllowUserResizing property.

KeyboardDispatcher

Gets dispatch keyboard events associated to a window.

Declaration
public FormsKeyboardDispatcher KeyboardDispatcher { get; }
Property Value
Type Description
FormsKeyboardDispatcher

MouseDispatcher

Gets dispatch mouse events associated to a window.

Declaration
public FormsMouseDispatcher MouseDispatcher { get; }
Property Value
Type Description
FormsMouseDispatcher

TouchDispatcher

Gets dispatch pointer events associated to a window.

Declaration
public FormsTouchDispatcher TouchDispatcher { get; }
Property Value
Type Description
FormsTouchDispatcher

Methods

OnClientSizeChanged(EventArgs)

Raises the ClientSizeChanged event.

Declaration
protected override void OnClientSizeChanged(EventArgs e)
Parameters
Type Name Description
EventArgs e

An EventArgs that contains the event data.
Overrides

OnHandleCreated(EventArgs)

Raises the HandleCreated event.

Declaration
protected override void OnHandleCreated(EventArgs e)
Parameters
Type Name Description
EventArgs e

An EventArgs that contains the event data.
Overrides

OnLoad(EventArgs)

Raises the Load event.

Declaration
protected override void OnLoad(EventArgs e)
Parameters
Type Name Description
EventArgs e

An EventArgs that contains the event data.
Overrides

OnPaintBackground(PaintEventArgs)

Paints the background of the control.

Declaration
protected override void OnPaintBackground(PaintEventArgs e)
Parameters
Type Name Description
PaintEventArgs e

A PaintEventArgs that contains the event data.
Overrides

OnResizeBegin(EventArgs)

Raises the ResizeBegin event.

Declaration
protected override void OnResizeBegin(EventArgs e)
Parameters
Type Name Description
EventArgs e

A EventArgs that contains the event data.
Overrides

OnResizeEnd(EventArgs)

Raises the ResizeEnd event.

Declaration
protected override void OnResizeEnd(EventArgs e)
Parameters
Type Name Description
EventArgs e

A EventArgs that contains the event data.
Overrides

ProcessDialogKey(Keys)

Processes a dialog box key.

Declaration
protected override bool ProcessDialogKey(Keys keyData)
Parameters
Type Name Description
Keys keyData

One of the Keys values that represents the key to process.
Returns
Type Description
bool

true if the keystroke was processed and consumed by the control; otherwise, false to allow further processing.
Overrides

WndProc(ref Message)

Override windows message loop handling.

Declaration
protected override void WndProc(ref Message m)
Parameters
Type Name Description
Message m

The Windows Message to process.
Overrides

Events

AppActivated

Occurs when [app activated].

Declaration
public event EventHandler<EventArgs> AppActivated
Event Type
Type Description
EventHandler<EventArgs>

AppDeactivated

Occurs when [app deactivated].

Declaration
public event EventHandler<EventArgs> AppDeactivated
Event Type
Type Description
EventHandler<EventArgs>

MonitorChanged

Occurs when [monitor changed].

Declaration
public event EventHandler<EventArgs> MonitorChanged
Event Type
Type Description
EventHandler<EventArgs>

PauseRendering

Occurs when [pause rendering].

Declaration
public event EventHandler<EventArgs> PauseRendering
Event Type
Type Description
EventHandler<EventArgs>

ResumeRendering

Occurs when [resume rendering].

Declaration
public event EventHandler<EventArgs> ResumeRendering
Event Type
Type Description
EventHandler<EventArgs>

Screensaver

Occurs when [screensaver].

Declaration
public event EventHandler<CancelEventArgs> Screensaver
Event Type
Type Description
EventHandler<CancelEventArgs>

SystemResume

Occurs when [system resume].

Declaration
public event EventHandler<EventArgs> SystemResume
Event Type
Type Description
EventHandler<EventArgs>

SystemSuspend

Occurs when [system suspend].

Declaration
public event EventHandler<EventArgs> SystemSuspend
Event Type
Type Description
EventHandler<EventArgs>

UserResized

Occurs when [user resized].

Declaration
public event EventHandler<EventArgs> UserResized
Event Type
Type Description
EventHandler<EventArgs>

Extension Methods