Button 要素を使用して、UI にクリック可能なボタンを作成します。例えば、ユーザーが Button 要素をクリックまたはタップすると、新しいウィンドウを開いたり、フォームを送信したり、サウンドエフェクトを再生したりといったアクションやイベントを発生させます。
You can create a Button with UI Builder, UXML, or C#. The following C# example creates a Button with a label:
var button = new Button(() => { Debug.Log("Button clicked"); }) { text = "Click me" };
Button の text や background-image プロパティを使って、ユーザーに追加情報を提供することができます。また、ボタンの階層に Label や Image などのサブ要素を追加し、それらの要素の外観や動作をより細かく制御したい場合は、ユーザーに追加情報を提供することができます。
一般的には、以下のような場合にサブ要素を使用します。
プロパティを以下の目的で使用します。
The following UXML example creates a Button:
[!code-xml[(External/Resources/editor_resources/Assets/Editor Default Resources/UIPackageResources/Snippets/UXML/ButtonSnippet.uxml)]
The following C# example illustrates some of the customizable functionalities of the Button:
[!code-cs[(Modules/UIElementsSamplesEditor/Snippets/ButtonSnippet.cs#sample)]
To try this example live in Unity, go to Window > UI Toolkit > Samples.
C#クラス: ボタン
名前空間: UnityEngine.UIElements
基本クラス: TextElement
この要素は基本クラスから以下の属性を継承します。
| 名前 | 型 | 説明 |
|---|---|---|
binding-path |
string |
バインドされるべきターゲットプロパティのパス。 |
display-tooltip-when-elided |
boolean |
true の場合、ツールチップは省略されたテキストの完全なバージョンを表示し、以前にツールチップが提供されていた場合は、それをオーバーライドします。 |
enable-rich-text |
boolean |
false の場合、リッチテキストタグは解析されません。 |
focusable |
boolean |
要素がフォーカス可能である場合は true。 |
parse-escape-sequences |
boolean |
Specifies whether escape sequences are displayed as is or if they are replaced by the character they represent. |
tabindex |
int |
フォーカスリング内でフォーカス可能なものをソートするために使用される整数。0 以上であることが必要です。 |
text |
string |
The text to be displayed. Changing this value will implicitly invoke the INotifyValueChanged_1.value setter, which will raise a ChangeEvent_1 of type string. |
この要素は、VisualElement から以下の属性も継承します。
| 名前 | 型 | 説明 |
|---|---|---|
content-container |
string |
子要素はそれに追加されますが、通常は要素自体と同じです。 |
name |
string |
この VisualElement の名前。 このプロパティを使用して、特定の要素を対象とする USS セレクターを記述します。要素には一意の名前を付けるのが標準的です。 |
picking-mode |
UIElements.PickingMode |
mouseEvents または IPanel.Pick クエリの間にこの要素を選択 (ピック) できるかどうかを決定します。 |
style |
string |
この要素のスタイルオブジェクトへの参照。 C# でこのオブジェクトに書き込まれた USS ファイルまたはインラインスタイルから計算されたデータが含まれます。 |
toolbar |
string |
ユーザーが要素をマウスオーバーした後、わずかな時間、情報ボックス内に表示するテキスト。これはエディター UI でのみサポートされます。 |
usage-hints |
UIElements.UsageHints |
VisualElement の高レベルの使用パターンを指定するヒント値の組み合わせ。このプロパティは、VisualElement がまだ Panel の一部でない場合にのみ設定できます。Panel の一部になると、このプロパティは事実上読み取り専用となり、変更しようとすると例外がスローされます。適切な UsageHints を指定することで、予想される使用パターンに基づいて、特定の操作をどのように処理するか、または高速化するかについて、システムがより適切な判断を下すようになります。これらのヒントは動作や視覚的な結果には影響しませんが、パネルとその中の要素の全体的なパフォーマンスにのみ影響することに注意してください。常に適切なUsageHints を指定することを考慮することをお勧めしますが、特定の条件下 (例えば、ターゲットプラットフォームのハードウェア制限など) では、いくつかの UsageHints が内部的に無視される可能性があることに留意してください。 |
view-data-key |
string |
ビューデータの永続性 (ツリーの展開状態、スクロール位置、ズームレベルなど) に使用されます。 これは、ビューデータストアからビューデータを保存/ロードするために使用されるキーです。このキーを設定しないと、この VisualElement の永続性が無効になります。 |
以下の表は、すべての C# パブリックプロパティ名と、それに関連する USS セレクターのリストです。
| C# プロパティ | USS セレクター | 説明 |
|---|---|---|
ussClassName |
.unity-button |
この型の要素の USS クラス名。 Unity はこの USS クラスを Button 要素の全てのインスタンスに加えます。このクラスに適用されるスタイルは、ビジュアルツリーでスタイルシートの横または下に位置するすべてのボタンに影響します。 |
ussClassName |
.unity-text-element |
この型の要素の USS クラス名。 |
disabledUssClassName |
.unity-disabled |
ローカルで無効にされた要素の USS クラス名。 |
また、Inspector や UI Toolkit Debugger の Matching Selectors セクション を使用して、どの USS セレクターが VisualElementのコンポーネントに影響するかを、階層のすべてのレベルで確認することもできます。