ToolbarPopupSearchField
ToolbarPopupSearchField は、ポップアップメニュー付きの検索フィールドとして機能する、エディター専用のコントロールで、ToolbarMenu と ToolbarSearchField の組み合わせです。ドロップダウンメニューにロジックを追加して、検索結果にフィルターをかけることができます。メニューをポップアップさせるには、虫眼鏡アイコンにカーソルを合わせます。
ToolbarPopupSearchField の作成
ToolbarPopupSearchField は、UI Builder、UXML、または C# で作成できます。以下の C# の例では、メニュー、プレースホルダーテキスト、および値が変更されたコールバックのある ToolbarPopupSearchField を作成します。
using UnityEditor.UIElements;
...
var toolbarPopupSearchField = new ToolbarPopupSearchField();
toolbarPopupSearchField.value = "Search me";
toolbarPopupSearchField.menu.AppendAction("Action 1", action => Debug.Log("Action 1"));
toolbarPopupSearchField.menu.AppendAction("Action 2", action => Debug.Log("Action 2"));
toolbarPopupSearchField.RegisterValueChangedCallback(evt => Debug.Log("New search value: " + evt.newValue));
C# の基本クラスと名前空間
C# クラス: ToolbarPopupSearchField
名前空間: UnityEditor.UIElements
基本クラス: ToolbarSearchField
継承された UXML 属性
この要素は基本クラスから以下の属性を継承します。
| 名前 | 型 | 説明 |
|---|---|---|
focusable |
boolean |
要素がフォーカス可能である場合は true。 |
placeholder-text |
string |
ユーザーがフィールドに何を入力するかを理解するための短いヒント。 |
tabindex |
int |
フォーカスリング内のフォーカス可能な要素をソートするために使用される整数。0 以上の値に設定する必要があります。 |
この要素は VisualElement から以下の属性も継承します。
| 名前 | 型 | 説明 |
|---|---|---|
content-container |
string |
子要素が追加されますが、通常は子要素は要素自体と同じです。 |
data-source |
Object |
継承されたデータソースをオーバーライドするこの VisualElement にデータソースを割り当てます。このデータソースはすべての子に継承されます。 |
data-source-path |
string |
データソースから値へのパス。 |
data-source-type |
System.Type |
この VisualElement に割り当て可能なデータソースの型。 この情報は、設計時に有効なデータソースを指定できない場合に、データソースパスフィールドを補完するヒントとして UI Builder でのみ使用されます。 |
language-direction |
UIElements.LanguageDirection |
要素のテキストの向きを示します。値は要素の子に伝播されます。 languageDirection を RTL に設定すると、テキストの反転と改行/折り返しの適切な処理による、右から左へ (RTL) の基本サポートが追加されます。ただし、包括的な RTL サポートは提供されません。これには、文字の並べ替えを含むテキストシェーピングと OpenType フォント機能のサポートが必要になるためです。将来のアップデートでは、言語、スクリプト、フォント機能の仕様を処理するための追加の API を含む、包括的な RTL サポートが予定されています。 このプロパティの RTL 機能を拡張するには、Unity Asset Store で入手可能なサードパーティ製のプラグインを探し、 ITextElementExperimentalFeatures.renderedText を利用してください。 |
name |
string |
この VisualElement の名前。 このプロパティを使用して、特定の要素を対象とする USS セレクターを記述します。要素には一意の名前を付けるのが標準的です。 |
picking-mode |
UIElements.PickingMode |
mouseEvent または IPanel.Pick クエリの間にこの要素を選択 (ピック) できるかどうかを決定します。 |
style |
string |
VisualElement スタイルの値を設定します。 |
tooltip |
string |
ユーザーが要素をマウスオーバーした後、わずかな時間、情報ボックス内に表示するテキスト。これはエディター UI でのみサポートされます。 |
usage-hints |
UIElements.UsageHints |
VisualElement の意図されている使用パターンの概要を指定するヒント値の組み合わせ。このプロパティは、VisualElement がまだ Panel の一部でない場合にのみ設定できます。Panel の一部になると、このプロパティは事実上読み取り専用となり、変更しようとすると例外がスローされます。適切な UsageHints を指定することで、予想される使用パターンに基づいて、特定の操作をどのように処理するか、または高速化するかについて、システムがより適切な判断を下すようになります。これらのヒントは動作や視覚的な結果には影響せず、パネルとその中の要素の全体的なパフォーマンスにのみ影響することに注意してください。常に適切な UsageHints を指定することを考慮するようお勧めしますが、特定の条件下 (例: ターゲットプラットフォームのハードウェア制限) では、一部の UsageHints が内部的に無視される可能性があることに留意してください。 |
view-data-key |
string |
ビューデータの永続性 (ツリーの展開状態、スクロール位置、ズームレベルなど) に使用されます。 このキーは、ビューデータストアからビューデータを保存およびロードするために使用されます。このキーを設定しないと、関連する VisualElement の永続性が無効になります。詳細については、ビューデータの永続性を参照してください。 |
USS クラス
以下の表は、すべての C# パブリックプロパティ名と、それに関連する USS セレクターのリストです。
| C# プロパティ | USS セレクター | 説明 |
|---|---|---|
textUssClassName |
.unity-search-field-base__text-field |
この型の要素のテキスト要素の USS クラス名。 |
searchButtonUssClassName |
.unity-search-field-base__search-button |
この型の要素の検索ボタンの USS クラス名。 |
cancelButtonUssClassName |
.unity-search-field-base__cancel-button |
この型の要素のキャンセルボタンの USS クラス名。 |
cancelButtonOffVariantUssClassName |
.unity-search-field-base__cancel-button--off |
オフになっている場合のこの型の要素の キャンセルボタンの USS クラス名。 |
popupVariantUssClassName |
.unity-search-field-base--popup |
ポップアップメニューを使用している場合のこの型の要素の USS クラス名。 |
ussClassName |
.unity-toolbar-search-field |
この型の要素の USS クラス名。 |
ussClassName |
.unity-search-field-base |
この型の要素の USS クラス名。 |
textUssClassName |
.unity-search-field-base__text-field |
この型の要素のテキスト要素の USS クラス名。 |
textInputUssClassName |
.unity-search-field-base__text-field__input |
この型の要素のテキスト入力要素の USS クラス名。 |
searchButtonUssClassName |
.unity-search-field-base__search-button |
この型の要素の検索ボタンの USS クラス名。 |
cancelButtonUssClassName |
.unity-search-field-base__cancel-button |
この型の要素のキャンセルボタンの USS クラス名。 |
cancelButtonOffVariantUssClassName |
.unity-search-field-base__cancel-button--off |
オフになっている場合のこの型の要素のキャンセルボタンの USS クラス名。 |
popupVariantUssClassName |
.unity-search-field-base--popup |
ポップアップメニューを使用している場合のこの型の要素の USS クラス名。 |
disabledUssClassName |
.unity-disabled |
ローカルで無効に設定されている要素の USS クラス名。 |
Inspector または UI Toolkit Debugger の Matching Selectors セクション を使用して、階層のすべてのレベルで VisualElement のコンポーネントに影響する USS セレクターを確認することもできます。