Control

Home | API by Category | Complete API Index | API Compatibility

Field	Value
Full name	Electron2D.Control
Namespace	Electron2D
Kind	class
Category	UI and Text

Overview

Provides the Electron2D base node for 2D user interface controls.

Syntax

public class Electron2D.Control : Electron2D.CanvasItem

Remarks

Control inherits from Electron2D.CanvasItem and adds a rectangular UI area, theme font overrides, GUI input callbacks, mouse filtering and focus ownership used by Electron2D UI nodes.

Anchors, offsets, minimum-size clamping, focus navigation and the baseline input pipeline are available in this preview. Containers and full widgets are implemented by later UI tasks.

Thread Safety

This type is not synchronized. Create and mutate controls on the main scene thread.

Since

This type is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.CanvasItem
• Electron2D.Label

Members

Member	Kind	Summary
AnchorBottom	Property	Gets or sets the bottom anchor of this control.
AnchorLeft	Property	Gets or sets the left anchor of this control.
AnchorRight	Property	Gets or sets the right anchor of this control.
AnchorTop	Property	Gets or sets the top anchor of this control.
ClipContents	Property	Gets or sets whether this control clips GUI hit-testing for its descendants.
CustomMinimumSize	Property	Gets or sets the custom minimum size of this control.
FocusMode	Property	Gets or sets how this control can receive focus.
FocusNeighborBottom	Property	Gets or sets the explicit focus target used for bottom-direction navigation.
FocusNeighborLeft	Property	Gets or sets the explicit focus target used for left-direction navigation.
FocusNeighborRight	Property	Gets or sets the explicit focus target used for right-direction navigation.
FocusNeighborTop	Property	Gets or sets the explicit focus target used for top-direction navigation.
FocusNext	Property	Gets or sets the explicit focus target used when navigating to the next control.
FocusPrevious	Property	Gets or sets the explicit focus target used when navigating to the previous control.
GrowHorizontal	Property	Gets or sets the horizontal grow direction used when minimum size expands this control.
GrowVertical	Property	Gets or sets the vertical grow direction used when minimum size expands this control.
MouseFilter	Property	Gets or sets how this control receives and consumes mouse input.
OffsetBottom	Property	Gets or sets the bottom offset of this control.
OffsetLeft	Property	Gets or sets the left offset of this control.
OffsetRight	Property	Gets or sets the right offset of this control.
OffsetTop	Property	Gets or sets the top offset of this control.
Position	Property	Gets or sets the local position of this control.
Size	Property	Gets or sets the local size of this control.
SizeFlagsHorizontal	Property	Gets or sets the horizontal size flags used by a parent Electron2D.Container.
SizeFlagsStretchRatio	Property	Gets or sets the expansion weight used by a parent Electron2D.Container.
SizeFlagsVertical	Property	Gets or sets the vertical size flags used by a parent Electron2D.Container.
Electron2D.Control()	Constructor	Initializes a new instance of the Control type.
AcceptEvent()	Method	Marks the current GUI input event as handled.
AddThemeConstantOverride(System.String, System.Int32)	Method	Adds or replaces an integer theme constant override for this control.
AddThemeFontOverride(System.String, Electron2D.Font)	Method	Adds or replaces a font theme override for this control.
AddThemeFontSizeOverride(System.String, System.Int32)	Method	Adds or replaces a font size theme override for this control.
FindNextValidFocus()	Method	Finds the next focusable control in this viewport.
FindPrevValidFocus()	Method	Finds the previous focusable control in this viewport.
GetCombinedMinimumSize()	Method	Gets the minimum size used by layout calculations.
GetGlobalRect()	Method	Gets the rectangle occupied by this control in root viewport coordinates.
GetMinimumSize()	Method	Gets the minimum size requested by this control.
GetRect()	Method	Gets the local rectangle occupied by this control.
GetThemeConstant(System.String)	Method	Gets an integer theme constant override by name.
GetThemeFont(System.String)	Method	Gets a font theme override by name.
GetThemeFontSize(System.String)	Method	Gets a font size theme override by name.
GrabFocus()	Method	Gives keyboard and gamepad focus to this control.
HasFocus()	Method	Checks whether this control currently owns focus in its viewport.
HasThemeConstantOverride(System.String)	Method	Reports whether this control has a theme constant override by name.
ReleaseFocus()	Method	Releases focus from this control when it currently owns it.
ResetSize()	Method	Resets this control size to its combined minimum size.
SetSize(Electron2D.Vector2)	Method	Sets the computed size of this control.
_GetMinimumSize()	Method	Called to compute the control-specific minimum size.
_GuiInput(Electron2D.InputEvent)	Method	Called when a GUI input event is delivered to this control.

Member Details

AnchorBottom

Kind: Property

public System.Single AnchorBottom { get; set; }

Summary

Gets or sets the bottom anchor of this control.

Remarks

The final bottom edge is calculated as the parent layout height multiplied by this value, plus Electron2D.Control.OffsetBottom.

Value

The bottom anchor as a fraction of the parent layout size.

Thread Safety

This property is not synchronized. Mutate it on the main scene thread.

Since

This property is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Control.AnchorTop
• Electron2D.Control.OffsetBottom

AnchorLeft

Kind: Property

public System.Single AnchorLeft { get; set; }

Summary

Gets or sets the left anchor of this control.

Remarks

The final left edge is calculated as the parent layout width multiplied by this value, plus Electron2D.Control.OffsetLeft.

Value

The left anchor as a fraction of the parent layout size.

Thread Safety

This property is not synchronized. Mutate it on the main scene thread.

Since

This property is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Control.AnchorRight
• Electron2D.Control.OffsetLeft

AnchorRight

Kind: Property

public System.Single AnchorRight { get; set; }

Summary

Gets or sets the right anchor of this control.

Remarks

The final right edge is calculated as the parent layout width multiplied by this value, plus Electron2D.Control.OffsetRight.

Value

The right anchor as a fraction of the parent layout size.

Thread Safety

This property is not synchronized. Mutate it on the main scene thread.

Since

This property is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Control.AnchorLeft
• Electron2D.Control.OffsetRight

AnchorTop

Kind: Property

public System.Single AnchorTop { get; set; }

Summary

Gets or sets the top anchor of this control.

Remarks

The final top edge is calculated as the parent layout height multiplied by this value, plus Electron2D.Control.OffsetTop.

Value

The top anchor as a fraction of the parent layout size.

Thread Safety

This property is not synchronized. Mutate it on the main scene thread.

Since

This property is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Control.AnchorBottom
• Electron2D.Control.OffsetTop

ClipContents

Kind: Property

public System.Boolean ClipContents { get; set; }

Summary

Gets or sets whether this control clips GUI hit-testing for its descendants.

Remarks

The 0.1.0 Preview baseline applies this flag to mouse and touch dispatch. Renderer scissor integration is handled by later rendering backend work.

Value

true to prevent descendants from receiving pointer input outside this control's global rectangle; otherwise, false.

Thread Safety

This property is not synchronized. Mutate it on the main scene thread.

Since

This property is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Control.GetGlobalRect
• Electron2D.Control.MouseFilter

CustomMinimumSize

Kind: Property

public Electron2D.Vector2 CustomMinimumSize { get; set; }

Summary

Gets or sets the custom minimum size of this control.

Remarks

This value is combined with Electron2D.Control._GetMinimumSize by Electron2D.Control.GetMinimumSize.

Value

The user-defined minimum size. Components must be finite and non-negative.

Exceptions

• System.ArgumentOutOfRangeException: Thrown when a component is negative or not finite.

Thread Safety

This property is not synchronized. Mutate it on the main scene thread.

Since

This property is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Control.GetCombinedMinimumSize
• Electron2D.Control._GetMinimumSize

FocusMode

Kind: Property

public Electron2D.FocusMode FocusMode { get; set; }

Summary

Gets or sets how this control can receive focus.

Remarks

Focus is owned by the nearest Electron2D.Viewport. Only one visible control inside that viewport can report Electron2D.Control.HasFocus at a time.

Electron2D.FocusMode.Click and Electron2D.FocusMode.All allow mouse press events to focus this control before Electron2D.Control._GuiInput(Electron2D.InputEvent) is called.

Value

The current Electron2D.FocusMode value. The default is Electron2D.FocusMode.None.

Thread Safety

This property is not synchronized. Mutate it on the main scene thread.

Since

This property is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Control.FocusMode
• Electron2D.Control.GrabFocus
• Electron2D.Control.HasFocus

FocusNeighborBottom

Kind: Property

public Electron2D.NodePath FocusNeighborBottom { get; set; }

Summary

Gets or sets the explicit focus target used for bottom-direction navigation.

Remarks

Directional focus paths are used by the viewport keyboard navigation baseline when arrow-key navigation is requested.

Value

A Electron2D.NodePath resolved from this control. The default value is an empty path.

Thread Safety

This property is not synchronized. Mutate it on the main scene thread.

Since

This property is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Control.FocusNeighborTop

FocusNeighborLeft

Kind: Property

public Electron2D.NodePath FocusNeighborLeft { get; set; }

Summary

Gets or sets the explicit focus target used for left-direction navigation.

Remarks

Directional focus paths are used by the viewport keyboard navigation baseline when arrow-key navigation is requested.

Value

A Electron2D.NodePath resolved from this control. The default value is an empty path.

Thread Safety

This property is not synchronized. Mutate it on the main scene thread.

Since

This property is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Control.FocusNeighborRight

FocusNeighborRight

Kind: Property

public Electron2D.NodePath FocusNeighborRight { get; set; }

Summary

Gets or sets the explicit focus target used for right-direction navigation.

Remarks

Directional focus paths are used by the viewport keyboard navigation baseline when arrow-key navigation is requested.

Value

A Electron2D.NodePath resolved from this control. The default value is an empty path.

Thread Safety

This property is not synchronized. Mutate it on the main scene thread.

Since

This property is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Control.FocusNeighborLeft

FocusNeighborTop

Kind: Property

public Electron2D.NodePath FocusNeighborTop { get; set; }

Summary

Gets or sets the explicit focus target used for top-direction navigation.

Remarks

Directional focus paths are used by the viewport keyboard navigation baseline when arrow-key navigation is requested.

Value

A Electron2D.NodePath resolved from this control. The default value is an empty path.

Thread Safety

This property is not synchronized. Mutate it on the main scene thread.

Since

This property is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Control.FocusNeighborBottom

FocusNext

Kind: Property

public Electron2D.NodePath FocusNext { get; set; }

Summary

Gets or sets the explicit focus target used when navigating to the next control.

Remarks

Electron2D.Control.FindNextValidFocus uses this path before falling back to viewport tree order.

Value

A Electron2D.NodePath resolved from this control. The default value is an empty path.

Thread Safety

This property is not synchronized. Mutate it on the main scene thread.

Since

This property is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Control.FindNextValidFocus
• Electron2D.Control.FocusPrevious

FocusPrevious

Kind: Property

public Electron2D.NodePath FocusPrevious { get; set; }

Summary

Gets or sets the explicit focus target used when navigating to the previous control.

Remarks

Electron2D.Control.FindPrevValidFocus uses this path before falling back to viewport tree order.

Value

A Electron2D.NodePath resolved from this control. The default value is an empty path.

Thread Safety

This property is not synchronized. Mutate it on the main scene thread.

Since

This property is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Control.FindPrevValidFocus
• Electron2D.Control.FocusNext

GrowHorizontal

Kind: Property

public Electron2D.GrowDirection GrowHorizontal { get; set; }

Summary

Gets or sets the horizontal grow direction used when minimum size expands this control.

Remarks

This value is used by Electron2D.Control.SetSize(Electron2D.Vector2) and Electron2D.Control.ResetSize when the requested width is smaller than the minimum width.

Value

The horizontal Electron2D.GrowDirection. The default is Electron2D.GrowDirection.End.

Thread Safety

This property is not synchronized. Mutate it on the main scene thread.

Since

This property is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Control.GrowVertical
• Electron2D.GrowDirection

GrowVertical

Kind: Property

public Electron2D.GrowDirection GrowVertical { get; set; }

Summary

Gets or sets the vertical grow direction used when minimum size expands this control.

Remarks

This value is used by Electron2D.Control.SetSize(Electron2D.Vector2) and Electron2D.Control.ResetSize when the requested height is smaller than the minimum height.

Value

The vertical Electron2D.GrowDirection. The default is Electron2D.GrowDirection.End.

Thread Safety

This property is not synchronized. Mutate it on the main scene thread.

Since

This property is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Control.GrowHorizontal
• Electron2D.GrowDirection

MouseFilter

Kind: Property

public Electron2D.MouseFilter MouseFilter { get; set; }

Summary

Gets or sets how this control receives and consumes mouse input.

Remarks

The root Electron2D.Viewport reads this property while routing Electron2D.InputEventMouse events to Electron2D.Control._GuiInput(Electron2D.InputEvent).

Electron2D.MouseFilter.Stop handles the event after this control receives it. Electron2D.MouseFilter.Pass lets unhandled events bubble to the parent control. Electron2D.MouseFilter.Ignore skips this control for mouse hit-testing.

Value

The current Electron2D.Control.MouseFilter value. The default is Electron2D.MouseFilter.Stop.

Thread Safety

This property is not synchronized. Mutate it on the main scene thread.

Since

This property is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Control.MouseFilter
• Electron2D.Control._GuiInput(Electron2D.InputEvent)

OffsetBottom

Kind: Property

public System.Single OffsetBottom { get; set; }

Summary

Gets or sets the bottom offset of this control.

Remarks

The bottom offset can be negative when the bottom edge should stay inset from the parent layout rectangle.

Value

The pixel offset applied to Electron2D.Control.AnchorBottom.

Thread Safety

This property is not synchronized. Mutate it on the main scene thread.

Since

This property is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Control.AnchorBottom
• Electron2D.Control.OffsetTop

OffsetLeft

Kind: Property

public System.Single OffsetLeft { get; set; }

Summary

Gets or sets the left offset of this control.

Remarks

Offsets are expressed in the local coordinate space of the parent layout rectangle.

Value

The pixel offset applied to Electron2D.Control.AnchorLeft.

Thread Safety

This property is not synchronized. Mutate it on the main scene thread.

Since

This property is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Control.AnchorLeft
• Electron2D.Control.OffsetRight

OffsetRight

Kind: Property

public System.Single OffsetRight { get; set; }

Summary

Gets or sets the right offset of this control.

Remarks

The right offset can be negative when the right edge should stay inset from the parent layout rectangle.

Value

The pixel offset applied to Electron2D.Control.AnchorRight.

Thread Safety

This property is not synchronized. Mutate it on the main scene thread.

Since

This property is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Control.AnchorRight
• Electron2D.Control.OffsetLeft

OffsetTop

Kind: Property

public System.Single OffsetTop { get; set; }

Summary

Gets or sets the top offset of this control.

Remarks

Offsets are expressed in the local coordinate space of the parent layout rectangle.

Value

The pixel offset applied to Electron2D.Control.AnchorTop.

Thread Safety

This property is not synchronized. Mutate it on the main scene thread.

Since

This property is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Control.AnchorTop
• Electron2D.Control.OffsetBottom

Position

Kind: Property

public Electron2D.Vector2 Position { get; set; }

Summary

Gets or sets the local position of this control.

Remarks

Setting this property updates offsets while preserving anchors and the current computed Electron2D.Control.Size.

Value

The top-left corner of the computed local rectangle.

Thread Safety

This property is not synchronized. Mutate it on the main scene thread.

Since

This property is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Control.GetGlobalRect
• Electron2D.Control.GetRect

Size

Kind: Property

public Electron2D.Vector2 Size { get; set; }

Summary

Gets or sets the local size of this control.

Remarks

Setting this property is equivalent to calling Electron2D.Control.SetSize(Electron2D.Vector2).

Value

The computed local rectangle size.

Thread Safety

This property is not synchronized. Mutate it on the main scene thread.

Since

This property is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Control.GetCombinedMinimumSize
• Electron2D.Control.SetSize(Electron2D.Vector2)

SizeFlagsHorizontal

Kind: Property

public Electron2D.SizeFlags SizeFlagsHorizontal { get; set; }

Summary

Gets or sets the horizontal size flags used by a parent Electron2D.Container.

Remarks

This property is read by layout containers only. It does not change this control's rectangle until a parent container performs layout.

Value

A Electron2D.SizeFlags value that describes how this control should use horizontal space allocated by a container.

Thread Safety

This property is not synchronized. Mutate it on the main scene thread.

Since

This property is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Container
• Electron2D.Control.SizeFlagsStretchRatio
• Electron2D.Control.SizeFlagsVertical

SizeFlagsStretchRatio

Kind: Property

public System.Single SizeFlagsStretchRatio { get; set; }

Summary

Gets or sets the expansion weight used by a parent Electron2D.Container.

Remarks

The value is considered only when the relevant size flag contains Electron2D.SizeFlags.Expand or Electron2D.SizeFlags.ExpandFill.

Value

The positive finite ratio used when a container distributes free space between expanding children.

Exceptions

• System.ArgumentOutOfRangeException: Thrown when the value is not finite or is less than or equal to zero.

Thread Safety

This property is not synchronized. Mutate it on the main scene thread.

Since

This property is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Control.SizeFlagsHorizontal
• Electron2D.Control.SizeFlagsVertical

SizeFlagsVertical

Kind: Property

public Electron2D.SizeFlags SizeFlagsVertical { get; set; }

Summary

Gets or sets the vertical size flags used by a parent Electron2D.Container.

Remarks

This property is read by layout containers only. It does not change this control's rectangle until a parent container performs layout.

Value

A Electron2D.SizeFlags value that describes how this control should use vertical space allocated by a container.

Thread Safety

This property is not synchronized. Mutate it on the main scene thread.

Since

This property is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Container
• Electron2D.Control.SizeFlagsHorizontal
• Electron2D.Control.SizeFlagsStretchRatio

Electron2D.Control()

Kind: Constructor

public Electron2D.Control()

Summary

Initializes a new instance of the Control type.

Remarks

The new instance follows the lifetime and validation rules of its declaring type.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Control

AcceptEvent()

Kind: Method

public System.Void AcceptEvent()()

Summary

Marks the current GUI input event as handled.

Remarks

This method forwards to Electron2D.Viewport.SetInputAsHandled on the containing viewport. It has no effect when this control is outside a scene tree or when no input event is currently being dispatched.

Thread Safety

This method is not synchronized. Call it on the main scene thread while handling Electron2D.Control._GuiInput(Electron2D.InputEvent).

Since

This method is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Control._GuiInput(Electron2D.InputEvent)
• Electron2D.Viewport.SetInputAsHandled

AddThemeConstantOverride(System.String, System.Int32)

Kind: Method

public System.Void AddThemeConstantOverride(System.String, System.Int32)(System.String name, System.Int32 constant)

Summary

Adds or replaces an integer theme constant override for this control.

Remarks

The 0.1.0 Preview UI containers use this baseline for spacing and margins before full theme resources are introduced.

Parameters

• name: The theme constant name, for example separation or margin_left.
• constant: The non-negative constant value in pixels.

Exceptions

• System.ArgumentException: Thrown when name is null, empty or whitespace.
• System.ArgumentOutOfRangeException: Thrown when constant is less than zero.

Thread Safety

This method is not synchronized. Call it on the main scene thread.

Since

This method is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Container
• Electron2D.Control.GetThemeConstant(System.String)
• Electron2D.Control.HasThemeConstantOverride(System.String)

AddThemeFontOverride(System.String, Electron2D.Font)

Kind: Method

public System.Void AddThemeFontOverride(System.String, Electron2D.Font)(System.String name, Electron2D.Font font)

Summary

Adds or replaces a font theme override for this control.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Parameters

• name: The theme font name, for example font.
• font: The font resource to use.

Exceptions

• System.ArgumentException: Thrown when name is null, empty or whitespace.
• System.ArgumentNullException: Thrown when font is null.

Thread Safety

This method is not synchronized. Call it on the main scene thread.

Since

This method is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Control

AddThemeFontSizeOverride(System.String, System.Int32)

Kind: Method

public System.Void AddThemeFontSizeOverride(System.String, System.Int32)(System.String name, System.Int32 fontSize)

Summary

Adds or replaces a font size theme override for this control.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Parameters

• name: The theme font size name, for example font_size.
• fontSize: The font size in pixels. It must be greater than zero.

Exceptions

• System.ArgumentException: Thrown when name is null, empty or whitespace.
• System.ArgumentOutOfRangeException: Thrown when fontSize is less than or equal to zero.

Thread Safety

This method is not synchronized. Call it on the main scene thread.

Since

This method is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Control

FindNextValidFocus()

Kind: Method

public Electron2D.Control FindNextValidFocus()()

Summary

Finds the next focusable control in this viewport.

Remarks

Controls are valid focus targets only when they are inside the same Electron2D.Viewport, visible in tree and have Electron2D.Control.FocusMode set to a value other than Electron2D.FocusMode.None.

Returns

The explicit Electron2D.Control.FocusNext target when it is valid; otherwise, the next focusable control in viewport tree order, or null when no valid control exists.

Thread Safety

This method is not synchronized. Call it on the main scene thread.

Since

This method is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Control.FindPrevValidFocus
• Electron2D.Control.FocusNext

FindPrevValidFocus()

Kind: Method

public Electron2D.Control FindPrevValidFocus()()

Summary

Finds the previous focusable control in this viewport.

Remarks

Controls are valid focus targets only when they are inside the same Electron2D.Viewport, visible in tree and have Electron2D.Control.FocusMode set to a value other than Electron2D.FocusMode.None.

Returns

The explicit Electron2D.Control.FocusPrevious target when it is valid; otherwise, the previous focusable control in viewport tree order, or null when no valid control exists.

Thread Safety

This method is not synchronized. Call it on the main scene thread.

Since

This method is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Control.FindNextValidFocus
• Electron2D.Control.FocusPrevious

GetCombinedMinimumSize()

Kind: Method

public Electron2D.Vector2 GetCombinedMinimumSize()()

Summary

Gets the minimum size used by layout calculations.

Remarks

In the 0.1.0 Preview layout baseline this is the same value as Electron2D.Control.GetMinimumSize. Future container and theme work can add style contributions without changing the public call site.

Returns

The combined minimum size for this control.

Thread Safety

This method is not synchronized. Call it on the main scene thread.

Since

This method is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Control.GetMinimumSize
• Electron2D.Control.SetSize(Electron2D.Vector2)

GetGlobalRect()

Kind: Method

public Electron2D.Rect2 GetGlobalRect()()

Summary

Gets the rectangle occupied by this control in root viewport coordinates.

Remarks

Parent Electron2D.Control positions are accumulated. A Electron2D.Node2D parent applies its global transform to the local position baseline.

Returns

A Electron2D.Rect2 containing the global position and computed Electron2D.Control.Size.

Thread Safety

This method is not synchronized. Call it on the main scene thread.

Since

This method is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Control.GetRect
• Electron2D.Control.Position

GetMinimumSize()

Kind: Method

public Electron2D.Vector2 GetMinimumSize()()

Summary

Gets the minimum size requested by this control.

Remarks

This method is the minimum-size baseline used before container and theme contributions are introduced.

Returns

The component-wise maximum of Electron2D.Control.CustomMinimumSize and Electron2D.Control._GetMinimumSize.

Thread Safety

This method is not synchronized. Call it on the main scene thread.

Since

This method is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Control.GetCombinedMinimumSize
• Electron2D.Control._GetMinimumSize

GetRect()

Kind: Method

public Electron2D.Rect2 GetRect()()

Summary

Gets the local rectangle occupied by this control.

Remarks

The rectangle is computed from anchors and offsets against the current parent layout size.

Returns

A Electron2D.Rect2 containing Electron2D.Control.Position and Electron2D.Control.Size.

Thread Safety

This method is not synchronized. Call it on the main scene thread.

Since

This method is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Control.AnchorLeft
• Electron2D.Control.GetGlobalRect

GetThemeConstant(System.String)

Kind: Method

public System.Int32 GetThemeConstant(System.String)(System.String name)

Summary

Gets an integer theme constant override by name.

Remarks

Containers use this method for spacing and margin values. Missing values deliberately resolve to zero so a caller can supply its own default.

Parameters

• name: The theme constant name.

Returns

The overridden constant value, or 0 when no override exists.

Exceptions

• System.ArgumentException: Thrown when name is null, empty or whitespace.

Thread Safety

This method is not synchronized. Call it on the main scene thread.

Since

This method is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Control.AddThemeConstantOverride(System.String,System.Int32)
• Electron2D.Control.HasThemeConstantOverride(System.String)

GetThemeFont(System.String)

Kind: Method

public Electron2D.Font GetThemeFont(System.String)(System.String name)

Summary

Gets a font theme override by name.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Parameters

• name: The theme font name.

Returns

The overridden font, or null when no override exists.

Exceptions

• System.ArgumentException: Thrown when name is null, empty or whitespace.

Thread Safety

This method is not synchronized. Call it on the main scene thread.

Since

This method is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Control

GetThemeFontSize(System.String)

Kind: Method

public System.Int32 GetThemeFontSize(System.String)(System.String name)

Summary

Gets a font size theme override by name.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Parameters

• name: The theme font size name.

Returns

The overridden font size in pixels, or 16 when no override exists.

Exceptions

• System.ArgumentException: Thrown when name is null, empty or whitespace.

Thread Safety

This method is not synchronized. Call it on the main scene thread.

Since

This method is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Control

GrabFocus()

Kind: Method

public System.Void GrabFocus()()

Summary

Gives keyboard and gamepad focus to this control.

Remarks

The control must be inside a scene tree, visible in that tree and have Electron2D.Control.FocusMode set to a value other than Electron2D.FocusMode.None. If any of those conditions is not met, the call has no effect.

Thread Safety

This method is not synchronized. Call it on the main scene thread.

Since

This method is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Control.FocusMode
• Electron2D.Control.HasFocus
• Electron2D.Control.ReleaseFocus

HasFocus()

Kind: Method

public System.Boolean HasFocus()()

Summary

Checks whether this control currently owns focus in its viewport.

Remarks

Hidden controls and controls outside a scene tree do not report focus, even if they were the last control selected before becoming invalid for focus dispatch.

Returns

true when this control is the focused visible control in its viewport; otherwise, false.

Thread Safety

This method is not synchronized. Call it on the main scene thread.

Since

This method is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Control.GrabFocus
• Electron2D.Control.ReleaseFocus

HasThemeConstantOverride(System.String)

Kind: Method

public System.Boolean HasThemeConstantOverride(System.String)(System.String name)

Summary

Reports whether this control has a theme constant override by name.

Remarks

This method lets container code distinguish a missing value from an explicit zero value.

Parameters

• name: The theme constant name.

Returns

true when an override exists; otherwise, false.

Exceptions

• System.ArgumentException: Thrown when name is null, empty or whitespace.

Thread Safety

This method is not synchronized. Call it on the main scene thread.

Since

This method is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Control.AddThemeConstantOverride(System.String,System.Int32)
• Electron2D.Control.GetThemeConstant(System.String)

ReleaseFocus()

Kind: Method

public System.Void ReleaseFocus()()

Summary

Releases focus from this control when it currently owns it.

Remarks

Calling this method on a control that does not currently own focus is a no-op.

Thread Safety

This method is not synchronized. Call it on the main scene thread.

Since

This method is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Control.GrabFocus
• Electron2D.Control.HasFocus

ResetSize()

Kind: Method

public System.Void ResetSize()()

Summary

Resets this control size to its combined minimum size.

Remarks

The current Electron2D.Control.GrowHorizontal and Electron2D.Control.GrowVertical values decide whether the beginning side, ending side or both sides move while the rectangle changes.

Thread Safety

This method is not synchronized. Call it on the main scene thread.

Since

This method is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Control.GetCombinedMinimumSize
• Electron2D.Control.SetSize(Electron2D.Vector2)

SetSize(Electron2D.Vector2)

Kind: Method

public System.Void SetSize(Electron2D.Vector2)(Electron2D.Vector2 size)

Summary

Sets the computed size of this control.

Remarks

If size is smaller than Electron2D.Control.GetCombinedMinimumSize, this method grows the final rectangle according to Electron2D.Control.GrowHorizontal and Electron2D.Control.GrowVertical.

Parameters

• size: The requested size in local coordinates.

Exceptions

• System.ArgumentOutOfRangeException: Thrown when a component of size is negative or not finite.

Thread Safety

This method is not synchronized. Call it on the main scene thread.

Since

This method is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Control.ResetSize
• Electron2D.Control.Size

_GetMinimumSize()

Kind: Method

public Electron2D.Vector2 _GetMinimumSize()()

Summary

Called to compute the control-specific minimum size.

Remarks

Derived controls can override this method to reserve space for text, textures or other content. Negative or non-finite components returned by an override are treated as 0.

User code should normally call Electron2D.Control.GetMinimumSize or Electron2D.Control.GetCombinedMinimumSize instead of calling this method directly.

Returns

The minimum size requested by this control implementation.

Thread Safety

This method is not synchronized. It is called on the main scene thread during layout calculations.

Since

This method is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Control.CustomMinimumSize
• Electron2D.Control.GetMinimumSize

_GuiInput(Electron2D.InputEvent)

Kind: Method

public System.Void _GuiInput(Electron2D.InputEvent)(Electron2D.InputEvent inputEvent)

Summary

Called when a GUI input event is delivered to this control.

Remarks

Mouse events reach this method when the event position falls inside the control rectangle and Electron2D.Control.MouseFilter is not Electron2D.MouseFilter.Ignore. Non-mouse events reach only the currently focused control.

Call Electron2D.Control.AcceptEvent to stop further propagation of the current event.

Parameters

• inputEvent: The input event delivered by the containing Electron2D.Viewport.

Thread Safety

This method is not synchronized. It is called on the main scene thread during input dispatch.

Since

This method is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Control.AcceptEvent
• Electron2D.Control.FocusMode
• Electron2D.Control.MouseFilter