UIDocument

Description

Defines a Component that connects VisualElements to GameObjects.

This makes it possible to render UI defined in UXML documents in the Game view.

The following example shows how to query a UIDocument component and interact with its elements.

using UnityEngine;
using UnityEngine.UIElements;

public class UIDocument_Example : MonoBehaviour
{
    // Configured via the inspector
    public UIDocument document;

    void OnEnable()
    {
        // Expects a button with the name "my-button" to be present in the UXML.
        // If it doesn't exist, create it.
        var button = document.rootVisualElement.Q<Button>("my-button");
        if (button == null)
        {
            button = new Button { name = "my-button", text = "Click me!" };
            document.rootVisualElement.Add(button);
        }

        button.clicked += ButtonClicked;
    }

    void ButtonClicked()
    {
        var label = document.rootVisualElement.Q<Label>("my-label");

        // Add a label if it doesn't exist
        if (label == null)
        {
            label = new Label { name = "my-label", text = "Button clicked!" };
            document.rootVisualElement.Add(label);
        }
        else
        {
            label.text = "Button clicked!";
        }
    }
}

Properties

Inherited Members