UXML 要素 TextField

TextField は、ユーザーがアプリケーションにテキストデータを入力できるようにするものです。テキストの入力を受け付け、表示します。プレースホルダーテキストを設定して、ユーザーに入力のヒントや指示を与えることができます。また、入力されたデータが特定の要件を満たしていることを確認するための検証機能を追加することも可能です。

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

TextField の作成

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

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

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

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

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

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

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

また、--unity-selection-color USS カスタムプロパティを使用して、選択したテキストにスタイルを設定することもできます。例えば、以下の USS は、選択した入力テキストの色を黄色に設定します。

.unity-base-text-field__input {
    --unity-selection-color: yellow;
}

縦スクロールバーの有効化

TextField で multiline (複数行テキスト入力を可能にするプロパティ) を有効にすると、テキスト入力フィールドに縦スクロールバーを表示できます。

C# では、verticalScrollerVisibility プロパティを ScrollerVisibility.Auto か ScrollerVisibility.AlwaysVisible に設定してください (以下参照)。

// Set the multiline property to true to enable multiple lines of text
textField.multiline = true;

// Set the vertical scrollbar visibility to AlwaysVisible
textField.verticalScrollerVisibility = ScrollerVisibility.AlwaysVisible;

入力テキストの動作の制御

イベント を使用して、入力テキストの動作を制御できます。

例えば、TextField の Enter および Shift + Tab キーボードイベントのデフォルト動作をオーバーライドするには、それらが TextElement 基本クラスで処理される前に KeyDownEvent を TrickleDown フェーズに登録します。

myField.RegisterCallback<KeyDownEvent>((evt) => { 

    if (evt.keyCode == KeyCode.Enter || evt.character == '/n')
    {
        // Submit logic
        evt.StopPropagation();
        evt.PreventDefault();
    }

    if (evt.modifiers == EventModifiers.Shift && (evt.keyCode == KeyCode.Tab || evt.character == '/t'))
    {
        // Focus logic
        evt.StopPropagation();
        evt.PreventDefault();
    }

}, TrickleDown.TrickleDown);

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

C# クラス: TextField
名前空間: UnityEngine.UIElements
基本クラス: TextInputBaseField_1

メンバー UXML 属性

この要素は以下のメンバー属性を持ちます。

継承された UXML 属性

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

この要素は、VisualElement から以下の属性も継承します。

USS クラス

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

USS カスタムプロパティ

以下の表は、USS の TextField 要素にのみ利用可能なカスタムプロパティの説明です。

その他の参考資料

• テキストを扱う
• UXML 要素 Label
• UXML 要素 DoubleField
• UXML 要素 LongField
• UXML 要素 FloatField
• UXML 要素 IntegerField
• UXML 要素 PropertyField