class in UnityEngine.UIElements
/
Implemented in:UnityEngine.UIElementsModule
Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.
CloseFor some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.
CloseDeclares a custom control.
To create a custom control, you must add the UxmlElement attribute to the custom control class definition.
You must declare the custom control class as a partial class and inherit it from VisualElement
or one of its derived classes.
When an element is marked with the UxmlElement attribute, a corresponding UxmlSerializedData
class is generated in the partial class.
This data class contains a SerializeField for each field or property that was marked with the
UxmlAttributeAttribute attribute.
This serialized data allows for the element to be serialized from UXML and supports editing in the Attributes field of the
Inspector window in the UI Builder.
By default, the custom control appears in the Library tab in UI Builder.
To hide it from the Library tab, provide the HideInInspector attribute.
For an example of migrating a custom control from UxmlFactory
and UxmlTraits
to the UxmlElement
and UxmlAttributes
system,
refer to Enhanced custom controls creation with UXML.
The following example creates a custom control with multiple attributes:
using System; using System.Collections.Generic; using UnityEngine; using UnityEngine.UIElements;
[UxmlElement] public partial class ExampleVisualElement : VisualElement { [UxmlAttribute] public string myStringValue { get; set; }
[UxmlAttribute] public int myIntValue { get; set; }
[UxmlAttribute] public float myFloatValue { get; set; }
[UxmlAttribute] public List<int> myListOfInts { get; set; }
[UxmlAttribute, UxmlTypeReference(typeof(VisualElement))] public Type myType { get; set; }
[UxmlAttribute] public Texture2D myTexture { get; set; }
[UxmlAttribute] public Color myColor { get; set; } }
The following UXML document uses the custom control:
<ui:UXML xmlns:ui="UnityEngine.UIElements"> <ExampleElement my-string-value="Hello World" my-int-value="123" /> <ExampleElement my-float-value="3.14" my-list-of-ints="1,2,3" /> <ExampleElement my-string-value="Hello World" my-int-value="123" /> <ExampleElement my-texture="project://database/Assets/MyTexture.png" /> <ExampleElement my-color="#FF0000FF" /> <ExampleElement my-type="UnityEngine.UIElements.Button, UnityEngine.UIElementsModule" /> </ui:UXML>
When you create a custom control, the default name used in UXML and UI Builder is the element type name (C# class name).
However, you can customize the name to make it easier to refer to the element.
Note: You are still required to reference the classes' namespace in UXML.
To create a custom name for an element, provide a value to the name
property.
For example, if you create the following custom button:
using UnityEngine.UIElements;
namespace MyNamespace { [UxmlElement("MyButton")] public partial class CustomButtonElement : Button { } }
You can then reference the custom button in UXML with the custom name or its type:
<ui:UXML xmlns:ui="UnityEngine.UIElements"> <MyNamespace.MyButton /> <MyNamespace.CustomButtonElement /> </ui:UXML>
name | Provides a custom name for an element. |
UxmlElementAttribute | Exposes a type of VisualElement to UXML and UI Builder |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.