Table of Contents

Class Control

Namespace
OmegaGUI.Model
Assembly
OmegaGUI.dll

Abstract base class for all control views

public abstract class Control : ICloneable
Inheritance
Control
Implements
Derived
Inherited Members
Extension Methods

Fields

DXControl

The OmegaGUI.Render control used for actual rendering

protected Control? DXControl

Field Value

Control

EffectiveLocation

The actual location of the control on the dialog factoring in AlignHorizontal and AlignVertical

protected Point EffectiveLocation

Field Value

Point

EffectiveSize

The actual size of the control on the dialog factoring in scaling due to Scale

protected Size EffectiveSize

Field Value

Size

IsEnabled

protected bool IsEnabled

Field Value

bool

IsVisible

protected bool IsVisible

Field Value

bool

Properties

AlignHorizontal

How to handle the X values of Location and Size

public HorizontalMode AlignHorizontal { get; set; }

Property Value

HorizontalMode

AlignVertical

How to handle the Y values of Location and Size

public VerticalMode AlignVertical { get; set; }

Property Value

VerticalMode

ControlModel

[Browsable(false)]
public Control? ControlModel { get; }

Property Value

Control

Default

Is this the default control on the dialog? - no auto-update

public bool Default { get; set; }

Property Value

bool

DrawBox

The effective area on the window were this control is rendered

[Browsable(false)]
public Rectangle DrawBox { get; }

Property Value

Rectangle

Enabled

Is this control currently active?

public bool Enabled { get; set; }

Property Value

bool

Location

The location of the control on the dialog

public Point Location { get; set; }

Property Value

Point

Name

Unique name for identifying this control

public string? Name { get; set; }

Property Value

string

OnMouseEnter

A Lua script to execute when the mouse enters the area of the control

[FileType("Lua")]
public string? OnMouseEnter { get; set; }

Property Value

string

OnMouseExit

A Lua script to execute when the mouse leaves the area of the control

[FileType("Lua")]
public string? OnMouseExit { get; set; }

Property Value

string

Size

The size of the control on the dialog

public Size Size { get; set; }

Property Value

Size

Visible

Is this control currently visible?

public bool Visible { get; set; }

Property Value

bool

Methods

Clone()

Creates a shallow copy of this control. You need to call OmegaGUI.Model.Control.Generate() on it before it can be used for rendering.

public Control Clone()

Returns

Control

The cloned control

NeedsUpdate()

protected void NeedsUpdate()

SetupMouseEvents()

protected void SetupMouseEvents()

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.