Version: 2023.2
言語: 日本語
USS built-in variable references
USS のベストプラクティス

C# スクリプトでスタイルを適用する

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

C# スクリプトでは、ビジュアル要素の style プロパティに直接スタイルを設定することができます。例えば、以下のコードはボタンの背景色を赤に設定します。

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# scripts.

ビジュアル要素にスタイルシートを追加するには、以下を行います。

  1. Load StyleSheet objects with standard Unity APIs, such as AssetDatabase.Load() or Resources.Load().
  2. ビジュアル要素のstyleSheets プロパティを使用して StyleSheet オブジェクトを加えます。

例えば、ローカル変数 styleSheet にスタイルシートがあり、ローカル変数 element に要素があるとします。以下の例では要素にスタイルシートを加えます。

element.styleSheets.Add(styleSheet);

ノート: スタイル規則はビジュアル要素とそのすべての子孫に適用されますが、要素の親や兄弟には適用されません。USS ファイルを変更すると、このスタイルシートを使用する UI が自動的に更新されます。

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;

その他の参考資料

USS built-in variable references
USS のベストプラクティス