You can use UQuery to find elements from a visual treeAn object graph, made of lightweight nodes, that holds all the elements in a window or panel. It defines every UI you build with the UI Toolkit.
See in Glossary. UQuery was inspired by JQuery and Linq, and is designed to limit dynamic memory allocation. This allows for optimal performance on mobile platforms.
You can use UQuery through the following extension methods:
Internally, the Q
and Query
methods use UQueryBuilder
to construct a query. These extension methods reduce the verbosity of creating a UQueryBuilder
.
To use UQuery to find elements, you must load and instantiate the UXML first, and then use Query
or Q
to construct selection rules on a root visual elementA node of a visual tree that instantiates or derives from the C# VisualElement
class. You can style the look, define the behaviour, and display it on screen as part of the UI. More info
See in Glossary.
Query
returns a list of elements that match the selection rules. You can filter the return results of Query
with the public methods of UQueryBuilder
, such as First, Last, AtIndex, Children, and Where.
Q
is the shorthand for Query<T>.First()
. It returns the first element that matches the selection rules.
You can query elements by their name, their USS class, or their element type (C# type). You can also query with a predicate or make complex hierarchical queries.
The following sections use this example UXML to demonstrate how to find elements:
<UXML xmlns="UnityEngine.UIElements"> <VisualElement name="container1"> <Button name="OK" text="OK" /> <Button name="Cancel" text="Cancel" /> </VisualElement> <VisualElement name="container2"> <Button name="OK" class="yellow" text="OK" /> <Button name="Cancel" text="Cancel" /> </VisualElement> <VisualElement name="container3"> <Button name="OK" class="yellow" text="OK" /> <Button name="Cancel" class="yellow" text="Cancel" /> </VisualElement> </UXML>
To find elements by their name, use Query(name: "element-name")
or Q(name: "element-name")
. You can omit the name
as it’s the first argument. For example:
The following example finds a list of elements named “OK”:
List<VisualElement> result = root.Query("OK").ToList();
The following example uses Query
to find the first element named “OK”:
VisualElement result = root.Query("OK").First(); //or VisualElement result = root.Q("OK");
The following example uses Q
to find the first element named “OK”:
VisualElement result = root.Q("OK");
The following example finds the second element named “OK”:
VisualElement result3 = root.Query("OK").AtIndex(1);
The following example finds the last element named “OK”:
VisualElement result4 = root.Query("OK").Last();
To find elements by a USS class, use Query(className: "class-name")
or Q(className: "class-name")
.
The following example finds all the elements that have the class “yellow” and assigns them to a list:
List<VisualElement> result = root.Query(className: "yellow").ToList();
The following example finds the first element that has the class “yellow”:
VisualElement result = root.Q(className: "yellow");
To find elements by their element type(C# type), use Query<Type>
or Q<Type>
.
The following example finds the first button and adds a tooltip for it:
VisualElement result = root.Q<Button>(); result.tooltip = "This is a tooltip!";
The following example finds the third button:
VisualElement result = root.Query<Button>().AtIndex(2);
Note: You can only query by the actual type of the element, not base classes.
Other than to query elements by name, class, and type, you can also use the Where
method to select all elements that satisfy a predicate. The predicate must be a function callback that takes a single VisualElement
argument.
The following example finds all the elements with the “yellow” USS class that have no tooltips:
List<VisualElement> result = root.Query(className: "yellow").Where(elem => elem.tooltip == "").ToList();
You can combine name, class, and type to make complex hierarchical queries.
The following example finds the first button named “OK” that has a class of “yellow”:
VisualElement result = root.Query<Button>(className: "yellow", name: "OK").First();
The following example finds the child cancel button of the “container2”:
VisualElement result = root.Query<VisualElement>("container2").Children<Button>("Cancel").First();
You can use the ForEach method to operate directly on the query results.
The following example adds a tooltip for any elements that have no tooltips:
root.Query().Where(elem => elem.tooltip == "").ForEach(elem => elem.tooltip="This is a tooltip!");
Consider the following when you use UQuery:
QueryState
struct (returned by the element.Query()
method) and enumerate it to avoid creating lists. You can also construct a query once and execute it on different elements.VisualElement
variables inside closures.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.
When you visit any website, it may store or retrieve information on your browser, mostly in the form of cookies. This information might be about you, your preferences or your device and is mostly used to make the site work as you expect it to. The information does not usually directly identify you, but it can give you a more personalized web experience. Because we respect your right to privacy, you can choose not to allow some types of cookies. Click on the different category headings to find out more and change our default settings. However, blocking some types of cookies may impact your experience of the site and the services we are able to offer.
More information
These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.
These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site. All information these cookies collect is aggregated and therefore anonymous. If you do not allow these cookies we will not know when you have visited our site, and will not be able to monitor its performance.
These cookies may be set through our site by our advertising partners. They may be used by those companies to build a profile of your interests and show you relevant adverts on other sites. They do not store directly personal information, but are based on uniquely identifying your browser and internet device. If you do not allow these cookies, you will experience less targeted advertising. Some 3rd party video providers do not allow video views without targeting cookies. If you are experiencing difficulty viewing a video, you will need to set your cookie preferences for targeting to yes if you wish to view videos from these providers. Unity does not control this.
These cookies are necessary for the website to function and cannot be switched off in our systems. They are usually only set in response to actions made by you which amount to a request for services, such as setting your privacy preferences, logging in or filling in forms. You can set your browser to block or alert you about these cookies, but some parts of the site will not then work. These cookies do not store any personally identifiable information.