Version: 2023.2
Language : English
USS built-in variable references
Best practices for USS

Apply styles in C# scripts

You can write to style to set style values to an element. However, to get the final computed styles of an element, read from resolvedStyle.

Set styles

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: =

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:

  1. Load StyleSheet objects with standard Unity APIs, such as AssetDatabase.Load() or Resources.Load().
  2. Use the 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:


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.

Get resolved styles

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 does not 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 width for an element, both the style and resolvedStyle start with the same value. When the element is added to the hierarchy, resolvedStyle.width could be NaN until the layout updates. If you define the width in a class as a percentage, the computed width relies on parent properties such as border-width and padding. Although style.width might give a relative value, such as for transitions that can change value, resolvedStyle.width gives the actual rendered width.

The following example shows how to get the final computed width of an element:

float width = element.resolvedStyle.width;

Additional resources

USS built-in variable references
Best practices for USS