struct 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.
CloseUtility 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."); } }
UQueryBuilder_1 | Initializes a QueryBuilder. |
Active | Selects all elements that are active. |
AtIndex | Convenience overload, shorthand for Build().AtIndex(). |
Build | Compiles the selection rules into a QueryState object. |
Checked | Selects all elements that are checked. |
Children | Selects all direct child elements of elements matching the previous rules. |
Class | Selects all elements with the specified class in the class list, as specified with the class attribute in a UXML file or added with VisualElement.AddToClassList method. |
Descendents | Selects all elements that are descendants of currently matching ancestors. |
Enabled | Selects all elements that are enabled. |
First | Convenience overload, shorthand for Build().First(). |
Focused | Selects all elements that are focused. |
ForEach | Convenience overload, shorthand for Build().ForEach(). |
Hovered | Selects all elements that are hovered. |
Last | Convenience overload, shorthand for Build().Last(). |
Name | Selects element with this name. |
NotActive | Selects all elements that are not active. |
NotChecked | Selects all elements that not checked. |
NotEnabled | Selects all elements that are not enabled. |
NotFocused | Selects all elements that don't currently own the focus. |
NotHovered | Selects all elements that are not hovered. |
NotVisible | Selects all elements that are not visible. |
OfType | Selects all elements of the specified Type (eg: Label, Button, ScrollView, etc). |
ToList | Convenience method. shorthand for Build().ToList. |
Visible | Selects all elements that are visible. |
Where | Selects all elements satifying the predicate. |
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.