UQueryBuilder<T0>

Description

Utility Object that constructs a set of selection rules to be run on a root visual element.

A generic class that allows you to build queries for UI elements of type T. You can refine queries using selectors like name, class, and other conditions. It enables you to search for elements and execute the query on any VisualElement, making it easier to navigate and filter the VisualElement tree in large UIs, by type, name, class, and hierarchy conditions.

For more information, refer to the UQuery manual page.

The following example demonstrates how to use UQueryBuilder to find certain elements in a UI hierarchy and iterate over them:

using UnityEngine;
using UnityEngine.UIElements;

public class UQueryBuilderExample : MonoBehaviour
{
    public UIDocument uiDocument;

    private void OnEnable()
    {
        // Get the root visual element
        var root = uiDocument.rootVisualElement;

        // Example query: Find all buttons with a specific class name
        var buttonQuery = new UQueryBuilder<Button>(root)
            .Class("my-button-class")
            .Build();

        // Iterate over those buttons and add click handlers
        buttonQuery.ForEach(button => button.clicked += () => OnButtonClick(button));

        // Another query: Find all labels that are descendants of elements with the class "container"
        var labelQuery = new UQueryBuilder<Label>(root)
            .Descendents<VisualElement>("container")
            .Build();

        // Change the text color of each label found
        labelQuery.ForEach(label => label.style.color = Color.green);
    }

    private void OnButtonClick(Button button)
    {
        Debug.Log($"Button with name {button.name} clicked.");
    }
}

Constructors

Public Methods