Version: 2022.2
言語: 日本語
UXML 要素 InspectorElement
UXML 要素 Label

UXML 要素 IntegerField

IntegerFieldは、ユーザーがアプリケーションに整数の数値を入力できるようにします。テキスト入力を受け付け、表示します。プレースホルダーテキストを設定して、ユーザーに入力のヒントや指示を提供することができます。また、バリデーション関数を加えて、入力されたデータが特定の要件を満たしていることを確認することもできます。

IntegerField を Inspector ウィンドウの他のフィールドと揃えるには、.unity-base-field__aligned USS クラスを適用するだけです。詳細については BaseField を参照してください。

IntegerField の作成

IntegerField は UI Builder、UXML、C# で作成できます。

C# で IntegerField を作成するには、以下のように、IntegerField オブジェクトの新しいインスタンスを作成します。

IntegerField myElement = new IntegerField("Label text");

入力テキスト選択のカスタマイズ

入力テキストはデフォルトで選択可能です。selectAllOnMouseUPselectAllOnFocus など、選択時の動作はカスタム化可能です。

C#では textSelection を通じて設定します。

myElement.textSelection.selectAllOnMouseUp = false;
myElement.textSelection.selectAllOnFocus = false;

C# の基本クラスと名前空間

C#クラス: IntegerField
名前空間: UnityEngine.UIElements
基本クラス: TextValueField_1

継承された UXML 属性

この要素は基本クラスから以下の属性を継承します。

名前 説明
binding-path string バインドされるべきターゲットプロパティのパス。
focusable boolean 要素がフォーカス可能である場合は true。
is-delayed boolean true に設定すると、ユーザーが Enter キーを押すか、テキストフィールドのフォーカスが失われるまで、value プロパティは更新されません。
label string フィールドの横に表示されるラベルを表す文字列。
tabindex int フォーカスリング内でフォーカス可能なものをソートするために使用される整数。0 以上であることが必要です。
value int これは、フィールドの値です。

この要素は、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 の永続性が無効になります。

USS クラス

以下の表は、すべての C# パブリックプロパティ名と、それに関連する USS セレクターのリストです。

C# プロパティ USS セレクター 説明
ussClassName .unity-integer-field この型の要素の USS クラス名。
labelUssClassName .unity-integer-field__label この型の要素のラベルの USS クラス名。
inputUssClassName .unity-integer-field__input この型の要素の入力要素の USS クラス名。
ussClassName .unity-base-text-field この型の要素の USS クラス名。
labelUssClassName .unity-base-text-field__label この型の要素のラベルの USS クラス名。
inputUssClassName .unity-base-text-field__input この型の要素の入力要素の USS クラス名。
singleLineInputUssClassName .unity-base-text-field__input--single-line このタイプの要素の 1 行入力要素の USS クラス名。
multilineInputUssClassName .unity-base-text-field__input--multiline このタイプの要素の複数行入力要素の USS クラス名。
ussClassName .unity-base-field この型の要素の USS クラス名。
labelUssClassName .unity-base-field__label この型の要素のラベルの USS クラス名。
inputUssClassName .unity-base-field__input この型の要素の入力要素の USS クラス名。
noLabelVariantUssClassName .unity-base-field--no-label ラベルがない場合の、この型の要素の USS クラス名。
labelDraggerVariantUssClassName .unity-base-field__label--with-dragger この型の要素にドラッガーがアタッチされている場合のラベルの USS クラス名。
mixedValueLabelUssClassName .unity-base-field__label--mixed-value 混合値を示す要素の USS クラス名
alignedFieldUssClassName .unity-base-field__aligned インスペクター要素で整列される要素の USS クラス名
disabledUssClassName .unity-disabled ローカルで無効にされた要素の USS クラス名。

また、Inspector や UI Toolkit Debugger の Matching Selectors セクション を使用して、どの USS セレクターが VisualElementのコンポーネントに影響するかを、階層のすべてのレベルで確認することもできます。

その他の参考資料

UXML 要素 InspectorElement
UXML 要素 Label