PropertyField は、SerializedProperty にバインドするために特別に設計されたフィールド要素です。プロパティを PropertyField にバインドすると、そのプロパティ型に基づいてネストされた BaseField 要素が作成されます。例えば、int プロパティを PropertyField にバインドする場合、IntegerField は PropertyField 内にネストされます。
デフォルトでは、PropertyField は .unity-base-field__aligned USS クラスで作成され、バインディング時に作成されるネストされた各フィールドにも適用されます。ただし、子 BaseField 要素を PropertyField に手動で追加する場合は、その子フィールド要素にスタイルクラスを手動で追加する必要があります。.unity-base-field__aligned クラスが InspectorElement に存在する場合、フィールドは Inspector ウィンドウの他のフィールドに合わせてラベル幅を計算します。IMGUI フィールドが存在する場合、UI Toolkit フィールドは整合性と互換性を確保するよう揃えられます。
C# クラス: PropertyField
名前空間: UnityEditor.UIElements
基本クラス: VisualElement
この要素は以下のメンバー属性を持ちます。
| 名前 | タイプ | 説明 |
|---|---|---|
binding-path |
string |
バインドされるべきターゲットプロパティのパス。 |
label |
string |
オプションで、生成プロパティフィールドのラベルを上書きします。ラベルを指定しない場合、文字列は SerializedProperty から取得されます。 |
この要素は基本クラスから以下の属性を継承します。
| 名前 | タイプ | 説明 |
|---|---|---|
focusable |
boolean |
要素がフォーカス可能である場合は true。 |
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 |
mouseEvents または IPanel.Pick クエリの間にこの要素を選択 (ピック) できるかどうかを決定します。 |
style |
string |
VisualElement スタイルの値を設定します。 |
tooltip |
string |
ユーザーが要素をマウスオーバーした後、わずかな時間、情報ボックス内に表示するテキスト。これはエディター UI でのみサポートされます。 |
usage-hints |
UIElements.UsageHints |
VisualElement の高レベルの使用パターンを指定するヒント値の組み合わせ。このプロパティは、VisualElement がまだ Panel の一部でない場合にのみ設定できます。Panel の一部になると、このプロパティは事実上読み取り専用となり、変更しようとすると例外がスローされます。適切な UsageHints を指定することで、予想される使用パターンに基づいて、特定の操作をどのように処理するか、または高速化するかについて、システムがより適切な判断を下すようになります。これらのヒントは動作や視覚的な結果には影響しませんが、パネルとその中の要素の全体的なパフォーマンスにのみ影響することに注意してください。常に適切な UsageHints を指定することを考慮することをお勧めしますが、特定の条件下 (例えば、ターゲットプラットフォームのハードウェア制限など) では、いくつかの UsageHints が内部的に無視される可能性があることに留意してください。 |
view-data-key |
string |
ビューデータの永続性 (ツリーの展開状態、スクロール位置、ズームレベルなど) に使用されます。 このキーは、ビューデータストアからビューデータを保存およびロードするために使用されます。このキーを設定しないと、関連する VisualElement の永続性が無効になります。詳細については、ビューデータの永続性 を参照してください。 |
以下の表は、すべての C# パブリックプロパティ名と、それに関連する USS セレクターのリストです。
| C# プロパティ | USS セレクター | 説明 |
|---|---|---|
ussClassName |
.unity-property-field |
このタイプの要素の USS クラス名。 |
labelUssClassName |
.unity-property-field__label |
このタイプの要素のラベルの USS クラス名。 |
inputUssClassName |
.unity-property-field__input |
このタイプの要素の入力要素の USS クラス名。 |
inspectorElementUssClassName |
.unity-property-field__inspector-property |
Inspector 要素のプロパティフィールドの USS クラス名。 |
disabledUssClassName |
.unity-disabled |
ローカルで無効な要素の USS クラス名。 |
Inspector または UI Toolkit Debugger の Matching Selectors セクション を使用して、階層のすべてのレベルで VisualElement のコンポーネントに影響する USS セレクターを確認することもできます。