You can write to style
to set style values to an element. However, to get the actually rendered styles of an element, read from resolvedStyle
.
In a C# script, you can set styles directly to the style
properties of a 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. For example, the following code sets the background color of a button to red:
button.style.backgroundColor = Color.red
You can also add a Unity style sheet (USS) to any visual element. Unity represents USS files as StyleSheet
objects in C# scriptsA piece of code that allows you to create your own Components, trigger game events, modify Component properties over time and respond to user input in any way you like. More info
See in Glossary.
To add style sheets to a visual element:
StyleSheet
objects with standard Unity APIs, such as AssetDatabase.Load()
or Resources.Load()
.styleSheets
property of a visual element to add the StyleSheet
object.For example, given a style sheet in the local variable styleSheet
and an element in the local variable element
, the following example adds the style sheet to the element:
element.styleSheets.Add(styleSheet);
Note: Style rules apply to the visual element and all its descendants, but don’t apply to the parent or siblings of the element. Any change to the USS file automatically refreshes the UI(User Interface) Allows a user to interact with your application. Unity currently supports three UI systems. More info
See in Glossary that uses this style sheet.
Style values on an element are computed from various sources, including multiple applied classes, inheritance from ancestors, and inline styles from UXML or C# code. These values might change from frame to frame. The style
only holds the inline styles for the element and doesn’t reflect other sources. The resolvedStyle
has the final calculated values, considering all sources on the current frame.
For example, when you use the inline style to set the height for an element, both the style
and resolvedStyle
start with the same value. When the element is added to the hierarchy, resolvedStyle.height
can be NaN
until the layout updates. If you define the height in a class as a percentage, the computed width relies on parent properties such as border-height
and padding
. Although style.height
might give a relative value, such as for transitions that can change the value, resolvedStyle.height
gives the actual rendered height.
To get the resolved style when the geometry changes, you can use the GeometryChangedEvent
event. This event is triggered when the layout of a VisualElement changes, which includes changes in size and position. You can register a callback for this event and in the callback, you can access the resolvedStyle property of the VisualElement to get the final computed styles.
The following example creates a custom Editor window and logs the resolved height of an element. The height of the element changes if you resize the window:
using UnityEditor; using UnityEngine; using UnityEngine.UIElements; public class ResolvedStyles : EditorWindow { [MenuItem("Window/UI Toolkit/ResolvedStyles")] public static void ShowExample() { GetWindow<ResolvedStyles>(); } private void OnEnable() { titleContent = new GUIContent("Resolved Styles"); } public void CreateGUI() { VisualElement root = rootVisualElement; // Element that is tracked. // When you resize the Editor window, the inner content is not necessarily updated // during the drag operation. The resolved height field is updated whenever the drag // operation is complete. var element = new VisualElement { style = { flexGrow = 1, backgroundColor = Color.red } }; root.Add(element); // Register a callback for the GeometryChangedEvent element.RegisterCallback<GeometryChangedEvent>(OnGeometryChanged); } // Callback for the GeometryChangedEvent public void OnGeometryChanged(GeometryChangedEvent evt) { // Get the VisualElement that triggered the event VisualElement element = evt.target as VisualElement; // Get the resolved style of the VisualElement float height = element.resolvedStyle.height; // Log the resolved of the VisualElement Debug.Log("Resolved height: " + height); } }
If the element’s geometry doesn’t change, you can add a scheduler to periodically check the resolved style of the element:
element.schedule.Execute(() => { Debug.Log(element.resolvedStyle.height); }).Every(100);
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.