Class ControlReference<T>

UI Control reference utility. References UI Control actor with a typed control type.

System.Object
ControlReference<T>
System.IComparable
System.IComparable<ControlReference<T>>
System.IEquatable<ControlReference<T>>
Namespace: FlaxEngine
Assembly: FlaxEngine.CSharp.dll
Syntax
public sealed class ControlReference<T> : ValueType, IControlReference, IComparable, IComparable<ControlReference<T>>, IEquatable<ControlReference<T>> where T : Control
Type Parameters
T

Type of the UI control object.

Properties

ControlType

Gets the type of the control the interface uses.

Declaration
public Type ControlType { get; }
Property Value
System.Type

Implements

UIControl

Gets or sets the reference to UIControl actor.

Declaration
public UIControl UIControl { get; set; }
Property Value
UIControl

Implements

Methods

CompareTo(ControlReference<T>)

Declaration
public int CompareTo(ControlReference<T> other)
Parameters
ControlReference<T> other

Returns
System.Int32

CompareTo(Object)

Declaration
public int CompareTo(object obj)
Parameters
System.Object obj

Returns
System.Int32

Equals(ControlReference<T>)

Declaration
public bool Equals(ControlReference<T> other)
Parameters
ControlReference<T> other

Returns
System.Boolean

Equals(Object)

Declaration
public override bool Equals(object obj)
Parameters
System.Object obj

Returns
System.Boolean

GetHashCode()

Declaration
public override int GetHashCode()
Returns
System.Int32

Load(UIControl)

Declaration
public void Load(UIControl value)
Parameters
UIControl value

ToString()

Declaration
public override string ToString()
Returns
System.String

Operators

Equality(ControlReference<T>, ControlReference<T>)

Checks whether the two objects are equal.

Declaration
public static bool operator ==(ControlReference<T> left, ControlReference<T> right)
Parameters
ControlReference<T> left

ControlReference<T> right

Returns
System.Boolean

Implicit(ControlReference<T> to T)

The implicit operator for the Control.

Declaration
public static implicit operator T(ControlReference<T> reference)
Parameters
ControlReference<T> reference

The control reference.
Returns
T

The control object.

Implicit(ControlReference<T> to UIControl)

The implicit operator for the UIControl.

Declaration
public static implicit operator UIControl(ControlReference<T> reference)
Parameters
ControlReference<T> reference

The control reference.
Returns
UIControl

The control actor.

Implicit(ControlReference<T> to Boolean)

Checks if the object exists (reference is not null and the unmanaged object pointer is valid).

Declaration
public static implicit operator bool (ControlReference<T> obj)
Parameters
ControlReference<T> obj

The object to check.
Returns
System.Boolean

True if object is valid, otherwise false.

Inequality(ControlReference<T>, ControlReference<T>)

Checks whether the two objects are not equal.

Declaration
public static bool operator !=(ControlReference<T> left, ControlReference<T> right)
Parameters
ControlReference<T> left

ControlReference<T> right

Returns
System.Boolean

Extension Methods