構造体プロパティ

Realmに保存されているクラスの 1 つのプロパティを記述します。

継承されたノード

ValueType.ToString()

Namespace: Realms.Schema

組み立て: Realm.dll

構文

public readonly struct Property

コンストラクター

Property(string, PropertyType, string?, string?,bool, IndexType, string?)

Property構造体の新しいインスタンスを初期化します。

宣言

public Property(string name, PropertyType type, string? objectType = null, string? linkOriginPropertyName = null, bool isPrimaryKey = false, IndexType indexType = IndexType.None, string? managedName = null)

パラメーター

タイプ	名前	説明
string	name	プロパティの名前。 名前を設定します。
PropertyType	タイプ	プロパティの型。 タイプを設定します。
string	objectType	プロパティのオブジェクトタイプ。 ObjectTypeを設定します。
string	linkOriginPropertyName	モデルにリンクするプロパティの名前。 LinkOriginPropertyNameを設定します。
ブール	isPrimaryKey	このプロパティがプライマリキーであるかどうかを示すフラグ。 IsPrimaryKeyを設定します。
インデックス タイプ	インデックス タイプ	このプロパティがインデックス化されているかどうか、および使用されるインデックスのタイプを示す列挙型。 IndexTypeを設定します。
string	ManagedName	プロパティの管理対象名。 ManagedNameを設定します。

プロパティ

インデックス タイプ

このプロパティのインデックス モードを示す値を取得します。

宣言

public IndexType IndexType { get; }

プロパティ値

タイプ	説明
インデックス タイプ

IsPrimaryKey

このプロパティがプライマリキーであるかどうかを示す値を取得します。

宣言

public bool IsPrimaryKey { get; }

プロパティ値

タイプ	説明
ブール	true プロパティがプライマリキー（クラス定義内の一致するプロパティがPrimaryKeyAttributeでマークされている）の場合。それ以外の場合は、 false 。

LinkOriginPropertyName

このLinkingObjectsプロパティを含むモデルにリンクするプロパティの名前を取得します。 これは、タイプにLinkingObjectsフラグがないプロパティではnullになります。

宣言

public string? LinkOriginPropertyName { get; }

プロパティ値

タイプ	説明
string	リンク プロパティの名前。

ManagedName

プロパティの管理対象名を取得します。 設定されていない場合は、 Nameと同じであると見なされます。

宣言

public string ManagedName { get; }

プロパティ値

タイプ	説明
string	プロパティの名前。

名前

Realm に保存されているプロパティの名前を取得します。

宣言

public string Name { get; }

プロパティ値

タイプ	説明
string	プロパティの名前。

ObjectType

関連する場合、オブジェクトのタイプを取得します。 これは、タイプにオブジェクトフラグがないプロパティではnullになります。

宣言

public string? ObjectType { get; }

プロパティ値

タイプ	説明
string	オブジェクトの種類。

タイプ

プロパティの型を取得します。

宣言

public PropertyType Type { get; }

プロパティ値

タイプ	説明
PropertyType	プロパティの型。

メソッド

バックリンク（string, string, string, string?）

バックリンクのコレクションを記述する新しいプロパティを初期化します（指定されたプロパティを介してこのコレクションにリンクするすべてのオブジェクト）。

宣言

public static Property Backlinks(string name, string originObjectType, string originPropertyName, string? managedName = null)

パラメーター

タイプ	名前	説明
string	name	プロパティの名前。
string	authorObjectType	関係の反対側にあるオブジェクト。
string	domainPropertyName	関係の反対側にあるプロパティ。
string	ManagedName	プロパティの管理対象名。

戻り値

タイプ	説明
プロパティ	ObjectSchema を構築するために使用できる Property インスタンス。

その他の参照

バックリンクAttribute

FromType(string, Type,bool, IndexType,bool?,string?)

Type値から新しいプロパティを初期化します。

宣言

public static Property FromType(string name, Type type, bool isPrimaryKey = false, IndexType indexType = IndexType.None, bool? isNullable = null, string? managedName = null)

パラメーター

タイプ	名前	説明
string	name	プロパティの名前。
タイプ	タイプ	PropertyType を推論するために使用される 型 の値。値型には null 値が推論されますが、参照型にはisNullable経由で指定する必要があります。
ブール	isPrimaryKey	プロパティがプライマリキーであるかどうかを示すフラグ。
インデックス タイプ	インデックス タイプ	このプロパティがインデックス化されているかどうか、および使用されるインデックスのタイプを示す列挙型。 IndexTypeを設定します。
ブール値は？	isNullable	プロパティが null 可能かどうかを示すフラグ。 nullを渡して、 type引数から null 可能性を推測します。 非 null の値を渡して上書きします。
string	ManagedName	プロパティの管理対象名。

戻り値

タイプ	説明
プロパティ	ObjectSchema を構築するために使用できる Property インスタンス。

FromType<T>(string, ブール, IndexType, ブール?, string?)

指定された型を説明する新しいプロパティを初期化します。

宣言

public static Property FromType<T>(string name, bool isPrimaryKey = false, IndexType indexType = IndexType.None, bool? isNullable = null, string? managedName = null)

パラメーター

タイプ	名前	説明
string	name	プロパティの名前。
ブール	isPrimaryKey	プロパティがプライマリキーであるかどうかを示すフラグ。
インデックス タイプ	インデックス タイプ	このプロパティがインデックス化されているかどうか、および使用されるインデックスのタイプを示す列挙型。 IndexTypeを設定します。
ブール値は？	isNullable	プロパティが null 可能かどうかを示すフラグ。 nullを渡して、 T引数から null 可能性を推測します。 非 null の値を渡して上書きします。
string	ManagedName	プロパティの管理対象名。

戻り値

タイプ	説明
プロパティ	ObjectSchema を構築するために使用できる Property インスタンス。

型パラメータ

名前	説明
t	PropertyTypeを推論するために使用される型。 値型には null 値が推論されますが、参照型にはisNullable経由で指定する必要があります。

Object(string, string, string?)

RealmObject にリンクする新しいプロパティを初期化します。

宣言

public static Property Object(string name, string objectType, string? managedName = null)

パラメーター

タイプ	名前	説明
string	name	プロパティの名前。
string	objectType	オブジェクトタイプ。 スタンドアロン オブジェクトと埋め込みオブジェクトの両方が有効です。
string	ManagedName	プロパティの管理対象名。

戻り値

タイプ	説明
プロパティ	ObjectSchema を構築するために使用できる Property インスタンス。

ObjectDictionary(string, string, string?)

RealmObjects への string の辞書を記述する新しいプロパティを初期化します。

宣言

public static Property ObjectDictionary(string name, string objectType, string? managedName = null)

パラメーター

タイプ	名前	説明
string	name	プロパティの名前。
string	objectType	オブジェクトタイプ。 スタンドアロン オブジェクトと埋め込みオブジェクトの両方が有効です。
string	ManagedName	プロパティの管理対象名。

戻り値

タイプ	説明
プロパティ	ObjectSchema を構築するために使用できる Property インスタンス。

ObjectList(string, string, string?)

RealmObjects のリストを記述する新しいプロパティを初期化します。

宣言

public static Property ObjectList(string name, string objectType, string? managedName = null)

パラメーター

タイプ	名前	説明
string	name	プロパティの名前。
string	objectType	オブジェクトタイプ。 スタンドアロン オブジェクトと埋め込みオブジェクトの両方が有効です。
string	ManagedName	プロパティの管理対象名。

戻り値

タイプ	説明
プロパティ	ObjectSchema を構築するために使用できる Property インスタンス。

ObjectSet(string, string, string?)

RealmObjects のセットを記述する新しいプロパティを初期化します。

宣言

public static Property ObjectSet(string name, string objectType, string? managedName = null)

パラメーター

タイプ	名前	説明
string	name	プロパティの名前。
string	objectType	オブジェクトタイプ。 スタンドアロン オブジェクトと埋め込みオブジェクトの両方が有効です。
string	ManagedName	プロパティの管理対象名。

戻り値

タイプ	説明
プロパティ	ObjectSchema を構築するために使用できる Property インスタンス。

Private(string, RealmValueType,bool, IndexType,bool,string?)

プリミティブ（string、int、dateなど）タイプの新しいプロパティを初期化します。

宣言

public static Property Primitive(string name, RealmValueType type, bool isPrimaryKey = false, IndexType indexType = IndexType.None, bool isNullable = false, string? managedName = null)

パラメーター

タイプ	名前	説明
string	name	プロパティの名前。
RealmValueType	タイプ	プロパティの型。 NullまたはObjectを使用すると例外がスローされることに注意してください。 オブジェクト プロパティを作成する場合は、 Object(string, string, string?)を使用します。
ブール	isPrimaryKey	プロパティがプライマリキーであるかどうかを示すフラグ。
インデックス タイプ	インデックス タイプ	このプロパティがインデックス化されているかどうか、および使用されるインデックスのタイプを示す列挙型。 IndexTypeを設定します。
ブール	isNullable	プロパティが null 可能かどうかを示すフラグ。
string	ManagedName	プロパティの管理対象名。

戻り値

タイプ	説明
プロパティ	ObjectSchema を構築するために使用できる Property インスタンス。

PrivateDictionary(string, RealmValueType,bool,string?)

プリミティブ値への文字列の辞書を記述する新しいプロパティを初期化します。

宣言

public static Property PrimitiveDictionary(string name, RealmValueType type, bool areElementsNullable = false, string? managedName = null)

パラメーター

タイプ	名前	説明
string	name	プロパティの名前。
RealmValueType	タイプ	プロパティの型。 NullまたはObjectを使用すると例外がスローされることに注意してください。 オブジェクト プロパティの辞書を作成する場合は、 ObjectDictionary(string, string, string?)を使用します。
ブール	isElementsnullable	リストの要素が null 可能かどうかを示すフラグ。
string	ManagedName	プロパティの管理対象名。

戻り値

タイプ	説明
プロパティ	ObjectSchema を構築するために使用できる Property インスタンス。

PrivateList(string, RealmValueType,bool,string?)

プリミティブ値のリストを記述する新しいプロパティを初期化します。

宣言

public static Property PrimitiveList(string name, RealmValueType type, bool areElementsNullable = false, string? managedName = null)

パラメーター

タイプ	名前	説明
string	name	プロパティの名前。
RealmValueType	タイプ	プロパティの型。 NullまたはObjectを使用すると例外がスローされることに注意してください。 オブジェクト プロパティのリストを作成する場合は、 ObjectList(string, string, string?)を使用します。
ブール	isElementsnullable	リストの要素が null 可能かどうかを示すフラグ。
string	ManagedName	プロパティの管理対象名。

戻り値

タイプ	説明
プロパティ	ObjectSchema を構築するために使用できる Property インスタンス。

PrivateSet(string, RealmValueType,bool,string?)

プリミティブ値のセットを記述する新しいプロパティを初期化します。

宣言

public static Property PrimitiveSet(string name, RealmValueType type, bool areElementsNullable = false, string? managedName = null)

パラメーター

タイプ	名前	説明
string	name	プロパティの名前。
RealmValueType	タイプ	プロパティの型。 NullまたはObjectを使用すると例外がスローされることに注意してください。 オブジェクト プロパティのセットを作成する場合は、 ObjectSet(string, string, string?)を使用します。
ブール	isElementsnullable	リストの要素が null 可能かどうかを示すフラグ。
string	ManagedName	プロパティの管理対象名。

戻り値

タイプ	説明
プロパティ	ObjectSchema を構築するために使用できる Property インスタンス。

RealmValue(string, string?)

RealmValue 型の新しいプロパティを初期化します。

宣言

public static Property RealmValue(string name, string? managedName = null)

パラメーター

タイプ	名前	説明
string	name	プロパティの名前。
string	ManagedName	プロパティの管理対象名。

戻り値

タイプ	説明
プロパティ	ObjectSchema を構築するために使用できる Property インスタンス。

RealmValueDictionary(string, string?)

RealmValues の辞書を記述する新しいプロパティを初期化します。

宣言

public static Property RealmValueDictionary(string name, string? managedName = null)

パラメーター

タイプ	名前	説明
string	name	プロパティの名前。
string	ManagedName	プロパティの管理対象名。

戻り値

タイプ	説明
プロパティ	ObjectSchema を構築するために使用できる Property インスタンス。

RealmValueList(string, string?)

RealmValues のリストを記述する新しいプロパティを初期化します。

宣言

public static Property RealmValueList(string name, string? managedName = null)

パラメーター

タイプ	名前	説明
string	name	プロパティの名前。
string	ManagedName	プロパティの管理対象名。

戻り値

タイプ	説明
プロパティ	ObjectSchema を構築するために使用できる Property インスタンス。

RealmValueSet(string, string?)

RealmValues のセットを記述する新しいプロパティを初期化します。

宣言

public static Property RealmValueSet(string name, string? managedName = null)

パラメーター

タイプ	名前	説明
string	name	プロパティの名前。
string	ManagedName	プロパティの管理対象名。

戻り値

タイプ	説明
プロパティ	ObjectSchema を構築するために使用できる Property インスタンス。