Propriedade estrutura

Descreve uma propriedade única de uma classe armazenada em um Realm.

Membros herdados

ValueType.ToString()

namespace: Realms.Esquema

Conjunto: Realm.exe

Sintaxe

public readonly struct Property

Construtores

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

Inicializa uma nova instância da estrutura de propriedade .

Declaração

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

Parâmetros

Tipo	Nome	Descrição
string	name	O nome da propriedade. Define o nome.
PropertyType	type	O tipo de propriedade. Define o tipo.
string	objectType	O tipo de objeto da propriedade. Define ObjectType.
string	linkOriginPropertyName	O nome da propriedade que vincula ao modelo. Define LinkOriginPropertyName.
bool	isPrimaryKey	Um sinalizador que indica se esta propriedade é uma chave primária. Define IsPrimaryKey.
Tipo de Índice	Tipo de Índice	Um enumeração indicando se esta propriedade é indexada e o tipo do índice utilizado. Define IndexType.
string	managedName	O nome gerenciado da propriedade. Define ManagedName.

Propriedades

Tipo de Índice

Obtém um valor indicando o modo de índice para esta propriedade.

Declaração

public IndexType IndexType { get; }

Valor da propriedade

Tipo	Descrição
Tipo de Índice

IsPrimaryKey

Obtém um valor indicando se esta propriedade é a chave primária.

Declaração

public bool IsPrimaryKey { get; }

Valor da propriedade

Tipo	Descrição
bool	true se a propriedade for a chave primária (a propriedade correspondente na definição da classe é marcada com PrimaryKeyAttribute); false caso contrário.

LinkOriginPropertyName

Obtém o nome da propriedade que vincula ao modelo que contém esta propriedade LinkingObjects . Este será null para propriedades onde o tipo não tem o sinalizador LinkingObjects .

Declaração

public string? LinkOriginPropertyName { get; }

Valor da propriedade

Tipo	Descrição
string	O nome da propriedade de vinculação.

ManagedName

Obtém o nome gerenciado da propriedade. Se não estiver definido, é considerado igual ao Nome.

Declaração

public string ManagedName { get; }

Valor da propriedade

Tipo	Descrição
string	O nome da propriedade.

Nome

Obtém o nome da propriedade conforme salvo no domínio.

Declaração

public string Name { get; }

Valor da propriedade

Tipo	Descrição
string	O nome da propriedade.

ObjectType

Obtém o tipo do objeto, se relevante. Este será null para propriedades onde o Tipo não tem o sinalizador de Objeto .

Declaração

public string? ObjectType { get; }

Valor da propriedade

Tipo	Descrição
string	O tipo do objeto.

Tipo

Obtém o tipo da propriedade.

Declaração

public PropertyType Type { get; }

Valor da propriedade

Tipo	Descrição
PropertyType	O tipo da propriedade.

Métodos

Backlinks(string, string, string, string?)

Inicializa uma nova propriedade descrevendo uma coleção de backlinks (todos os objetos vinculados a este por meio da propriedade especificada).

Declaração

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

Parâmetros

Tipo	Nome	Descrição
string	name	O nome da propriedade.
string	originObjectType	O objeto do outro lado do relacionamento.
string	originPropertyName	A propriedade que está na outra extremidade do relacionamento.
string	managedName	O nome gerenciado da propriedade.

Devoluções

Tipo	Descrição
Propriedade	Uma instância de Property que pode ser usada para construir um ObjectSchema.

Veja também

BacklinkAttribute

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

Inicializa uma nova propriedade a partir de um valor de Tipo .

Declaração

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

Parâmetros

Tipo	Nome	Descrição
string	name	O nome da propriedade.
Tipo	type	O valor Type que será usado para inferir o PropertyType. A nulidade será inferida para tipos de valor, mas deve ser especificada via isNullable para tipos de referência.
bool	isPrimaryKey	Um sinalizador que indica se a propriedade é chave primária.
Tipo de Índice	Tipo de Índice	Um enumeração indicando se esta propriedade é indexada e o tipo do índice utilizado. Define IndexType.
bool?	isNullable	Um sinalizador que indica se a propriedade é anulável. Passe null para inferir a nulidade do argumento type . Passe um valor não nulo para substituí-lo.
string	managedName	O nome gerenciado da propriedade.

Devoluções

Tipo	Descrição
Propriedade	Uma instância de Property que pode ser usada para construir um ObjectSchema.

FromType<T>(string, bool, IndexType, bool?, string?)

Inicia uma nova propriedade descrevendo o tipo fornecido.

Declaração

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

Parâmetros

Tipo	Nome	Descrição
string	name	O nome da propriedade.
bool	isPrimaryKey	Um sinalizador que indica se a propriedade é chave primária.
Tipo de Índice	Tipo de Índice	Um enumeração indicando se esta propriedade é indexada e o tipo do índice utilizado. Define IndexType.
bool?	isNullable	Um sinalizador que indica se a propriedade é anulável. Passe null para inferir a nulidade do argumento T . Passe um valor não nulo para substituí-lo.
string	managedName	O nome gerenciado da propriedade.

Devoluções

Tipo	Descrição
Propriedade	Uma instância de Property que pode ser usada para construir um ObjectSchema.

Parâmetros de tipo

Nome	Descrição
t	O tipo que será usado para inferir o PropertyType. A nulidade será inferida para tipos de valor, mas deve ser especificada via isNullable para tipos de referência.

Objeto(string, string, string?)

Inicia uma nova propriedade vinculando a um RealmObject.

Declaração

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

Parâmetros

Tipo	Nome	Descrição
string	name	O nome da propriedade.
string	objectType	O tipo de objeto . Objetos autônomo e embarcados são válidos.
string	managedName	O nome gerenciado da propriedade.

Devoluções

Tipo	Descrição
Propriedade	Uma instância de Property que pode ser usada para construir um ObjectSchema.

ObjectDictionary(string, string, string?)

Inicializa uma nova propriedade descrevendo um dicionário de strings para RealmObjects.

Declaração

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

Parâmetros

Tipo	Nome	Descrição
string	name	O nome da propriedade.
string	objectType	O tipo de objeto . Objetos autônomo e embarcados são válidos.
string	managedName	O nome gerenciado da propriedade.

Devoluções

Tipo	Descrição
Propriedade	Uma instância de Property que pode ser usada para construir um ObjectSchema.

ObjectList(string, string, string?)

Inicializa uma nova propriedade descrevendo uma lista de RealmObjects.

Declaração

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

Parâmetros

Tipo	Nome	Descrição
string	name	O nome da propriedade.
string	objectType	O tipo de objeto . Objetos autônomo e embarcados são válidos.
string	managedName	O nome gerenciado da propriedade.

Devoluções

Tipo	Descrição
Propriedade	Uma instância de Property que pode ser usada para construir um ObjectSchema.

ObjectSet(string, string, string?)

Inicializa uma nova propriedade descrevendo um conjunto de RealmObjects.

Declaração

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

Parâmetros

Tipo	Nome	Descrição
string	name	O nome da propriedade.
string	objectType	O tipo de objeto . Objetos autônomo e embarcados são válidos.
string	managedName	O nome gerenciado da propriedade.

Devoluções

Tipo	Descrição
Propriedade	Uma instância de Property que pode ser usada para construir um ObjectSchema.

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

Inicializa uma nova propriedade de um tipo primitivo (string, int, data, etc.).

Declaração

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

Parâmetros

Tipo	Nome	Descrição
string	name	O nome da propriedade.
RealmValueType	type	O tipo de propriedade. Observe que usar Null ou Object resultará no lançamento de uma exceção. Se você quiser criar uma propriedade de objeto , use Object(string, string, string?).
bool	isPrimaryKey	Um sinalizador que indica se a propriedade é chave primária.
Tipo de Índice	Tipo de Índice	Um enumeração indicando se esta propriedade é indexada e o tipo do índice utilizado. Define IndexType.
bool	isNullable	Um sinalizador que indica se a propriedade é anulável.
string	managedName	O nome gerenciado da propriedade.

Devoluções

Tipo	Descrição
Propriedade	Uma instância de Property que pode ser usada para construir um ObjectSchema.

PrimitiveDictionary(string, RealmValueType, bool, string?)

Inicializa uma nova propriedade descrevendo um dicionário de strings para valores primitivos.

Declaração

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

Parâmetros

Tipo	Nome	Descrição
string	name	O nome da propriedade.
RealmValueType	type	O tipo de propriedade. Observe que usar Null ou Object resultará no lançamento de uma exceção. Se você quiser criar um dicionário da propriedade de objetos, use ObjectDictionary(string, string, string?).
bool	areElementsNullable	Um sinalizador que indica se os elementos da lista são anuláveis.
string	managedName	O nome gerenciado da propriedade.

Devoluções

Tipo	Descrição
Propriedade	Uma instância de Property que pode ser usada para construir um ObjectSchema.

PrimitiveList(string, RealmValueType, bool, string?)

Inicia uma nova propriedade descrevendo uma lista de valores primitivos.

Declaração

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

Parâmetros

Tipo	Nome	Descrição
string	name	O nome da propriedade.
RealmValueType	type	O tipo de propriedade. Observe que usar Null ou Object resultará no lançamento de uma exceção. Se você quiser criar uma lista de objetos de propriedade, use ObjectList(string, string, string?).
bool	areElementsNullable	Um sinalizador que indica se os elementos da lista são anuláveis.
string	managedName	O nome gerenciado da propriedade.

Devoluções

Tipo	Descrição
Propriedade	Uma instância de Property que pode ser usada para construir um ObjectSchema.

PrimitiveSet(string, RealmValueType, bool, string?)

Inicializa uma nova propriedade descrevendo um conjunto de valores primitivos.

Declaração

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

Parâmetros

Tipo	Nome	Descrição
string	name	O nome da propriedade.
RealmValueType	type	O tipo de propriedade. Observe que usar Null ou Object resultará no lançamento de uma exceção. Se você quiser criar um conjunto de propriedade de objetos, use ObjectSet(string, string, string?).
bool	areElementsNullable	Um sinalizador que indica se os elementos da lista são anuláveis.
string	managedName	O nome gerenciado da propriedade.

Devoluções

Tipo	Descrição
Propriedade	Uma instância de Property que pode ser usada para construir um ObjectSchema.

RealmValue(string, string?)

Inicializa uma nova propriedade do tipo RealmValue.

Declaração

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

Parâmetros

Tipo	Nome	Descrição
string	name	O nome da propriedade.
string	managedName	O nome gerenciado da propriedade.

Devoluções

Tipo	Descrição
Propriedade	Uma instância de Property que pode ser usada para construir um ObjectSchema.

RealmValueDictionary(string, string?)

Inicializa uma nova propriedade descrevendo um dicionário de RealmValues.

Declaração

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

Parâmetros

Tipo	Nome	Descrição
string	name	O nome da propriedade.
string	managedName	O nome gerenciado da propriedade.

Devoluções

Tipo	Descrição
Propriedade	Uma instância de Property que pode ser usada para construir um ObjectSchema.

RealmValueList(string, string?)

Inicializa uma nova propriedade descrevendo uma lista de RealmValues.

Declaração

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

Parâmetros

Tipo	Nome	Descrição
string	name	O nome da propriedade.
string	managedName	O nome gerenciado da propriedade.

Devoluções

Tipo	Descrição
Propriedade	Uma instância de Property que pode ser usada para construir um ObjectSchema.

RealmValueSet(string, string?)

Inicializa uma nova propriedade descrevendo um conjunto de RealmValues.

Declaração

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

Parâmetros

Tipo	Nome	Descrição
string	name	O nome da propriedade.
string	managedName	O nome gerenciado da propriedade.

Devoluções

Tipo	Descrição
Propriedade	Uma instância de Property que pode ser usada para construir um ObjectSchema.