UXML element RectField

The RectField lets users enter a Rect value in a UI(User Interface) Allows a user to interact with your application. Unity currently supports three UI systems. More info
See in Glossary.

Note: To align an element with other fields in an InspectorA Unity window that displays information about the currently selected GameObject, asset or project settings, allowing you to inspect and edit the values. More info
See in Glossary window, simply apply the .unity-base-field__aligned USS class to it. For more information, refer to BaseField.

Create a RectField

You can create a RectField with UI Builder, UXML, or C#. The following C# example creates a RectField with a Rect value:

var rectField = new RectField();
rectField.value = new Rect(0, 0, 100, 100);

Example

The following UXML example creates a RectField:

<UXML xmlns="UnityEngine.UIElements" xmlns:uie="UnityEditor.UIElements">
    <RectField label="UXML Field" name="the-uxml-field" />
</UXML>

The following C# example illustrates some of the customizable functionalities of the RectField:

/// <sample>
// Get a reference to the field from UXML and assign a value to it.
var uxmlField = container.Q<RectField>("the-uxml-field");
uxmlField.value = new Rect(0.0f, 5.5f, 10.1f, 20.3f);

// Create a new field, disable it, and give it a style class.
var csharpField = new RectField("C# Field");
csharpField.SetEnabled(false);
csharpField.AddToClassList("some-styled-field");
csharpField.value = uxmlField.value;
container.Add(csharpField);

// Mirror the value of the UXML field into the C# field.
uxmlField.RegisterCallback<ChangeEvent<Rect>>((evt) =>
{
    csharpField.value = evt.newValue;
});
/// </sample>

To try this example live in Unity, go to Window > UI Toolkit > Samples.

C# class and namespace

C# class: RectField
Namespace: UnityEngine.UIElements
Base class: BaseCompositeField_3

Inherited UXML attributes

This element inherits the following attributes from its base class:

This element also inherits the following attributes from VisualElement:

USS classes

The following table lists all the C# public property names and their related USS selector.

You can also use the Matching Selectors section in the Inspector or the UI Toolkit Debugger to see which USS selectors affect the components of the VisualElement at every level of its hierarchy.

Additional resources

• UXML element RectIntField