Struct RealmValue

A type that can represent any valid Realm data type. It is a valid type in and of itself, which means that it can be used to declare a property of type RealmValue. Please note that a RealmValue property in a managed realm object cannot contain an embedded object.

Implements

IEquatable<RealmValue>

Namespace: Realms

Assembly: Realm.dll

Syntax

[Preserve(AllMembers = true)]
public readonly struct RealmValue : IEquatable<RealmValue>

Examples

public class MyClass : RealmObject
{
    public RealmValue MyValue { get; set; }
}

var obj = new MyClass();
obj.MyValue = 123;
obj.MyValue = "abc";

if (obj.Type == RealmValueType.Int)
{
    var myInt = obj.MyValue.AsLong();
}

Properties

Null

Gets a RealmValue representing null.

Declaration

public static RealmValue Null { get; }

Property Value

Type	Description
RealmValue	A new RealmValue instance of type Null.

ObjectType

Gets the name of the type of the object contained in RealmValue. If it does not contain an object, it will return null.

Declaration

public string? ObjectType { get; }

Property Value

Type	Description
string	The name of the type stored in RealmValue if an object, null otherwise.

Type

Gets the RealmValueType stored in this value.

Declaration

public RealmValueType Type { get; }

Property Value

Type	Description
RealmValueType	The RealmValueType of the current value in the database.

Remarks

You can check the type of the Realm value and then use any of the AsXXX methods to convert it to correct C# type.
For performance reasons, all integral types, i.e. byte, short, int, long, as well as char are represented as Int. Realm preserves no information about the original type of the integral value stored in a RealmValue field.

Methods

AsAny()

Returns the stored value boxed in object.

Declaration

public object? AsAny()

Returns

Type	Description
object	The underlying value.

AsBool()

Returns the stored value as a bool.

Declaration

public bool AsBool()

Returns

Type	Description
bool	A boolean representing the value stored in the database.

Exceptions

Type	Condition
InvalidOperationException	Thrown if the underlying value is not of type Bool.

AsByte()

Returns the stored value as a byte.

Declaration

public byte AsByte()

Returns

Type	Description
byte	An 8-bit unsigned integer representing the value stored in the database.

Exceptions

Type	Condition
InvalidOperationException	Thrown if the underlying value is not of type Int.

See Also

AsByteRealmInteger()

AsByteRealmInteger()

Returns the stored value as a RealmInteger<T>. It offers Increment/Decrement API that preserve intent when merging conflicts.

Declaration

public RealmInteger<byte> AsByteRealmInteger()

Returns

Type	Description
RealmInteger<byte>	An 8-bit RealmInteger<T> representing the value stored in the database.

Exceptions

Type	Condition
InvalidOperationException	Thrown if the underlying value is not of type Int.

See Also

AsByte()

AsChar()

Returns the stored value as a char.

Declaration

public char AsChar()

Returns

Type	Description
char	A UTF-16 code unit representing the value stored in the database.

Exceptions

Type	Condition
InvalidOperationException	Thrown if the underlying value is not of type Int.

AsData()

Returns the stored value as an array of bytes.

Declaration

public byte[] AsData()

Returns

Type	Description
byte[]	An array of bytes representing the value stored in the database.

Exceptions

Type	Condition
InvalidOperationException	Thrown if the underlying value is not of type Data.

AsDate()

Returns the stored value as a DateTimeOffset.

Declaration

public DateTimeOffset AsDate()

Returns

Type	Description
DateTimeOffset	A DateTimeOffset value representing the value stored in the database.

Exceptions

Type	Condition
InvalidOperationException	Thrown if the underlying value is not of type Date.

AsDecimal()

Returns the stored value as a decimal.

Declaration

public decimal AsDecimal()

Returns

Type	Description
decimal	A 96-bit decimal number representing the value stored in the database.

Exceptions

Type	Condition
InvalidOperationException	Thrown if the underlying value is not of type Decimal128.

AsDecimal128()

Returns the stored value as a MongoDB.Bson.Decimal128.

Declaration

public Decimal128 AsDecimal128()

Returns

Type	Description
Decimal128	A 128-bit decimal number representing the value stored in the database.

Exceptions

Type	Condition
InvalidOperationException	Thrown if the underlying value is not of type Decimal128.

AsDictionary()

Returns the stored value as a dictionary.

Declaration

public IDictionary<string, RealmValue> AsDictionary()

Returns

Type	Description
IDictionary<string, RealmValue>	A dictionary representing the value stored in the database.

Exceptions

Type	Condition
InvalidOperationException	Thrown if the underlying value is not of type Dictionary.

AsDouble()

Returns the stored value as a double.

Declaration

public double AsDouble()

Returns

Type	Description
double	A 64-bit floating point number representing the value stored in the database.

Exceptions

Type	Condition
InvalidOperationException	Thrown if the underlying value is not of type Double.

AsFloat()

Returns the stored value as a float.

Declaration

public float AsFloat()

Returns

Type	Description
float	A 32-bit floating point number representing the value stored in the database.

Exceptions

Type	Condition
InvalidOperationException	Thrown if the underlying value is not of type Float.

AsGuid()

Returns the stored value as a Guid.

Declaration

public Guid AsGuid()

Returns

Type	Description
Guid	A Guid representing the value stored in the database.

Exceptions

Type	Condition
InvalidOperationException	Thrown if the underlying value is not of type Guid.

AsIRealmObject()

Returns the stored value as a IRealmObjectBase.

Declaration

public IRealmObjectBase AsIRealmObject()

Returns

Type	Description
IRealmObjectBase	A IRealmObjectBase instance representing the value stored in the database.

Exceptions

Type	Condition
InvalidOperationException	Thrown if the underlying value is not of type Object.

AsInt16()

Returns the stored value as a short (Int16).

Declaration

public short AsInt16()

Returns

Type	Description
short	A 16-bit integer representing the value stored in the database.

Exceptions

Type	Condition
InvalidOperationException	Thrown if the underlying value is not of type Int.

See Also

AsInt16RealmInteger()

AsInt16RealmInteger()

Returns the stored value as a RealmInteger<T>. It offers Increment/Decrement API that preserve intent when merging conflicts.

Declaration

public RealmInteger<short> AsInt16RealmInteger()

Returns

Type	Description
RealmInteger<short>	An 16-bit RealmInteger<T> representing the value stored in the database.

Exceptions

Type	Condition
InvalidOperationException	Thrown if the underlying value is not of type Int.

See Also

AsInt16()

AsInt32()

Returns the stored value as an int (Int32).

Declaration

public int AsInt32()

Returns

Type	Description
int	A 32-bit integer representing the value stored in the database.

Exceptions

Type	Condition
InvalidOperationException	Thrown if the underlying value is not of type Int.

See Also

AsInt32RealmInteger()

AsInt32RealmInteger()

Returns the stored value as a RealmInteger<T>. It offers Increment/Decrement API that preserve intent when merging conflicts.

Declaration

public RealmInteger<int> AsInt32RealmInteger()

Returns

Type	Description
RealmInteger<int>	An 32-bit RealmInteger<T> representing the value stored in the database.

Exceptions

Type	Condition
InvalidOperationException	Thrown if the underlying value is not of type Int.

See Also

AsInt32()

AsInt64()

Returns the stored value as a long (Int64).

Declaration

public long AsInt64()

Returns

Type	Description
long	A 64-bit integer representing the value stored in the database.

Exceptions

Type	Condition
InvalidOperationException	Thrown if the underlying value is not of type Int.

See Also

AsInt64RealmInteger()

AsInt64RealmInteger()

Returns the stored value as a RealmInteger<T>. It offers Increment/Decrement API that preserve intent when merging conflicts.

Declaration

public RealmInteger<long> AsInt64RealmInteger()

Returns

Type	Description
RealmInteger<long>	An 64-bit RealmInteger<T> representing the value stored in the database.

Exceptions

Type	Condition
InvalidOperationException	Thrown if the underlying value is not of type Int.

See Also

AsInt64()

AsList()

Returns the stored value as a list.

Declaration

public IList<RealmValue> AsList()

Returns

Type	Description
IList<RealmValue>	A list representing the value stored in the database.

Exceptions

Type	Condition
InvalidOperationException	Thrown if the underlying value is not of type List.

AsNullableBool()

Returns the stored value as a nullable bool.

Declaration

public bool? AsNullableBool()

Returns

Type	Description
bool?	A nullable boolean representing the value stored in the database.

Exceptions

Type	Condition
InvalidOperationException	Thrown if the underlying value is not of type Bool or Null.

AsNullableByte()

Returns the stored value as a nullable byte.

Declaration

public byte? AsNullableByte()

Returns

Type	Description
byte?	A nullable 8-bit unsigned integer representing the value stored in the database.

Exceptions

Type	Condition
InvalidOperationException	Thrown if the underlying value is not of type Int or Null.

See Also

AsNullableByteRealmInteger()

AsNullableByteRealmInteger()

Returns the stored value as a nullable RealmInteger<T>. It offers Increment/Decrement API that preserve intent when merging conflicts.

Declaration

public RealmInteger<byte>? AsNullableByteRealmInteger()

Returns

Type	Description
RealmInteger<byte>?	A nullable 8-bit RealmInteger<T> representing the value stored in the database.

Exceptions

Type	Condition
InvalidOperationException	Thrown if the underlying value is not of type Int or Null.

See Also

AsNullableByte()

AsNullableChar()

Returns the stored value as a nullable char.

Declaration

public char? AsNullableChar()

Returns

Type	Description
char?	A nullable UTF-16 code unit representing the value stored in the database.

Exceptions

Type	Condition
InvalidOperationException	Thrown if the underlying value is not of type Int or Null.

AsNullableData()

Returns the stored value as an array of bytes.

Declaration

public byte[]? AsNullableData()

Returns

Type	Description
byte[]	A nullable array of bytes representing the value stored in the database.

Exceptions

Type	Condition
InvalidOperationException	Thrown if the underlying value is not of type Data or Null.

AsNullableDate()

Returns the stored value as a nullable DateTimeOffset.

Declaration

public DateTimeOffset? AsNullableDate()

Returns

Type	Description
DateTimeOffset?	A nullable DateTimeOffset value representing the value stored in the database.

Exceptions

Type	Condition
InvalidOperationException	Thrown if the underlying value is not of type Date or Null.

AsNullableDecimal()

Returns the stored value as a nullable decimal.

Declaration

public decimal? AsNullableDecimal()

Returns

Type	Description
decimal?	A nullable 96-bit decimal number representing the value stored in the database.

Exceptions

Type	Condition
InvalidOperationException	Thrown if the underlying value is not of type Decimal128 or Null.

AsNullableDecimal128()

Returns the stored value as a nullable MongoDB.Bson.Decimal128.

Declaration

public Decimal128? AsNullableDecimal128()

Returns

Type	Description
Decimal128?	A nullable 128-bit decimal number representing the value stored in the database.

Exceptions

Type	Condition
InvalidOperationException	Thrown if the underlying value is not of type Date or Null.

AsNullableDouble()

Returns the stored value as a nullable double.

Declaration

public double? AsNullableDouble()

Returns

Type	Description
double?	A nullable 64-bit floating point number representing the value stored in the database.

Exceptions

Type	Condition
InvalidOperationException	Thrown if the underlying value is not of type Double or Null.

AsNullableFloat()

Returns the stored value as a nullable float.

Declaration

public float? AsNullableFloat()

Returns

Type	Description
float?	A nullable 32-bit floating point number representing the value stored in the database.

Exceptions

Type	Condition
InvalidOperationException	Thrown if the underlying value is not of type Float or Null.

AsNullableGuid()

Returns the stored value as a nullable Guid.

Declaration

public Guid? AsNullableGuid()

Returns

Type	Description
Guid?	A nullable Guid representing the value stored in the database.

Exceptions

Type	Condition
InvalidOperationException	Thrown if the underlying value is not of type Guid or Null.

AsNullableIRealmObject()

Returns the stored value as a IRealmObjectBase.

Declaration

public IRealmObjectBase? AsNullableIRealmObject()

Returns

Type	Description
IRealmObjectBase	A nullable IRealmObjectBase instance representing the value stored in the database. It will be null if Type is Null.

Exceptions

Type	Condition
InvalidOperationException	Thrown if the underlying value is not of type Object or Null.

AsNullableInt16()

Returns the stored value as a nullable short.

Declaration

public short? AsNullableInt16()

Returns

Type	Description
short?	A nullable 16-bit integer representing the value stored in the database.

Exceptions

Type	Condition
InvalidOperationException	Thrown if the underlying value is not of type Int or Null.

See Also

AsNullableInt16RealmInteger()

AsNullableInt16RealmInteger()

Returns the stored value as a nullable RealmInteger<T>. It offers Increment/Decrement API that preserve intent when merging conflicts.

Declaration

public RealmInteger<short>? AsNullableInt16RealmInteger()

Returns

Type	Description
RealmInteger<short>?	A nullable 16-bit RealmInteger<T> representing the value stored in the database.

Exceptions

Type	Condition
InvalidOperationException	Thrown if the underlying value is not of type Int or Null.

See Also

AsNullableInt16()

AsNullableInt32()

Returns the stored value as a nullable int.

Declaration

public int? AsNullableInt32()

Returns

Type	Description
int?	A nullable 32-bit integer representing the value stored in the database.

Exceptions

Type	Condition
InvalidOperationException	Thrown if the underlying value is not of type Int or Null.

See Also

AsNullableInt32RealmInteger()

AsNullableInt32RealmInteger()

Returns the stored value as a nullable RealmInteger<T>. It offers Increment/Decrement API that preserve intent when merging conflicts.

Declaration

public RealmInteger<int>? AsNullableInt32RealmInteger()

Returns

Type	Description
RealmInteger<int>?	A nullable 32-bit RealmInteger<T> representing the value stored in the database.

Exceptions

Type	Condition
InvalidOperationException	Thrown if the underlying value is not of type Int or Null.

See Also

AsNullableInt32()

AsNullableInt64()

Returns the stored value as a nullable long.

Declaration

public long? AsNullableInt64()

Returns

Type	Description
long?	A nullable 64-bit integer representing the value stored in the database.

Exceptions

Type	Condition
InvalidOperationException	Thrown if the underlying value is not of type Int or Null.

See Also

AsNullableInt64RealmInteger()

AsNullableInt64RealmInteger()

Returns the stored value as a nullable RealmInteger<T>. It offers Increment/Decrement API that preserve intent when merging conflicts.

Declaration

public RealmInteger<long>? AsNullableInt64RealmInteger()

Returns

Type	Description
RealmInteger<long>?	A nullable 64-bit RealmInteger<T> representing the value stored in the database.

Exceptions

Type	Condition
InvalidOperationException	Thrown if the underlying value is not of type Int or Null.

See Also

AsNullableInt64()

AsNullableObjectId()

Returns the stored value as a nullable MongoDB.Bson.ObjectId.

Declaration

public ObjectId? AsNullableObjectId()

Returns

Type	Description
ObjectId?	A nullable ObjectId representing the value stored in the database.

Exceptions

Type	Condition
InvalidOperationException	Thrown if the underlying value is not of type ObjectId or Null.

AsNullableRealmObject()

Returns the stored value as a RealmObjectBase.

Declaration

public RealmObjectBase? AsNullableRealmObject()

Returns

Type	Description
RealmObjectBase	A nullable RealmObjectBase instance representing the value stored in the database. It will be null if Type is Null.

Exceptions

Type	Condition
InvalidOperationException	Thrown if the underlying value is not of type Object or Null.

AsNullableRealmObject<T>()

Returns the stored value as a T which inherits from RealmObjectBase.

Declaration

public T? AsNullableRealmObject<T>() where T : class, IRealmObjectBase

Returns

Type	Description
T	A nullable RealmObjectBase instance representing the value stored in the database. It will be null if Type is Null.

Type Parameters

Name	Description
T	The type of the object stored in the database.

Exceptions

Type	Condition
InvalidOperationException	Thrown if the underlying value is not of type Object or Null.

AsNullableString()

Returns the stored value as a string.

Declaration

public string? AsNullableString()

Returns

Type	Description
string	A nullable string representing the value stored in the database.

Exceptions

Type	Condition
InvalidOperationException	Thrown if the underlying value is not of type String or Null.

AsObjectId()

Returns the stored value as an MongoDB.Bson.ObjectId.

Declaration

public ObjectId AsObjectId()

Returns

Type	Description
ObjectId	An ObjectId representing the value stored in the database.

Exceptions

Type	Condition
InvalidOperationException	Thrown if the underlying value is not of type ObjectId.

AsRealmObject()

Returns the stored value as a RealmObjectBase.

Declaration

public RealmObjectBase AsRealmObject()

Returns

Type	Description
RealmObjectBase	A RealmObjectBase instance representing the value stored in the database.

Exceptions

Type	Condition
InvalidOperationException	Thrown if the underlying value is not of type Object.

AsRealmObject<T>()

Returns the stored value as a T which inherits from RealmObjectBase.

Declaration

public T AsRealmObject<T>() where T : IRealmObjectBase

Returns

Type	Description
T	A RealmObjectBase instance representing the value stored in the database.

Type Parameters

Name	Description
T	The type of the object stored in the database.

Exceptions

Type	Condition
InvalidOperationException	Thrown if the underlying value is not of type Object.

AsString()

Returns the stored value as a string.

Declaration

public string AsString()

Returns

Type	Description
string	A string representing the value stored in the database.

Exceptions

Type	Condition
InvalidOperationException	Thrown if the underlying value is not of type String.

As<T>()

Returns the stored value converted to T.

Declaration

public T As<T>()

Returns

Type	Description
T	The underlying value converted to T.

Type Parameters

Name	Description
T	The type to which to convert the value.

Exceptions

Type	Condition
InvalidCastException	Thrown if the type is not convertible to T.

Dictionary(IDictionary<string, RealmValue>)

Gets a RealmValue representing a dictionary.

Declaration

public static RealmValue Dictionary(IDictionary<string, RealmValue> value)

Parameters

Type	Name	Description
IDictionary<string, RealmValue>	value	The input dictionary to copy.

Returns

Type	Description
RealmValue	A new RealmValue representing the input dictionary.

Remarks

Once created, this RealmValue will just wrap the input collection. After the object containing this RealmValue gets managed this value will be a Realm dictionary.

Equals(RealmValue)

Indicates whether the current object is equal to another object of the same type.

Declaration

public bool Equals(RealmValue other)

Parameters

Type	Name	Description
RealmValue	other	An object to compare with this object.

Returns

Type	Description
bool	true if the current object is equal to the other parameter; otherwise, false.

List(IList<RealmValue>)

Gets a RealmValue representing a list.

Declaration

public static RealmValue List(IList<RealmValue> value)

Parameters

Type	Name	Description
IList<RealmValue>	value	The input list to copy.

Returns

Type	Description
RealmValue	A new RealmValue representing the input list.

Remarks

Once created, this RealmValue will just wrap the input collection. After the object containing this RealmValue gets managed this value will be a Realm list.

ToString()

Returns the string representation of this RealmValue.

Declaration

public override string ToString()

Returns

Type	Description
string	A string describing the value.

Overrides

ValueType.ToString()

Operators

operator ==(RealmValue, RealmValue)

Compares two RealmValue instances for equality.

Declaration

public static bool operator ==(RealmValue left, RealmValue right)

Parameters

Type	Name	Description
RealmValue	left	The left instance.
RealmValue	right	The right instance.

Returns

Type	Description
bool	true if the underlying values stored in both instances are equal; false otherwise.

explicit operator Decimal128(RealmValue)

Converts a RealmValue to MongoDB.Bson.Decimal128. Equivalent to AsDecimal128().

Declaration

public static explicit operator Decimal128(RealmValue val)

Parameters

Type	Name	Description
RealmValue	val	The RealmValue to convert.

Returns

Type	Description
Decimal128	The MongoDB.Bson.Decimal128 stored in the RealmValue.

explicit operator ObjectId(RealmValue)

Converts a RealmValue to MongoDB.Bson.ObjectId. Equivalent to AsObjectId().

Declaration

public static explicit operator ObjectId(RealmValue val)

Parameters

Type	Name	Description
RealmValue	val	The RealmValue to convert.

Returns

Type	Description
ObjectId	The MongoDB.Bson.ObjectId stored in the RealmValue.

explicit operator RealmInteger<byte>(RealmValue)

Converts a RealmValue to RealmInteger<byte>. Equivalent to AsByteRealmInteger().

Declaration

public static explicit operator RealmInteger<byte>(RealmValue val)

Parameters

Type	Name	Description
RealmValue	val	The RealmValue to convert.

Returns

Type	Description
RealmInteger<byte>	The RealmInteger<byte> stored in the RealmValue.

explicit operator RealmInteger<short>(RealmValue)

Converts a RealmValue to RealmInteger<short>. Equivalent to AsInt16RealmInteger().

Declaration

public static explicit operator RealmInteger<short>(RealmValue val)

Parameters

Type	Name	Description
RealmValue	val	The RealmValue to convert.

Returns

Type	Description
RealmInteger<short>	The RealmInteger<short> stored in the RealmValue.

explicit operator RealmInteger<int>(RealmValue)

Converts a RealmValue to RealmInteger<int>. Equivalent to AsInt32RealmInteger().

Declaration

public static explicit operator RealmInteger<int>(RealmValue val)

Parameters

Type	Name	Description
RealmValue	val	The RealmValue to convert.

Returns

Type	Description
RealmInteger<int>	The RealmInteger<int> stored in the RealmValue.

explicit operator RealmInteger<long>(RealmValue)

Converts a RealmValue to RealmInteger<long>. Equivalent to AsInt64RealmInteger().

Declaration

public static explicit operator RealmInteger<long>(RealmValue val)

Parameters

Type	Name	Description
RealmValue	val	The RealmValue to convert.

Returns

Type	Description
RealmInteger<long>	The RealmInteger<long> stored in the RealmValue.

explicit operator RealmObjectBase?(RealmValue)

Converts a RealmValue to RealmObjectBase?. Equivalent to AsNullableRealmObject().

Declaration

public static explicit operator RealmObjectBase?(RealmValue val)

Parameters

Type	Name	Description
RealmValue	val	The RealmValue to convert.

Returns

Type	Description
RealmObjectBase	The RealmObjectBase? stored in the RealmValue.

explicit operator bool(RealmValue)

Converts a RealmValue to bool. Equivalent to AsBool().

Declaration

public static explicit operator bool(RealmValue val)

Parameters

Type	Name	Description
RealmValue	val	The RealmValue to convert.

Returns

Type	Description
bool	The bool stored in the RealmValue.

explicit operator byte(RealmValue)

Converts a RealmValue to byte. Equivalent to AsByte().

Declaration

public static explicit operator byte(RealmValue val)

Parameters

Type	Name	Description
RealmValue	val	The RealmValue to convert.

Returns

Type	Description
byte	The byte stored in the RealmValue.

explicit operator byte[]?(RealmValue)

Converts a RealmValue to byte[]?. Equivalent to AsNullableData().

Declaration

public static explicit operator byte[]?(RealmValue val)

Parameters

Type	Name	Description
RealmValue	val	The RealmValue to convert.

Returns

Type	Description
byte[]	The byte[]? stored in the RealmValue.

explicit operator char(RealmValue)

Converts a RealmValue to char. Equivalent to AsChar().

Declaration

public static explicit operator char(RealmValue val)

Parameters

Type	Name	Description
RealmValue	val	The RealmValue to convert.

Returns

Type	Description
char	The char stored in the RealmValue.

explicit operator DateTimeOffset(RealmValue)

Converts a RealmValue to DateTimeOffset. Equivalent to AsDate().

Declaration

public static explicit operator DateTimeOffset(RealmValue val)

Parameters

Type	Name	Description
RealmValue	val	The RealmValue to convert.

Returns

Type	Description
DateTimeOffset	The DateTimeOffset stored in the RealmValue.

explicit operator decimal(RealmValue)

Converts a RealmValue to decimal. Equivalent to AsDecimal().

Declaration

public static explicit operator decimal(RealmValue val)

Parameters

Type	Name	Description
RealmValue	val	The RealmValue to convert.

Returns

Type	Description
decimal	The decimal stored in the RealmValue.

explicit operator double(RealmValue)

Converts a RealmValue to double. Equivalent to AsDouble().

Declaration

public static explicit operator double(RealmValue val)

Parameters

Type	Name	Description
RealmValue	val	The RealmValue to convert.

Returns

Type	Description
double	The double stored in the RealmValue.

explicit operator Guid(RealmValue)

Converts a RealmValue to Guid. Equivalent to AsGuid().

Declaration

public static explicit operator Guid(RealmValue val)

Parameters

Type	Name	Description
RealmValue	val	The RealmValue to convert.

Returns

Type	Description
Guid	The Guid stored in the RealmValue.

explicit operator short(RealmValue)

Converts a RealmValue to short. Equivalent to AsInt16().

Declaration

public static explicit operator short(RealmValue val)

Parameters

Type	Name	Description
RealmValue	val	The RealmValue to convert.

Returns

Type	Description
short	The short stored in the RealmValue.

explicit operator int(RealmValue)

Converts a RealmValue to int. Equivalent to AsInt32().

Declaration

public static explicit operator int(RealmValue val)

Parameters

Type	Name	Description
RealmValue	val	The RealmValue to convert.

Returns

Type	Description
int	The int stored in the RealmValue.

explicit operator long(RealmValue)

Converts a RealmValue to long. Equivalent to AsInt64().

Declaration

public static explicit operator long(RealmValue val)

Parameters

Type	Name	Description
RealmValue	val	The RealmValue to convert.

Returns

Type	Description
long	The long stored in the RealmValue.

explicit operator Decimal128?(RealmValue)

Converts a RealmValue to Decimal128?. Equivalent to AsNullableDecimal128().

Declaration

public static explicit operator Decimal128?(RealmValue val)

Parameters

Type	Name	Description
RealmValue	val	The RealmValue to convert.

Returns

Type	Description
Decimal128?	The Decimal128? stored in the RealmValue.

explicit operator ObjectId?(RealmValue)

Converts a RealmValue to ObjectId?. Equivalent to AsNullableObjectId().

Declaration

public static explicit operator ObjectId?(RealmValue val)

Parameters

Type	Name	Description
RealmValue	val	The RealmValue to convert.

Returns

Type	Description
ObjectId?	The ObjectId? stored in the RealmValue.

explicit operator RealmInteger<byte>?(RealmValue)

Converts a RealmValue to RealmInteger<byte>?. Equivalent to AsNullableByteRealmInteger().

Declaration

public static explicit operator RealmInteger<byte>?(RealmValue val)

Parameters

Type	Name	Description
RealmValue	val	The RealmValue to convert.

Returns

Type	Description
RealmInteger<byte>?	The RealmInteger<byte>? stored in the RealmValue.

explicit operator RealmInteger<short>?(RealmValue)

Converts a RealmValue to RealmInteger<short>?. Equivalent to AsNullableInt16RealmInteger().

Declaration

public static explicit operator RealmInteger<short>?(RealmValue val)

Parameters

Type	Name	Description
RealmValue	val	The RealmValue to convert.

Returns

Type	Description
RealmInteger<short>?	The RealmInteger<short>? stored in the RealmValue.

explicit operator RealmInteger<int>?(RealmValue)

Converts a RealmValue to RealmInteger<int>?. Equivalent to AsNullableInt32RealmInteger().

Declaration

public static explicit operator RealmInteger<int>?(RealmValue val)

Parameters

Type	Name	Description
RealmValue	val	The RealmValue to convert.

Returns

Type	Description
RealmInteger<int>?	The RealmInteger<int>? stored in the RealmValue.

explicit operator RealmInteger<long>?(RealmValue)

Converts a RealmValue to RealmInteger<long>?. Equivalent to AsNullableInt64RealmInteger().

Declaration

public static explicit operator RealmInteger<long>?(RealmValue val)

Parameters

Type	Name	Description
RealmValue	val	The RealmValue to convert.

Returns

Type	Description
RealmInteger<long>?	The RealmInteger<long>? stored in the RealmValue.

explicit operator bool?(RealmValue)

Converts a RealmValue to bool?. Equivalent to AsNullableBool().

Declaration

public static explicit operator bool?(RealmValue val)

Parameters

Type	Name	Description
RealmValue	val	The RealmValue to convert.

Returns

Type	Description
bool?	The bool? stored in the RealmValue.

explicit operator byte?(RealmValue)

Converts a RealmValue to byte?. Equivalent to AsNullableByte().

Declaration

public static explicit operator byte?(RealmValue val)

Parameters

Type	Name	Description
RealmValue	val	The RealmValue to convert.

Returns

Type	Description
byte?	The byte? stored in the RealmValue.

explicit operator char?(RealmValue)

Converts a RealmValue to char?. Equivalent to AsNullableChar().

Declaration

public static explicit operator char?(RealmValue val)

Parameters

Type	Name	Description
RealmValue	val	The RealmValue to convert.

Returns

Type	Description
char?	The char? stored in the RealmValue.

explicit operator DateTimeOffset?(RealmValue)

Converts a RealmValue to DateTimeOffset?. Equivalent to AsNullableDate().

Declaration

public static explicit operator DateTimeOffset?(RealmValue val)

Parameters

Type	Name	Description
RealmValue	val	The RealmValue to convert.

Returns

Type	Description
DateTimeOffset?	The DateTimeOffset? stored in the RealmValue.

explicit operator decimal?(RealmValue)

Converts a RealmValue to decimal?. Equivalent to AsNullableDecimal().

Declaration

public static explicit operator decimal?(RealmValue val)

Parameters

Type	Name	Description
RealmValue	val	The RealmValue to convert.

Returns

Type	Description
decimal?	The decimal? stored in the RealmValue.

explicit operator double?(RealmValue)

Converts a RealmValue to double?. Equivalent to AsNullableDouble().

Declaration

public static explicit operator double?(RealmValue val)

Parameters

Type	Name	Description
RealmValue	val	The RealmValue to convert.

Returns

Type	Description
double?	The double? stored in the RealmValue.

explicit operator Guid?(RealmValue)

Converts a RealmValue to Guid?. Equivalent to AsNullableGuid().

Declaration

public static explicit operator Guid?(RealmValue val)

Parameters

Type	Name	Description
RealmValue	val	The RealmValue to convert.

Returns

Type	Description
Guid?	The Guid? stored in the RealmValue.

explicit operator short?(RealmValue)

Converts a RealmValue to short?. Equivalent to AsNullableInt16().

Declaration

public static explicit operator short?(RealmValue val)

Parameters

Type	Name	Description
RealmValue	val	The RealmValue to convert.

Returns

Type	Description
short?	The short? stored in the RealmValue.

explicit operator int?(RealmValue)

Converts a RealmValue to int?. Equivalent to AsNullableInt32().

Declaration

public static explicit operator int?(RealmValue val)

Parameters

Type	Name	Description
RealmValue	val	The RealmValue to convert.

Returns

Type	Description
int?	The int? stored in the RealmValue.

explicit operator long?(RealmValue)

Converts a RealmValue to long?. Equivalent to AsNullableInt64().

Declaration

public static explicit operator long?(RealmValue val)

Parameters

Type	Name	Description
RealmValue	val	The RealmValue to convert.

Returns

Type	Description
long?	The long? stored in the RealmValue.

explicit operator float?(RealmValue)

Converts a RealmValue to float?. Equivalent to AsNullableFloat().

Declaration

public static explicit operator float?(RealmValue val)

Parameters

Type	Name	Description
RealmValue	val	The RealmValue to convert.

Returns

Type	Description
float?	The float? stored in the RealmValue.

explicit operator float(RealmValue)

Converts a RealmValue to float. Equivalent to AsFloat().

Declaration

public static explicit operator float(RealmValue val)

Parameters

Type	Name	Description
RealmValue	val	The RealmValue to convert.

Returns

Type	Description
float	The float stored in the RealmValue.

explicit operator string?(RealmValue)

Converts a RealmValue to string?. Equivalent to AsNullableString().

Declaration

public static explicit operator string?(RealmValue val)

Parameters

Type	Name	Description
RealmValue	val	The RealmValue to convert.

Returns

Type	Description
string	The string? stored in the RealmValue.

implicit operator RealmValue(Decimal128)

Implicitly constructs a RealmValue from MongoDB.Bson.Decimal128.

Declaration

public static implicit operator RealmValue(Decimal128 val)

Parameters

Type	Name	Description
Decimal128	val	The value to store in the RealmValue.

Returns

Type	Description
RealmValue	A RealmValue containing the supplied val.

implicit operator RealmValue(ObjectId)

Implicitly constructs a RealmValue from MongoDB.Bson.ObjectId.

Declaration

public static implicit operator RealmValue(ObjectId val)

Parameters

Type	Name	Description
ObjectId	val	The value to store in the RealmValue.

Returns

Type	Description
RealmValue	A RealmValue containing the supplied val.

implicit operator RealmValue(RealmInteger<byte>)

Implicitly constructs a RealmValue from RealmInteger<byte>.

Declaration

public static implicit operator RealmValue(RealmInteger<byte> val)

Parameters

Type	Name	Description
RealmInteger<byte>	val	The value to store in the RealmValue.

Returns

Type	Description
RealmValue	A RealmValue containing the supplied val.

implicit operator RealmValue(RealmInteger<short>)

Implicitly constructs a RealmValue from RealmInteger<short>.

Declaration

public static implicit operator RealmValue(RealmInteger<short> val)

Parameters

Type	Name	Description
RealmInteger<short>	val	The value to store in the RealmValue.

Returns

Type	Description
RealmValue	A RealmValue containing the supplied val.

implicit operator RealmValue(RealmInteger<int>)

Implicitly constructs a RealmValue from RealmInteger<int>.

Declaration

public static implicit operator RealmValue(RealmInteger<int> val)

Parameters

Type	Name	Description
RealmInteger<int>	val	The value to store in the RealmValue.

Returns

Type	Description
RealmValue	A RealmValue containing the supplied val.

implicit operator RealmValue(RealmInteger<long>)

Implicitly constructs a RealmValue from RealmInteger<long>.

Declaration

public static implicit operator RealmValue(RealmInteger<long> val)

Parameters

Type	Name	Description
RealmInteger<long>	val	The value to store in the RealmValue.

Returns

Type	Description
RealmValue	A RealmValue containing the supplied val.

implicit operator RealmValue(RealmObjectBase?)

Implicitly constructs a RealmValue from RealmObjectBase?.

Declaration

public static implicit operator RealmValue(RealmObjectBase? val)

Parameters

Type	Name	Description
RealmObjectBase	val	The value to store in the RealmValue.

Returns

Type	Description
RealmValue	A RealmValue containing the supplied val.

implicit operator RealmValue(RealmValue[]?)

Implicitly constructs a RealmValue from RealmValue[]?.

Declaration

public static implicit operator RealmValue(RealmValue[]? val)

Parameters

Type	Name	Description
RealmValue[]	val	The value to store in the RealmValue.

Returns

Type	Description
RealmValue	A RealmValue containing the supplied val.

implicit operator RealmValue(bool)

Implicitly constructs a RealmValue from bool.

Declaration

public static implicit operator RealmValue(bool val)

Parameters

Type	Name	Description
bool	val	The value to store in the RealmValue.

Returns

Type	Description
RealmValue	A RealmValue containing the supplied val.

implicit operator RealmValue(byte)

Implicitly constructs a RealmValue from byte.

Declaration

public static implicit operator RealmValue(byte val)

Parameters

Type	Name	Description
byte	val	The value to store in the RealmValue.

Returns

Type	Description
RealmValue	A RealmValue containing the supplied val.

implicit operator RealmValue(byte[]?)

Implicitly constructs a RealmValue from byte[]?.

Declaration

public static implicit operator RealmValue(byte[]? val)

Parameters

Type	Name	Description
byte[]	val	The value to store in the RealmValue.

Returns

Type	Description
RealmValue	A RealmValue containing the supplied val.

implicit operator RealmValue(char)

Implicitly constructs a RealmValue from char.

Declaration

public static implicit operator RealmValue(char val)

Parameters

Type	Name	Description
char	val	The value to store in the RealmValue.

Returns

Type	Description
RealmValue	A RealmValue containing the supplied val.

implicit operator RealmValue(Dictionary<string, RealmValue>?)

Implicitly constructs a RealmValue from Dictionary<string, RealmValue>.

Declaration

public static implicit operator RealmValue(Dictionary<string, RealmValue>? val)

Parameters

Type	Name	Description
Dictionary<string, RealmValue>	val	The value to store in the RealmValue.

Returns

Type	Description
RealmValue	A RealmValue containing the supplied val.

implicit operator RealmValue(List<RealmValue>?)

Implicitly constructs a RealmValue from List<RealmValue>?.

Declaration

public static implicit operator RealmValue(List<RealmValue>? val)

Parameters

Type	Name	Description
List<RealmValue>	val	The value to store in the RealmValue.

Returns

Type	Description
RealmValue	A RealmValue containing the supplied val.

implicit operator RealmValue(DateTimeOffset)

Implicitly constructs a RealmValue from DateTimeOffset.

Declaration

public static implicit operator RealmValue(DateTimeOffset val)

Parameters

Type	Name	Description
DateTimeOffset	val	The value to store in the RealmValue.

Returns

Type	Description
RealmValue	A RealmValue containing the supplied val.

implicit operator RealmValue(decimal)

Implicitly constructs a RealmValue from decimal.

Declaration

public static implicit operator RealmValue(decimal val)

Parameters

Type	Name	Description
decimal	val	The value to store in the RealmValue.

Returns

Type	Description
RealmValue	A RealmValue containing the supplied val.

implicit operator RealmValue(double)

Implicitly constructs a RealmValue from double.

Declaration

public static implicit operator RealmValue(double val)

Parameters

Type	Name	Description
double	val	The value to store in the RealmValue.

Returns

Type	Description
RealmValue	A RealmValue containing the supplied val.

implicit operator RealmValue(Guid)

Implicitly constructs a RealmValue from Guid.

Declaration

public static implicit operator RealmValue(Guid val)

Parameters

Type	Name	Description
Guid	val	The value to store in the RealmValue.

Returns

Type	Description
RealmValue	A RealmValue containing the supplied val.

implicit operator RealmValue(short)

Implicitly constructs a RealmValue from short.

Declaration

public static implicit operator RealmValue(short val)

Parameters

Type	Name	Description
short	val	The value to store in the RealmValue.

Returns

Type	Description
RealmValue	A RealmValue containing the supplied val.

implicit operator RealmValue(int)

Implicitly constructs a RealmValue from int.

Declaration

public static implicit operator RealmValue(int val)

Parameters

Type	Name	Description
int	val	The value to store in the RealmValue.

Returns

Type	Description
RealmValue	A RealmValue containing the supplied val.

implicit operator RealmValue(long)

Implicitly constructs a RealmValue from long.

Declaration

public static implicit operator RealmValue(long val)

Parameters

Type	Name	Description
long	val	The value to store in the RealmValue.

Returns

Type	Description
RealmValue	A RealmValue containing the supplied val.

implicit operator RealmValue(Decimal128?)

Implicitly constructs a RealmValue from Decimal128?.

Declaration

public static implicit operator RealmValue(Decimal128? val)

Parameters

Type	Name	Description
Decimal128?	val	The value to store in the RealmValue.

Returns

Type	Description
RealmValue	A RealmValue containing the supplied val.

implicit operator RealmValue(ObjectId?)

Implicitly constructs a RealmValue from ObjectId?.

Declaration

public static implicit operator RealmValue(ObjectId? val)

Parameters

Type	Name	Description
ObjectId?	val	The value to store in the RealmValue.

Returns

Type	Description
RealmValue	A RealmValue containing the supplied val.

implicit operator RealmValue(RealmInteger<byte>?)

Implicitly constructs a RealmValue from RealmInteger<byte>?.

Declaration

public static implicit operator RealmValue(RealmInteger<byte>? val)

Parameters

Type	Name	Description
RealmInteger<byte>?	val	The value to store in the RealmValue.

Returns

Type	Description
RealmValue	A RealmValue containing the supplied val.

implicit operator RealmValue(RealmInteger<short>?)

Implicitly constructs a RealmValue from RealmInteger<short>?.

Declaration

public static implicit operator RealmValue(RealmInteger<short>? val)

Parameters

Type	Name	Description
RealmInteger<short>?	val	The value to store in the RealmValue.

Returns

Type	Description
RealmValue	A RealmValue containing the supplied val.

implicit operator RealmValue(RealmInteger<int>?)

Implicitly constructs a RealmValue from RealmInteger<int>?.

Declaration

public static implicit operator RealmValue(RealmInteger<int>? val)

Parameters

Type	Name	Description
RealmInteger<int>?	val	The value to store in the RealmValue.

Returns

Type	Description
RealmValue	A RealmValue containing the supplied val.

implicit operator RealmValue(RealmInteger<long>?)

Implicitly constructs a RealmValue from RealmInteger<long>?.

Declaration

public static implicit operator RealmValue(RealmInteger<long>? val)

Parameters

Type	Name	Description
RealmInteger<long>?	val	The value to store in the RealmValue.

Returns

Type	Description
RealmValue	A RealmValue containing the supplied val.

implicit operator RealmValue(bool?)

Implicitly constructs a RealmValue from bool?.

Declaration

public static implicit operator RealmValue(bool? val)

Parameters

Type	Name	Description
bool?	val	The value to store in the RealmValue.

Returns

Type	Description
RealmValue	A RealmValue containing the supplied val.

implicit operator RealmValue(byte?)

Implicitly constructs a RealmValue from byte?.

Declaration

public static implicit operator RealmValue(byte? val)

Parameters

Type	Name	Description
byte?	val	The value to store in the RealmValue.

Returns

Type	Description
RealmValue	A RealmValue containing the supplied val.

implicit operator RealmValue(char?)

Implicitly constructs a RealmValue from char?.

Declaration

public static implicit operator RealmValue(char? val)

Parameters

Type	Name	Description
char?	val	The value to store in the RealmValue.

Returns

Type	Description
RealmValue	A RealmValue containing the supplied val.

implicit operator RealmValue(DateTimeOffset?)

Implicitly constructs a RealmValue from DateTimeOffset?.

Declaration

public static implicit operator RealmValue(DateTimeOffset? val)

Parameters

Type	Name	Description
DateTimeOffset?	val	The value to store in the RealmValue.

Returns

Type	Description
RealmValue	A RealmValue containing the supplied val.

implicit operator RealmValue(decimal?)

Implicitly constructs a RealmValue from decimal?.

Declaration

public static implicit operator RealmValue(decimal? val)

Parameters

Type	Name	Description
decimal?	val	The value to store in the RealmValue.

Returns

Type	Description
RealmValue	A RealmValue containing the supplied val.

implicit operator RealmValue(double?)

Implicitly constructs a RealmValue from double?.

Declaration

public static implicit operator RealmValue(double? val)

Parameters

Type	Name	Description
double?	val	The value to store in the RealmValue.

Returns

Type	Description
RealmValue	A RealmValue containing the supplied val.

implicit operator RealmValue(Guid?)

Implicitly constructs a RealmValue from Guid?.

Declaration

public static implicit operator RealmValue(Guid? val)

Parameters

Type	Name	Description
Guid?	val	The value to store in the RealmValue.

Returns

Type	Description
RealmValue	A RealmValue containing the supplied val.

implicit operator RealmValue(short?)

Implicitly constructs a RealmValue from short?.

Declaration

public static implicit operator RealmValue(short? val)

Parameters

Type	Name	Description
short?	val	The value to store in the RealmValue.

Returns

Type	Description
RealmValue	A RealmValue containing the supplied val.

implicit operator RealmValue(int?)

Implicitly constructs a RealmValue from int?.

Declaration

public static implicit operator RealmValue(int? val)

Parameters

Type	Name	Description
int?	val	The value to store in the RealmValue.

Returns

Type	Description
RealmValue	A RealmValue containing the supplied val.

implicit operator RealmValue(long?)

Implicitly constructs a RealmValue from long?.

Declaration

public static implicit operator RealmValue(long? val)

Parameters

Type	Name	Description
long?	val	The value to store in the RealmValue.

Returns

Type	Description
RealmValue	A RealmValue containing the supplied val.

implicit operator RealmValue(float?)

Implicitly constructs a RealmValue from float?.

Declaration

public static implicit operator RealmValue(float? val)

Parameters

Type	Name	Description
float?	val	The value to store in the RealmValue.

Returns

Type	Description
RealmValue	A RealmValue containing the supplied val.

implicit operator RealmValue(float)

Implicitly constructs a RealmValue from float.

Declaration

public static implicit operator RealmValue(float val)

Parameters

Type	Name	Description
float	val	The value to store in the RealmValue.

Returns

Type	Description
RealmValue	A RealmValue containing the supplied val.

implicit operator RealmValue(string?)

Implicitly constructs a RealmValue from string?.

Declaration

public static implicit operator RealmValue(string? val)

Parameters

Type	Name	Description
string	val	The value to store in the RealmValue.

Returns

Type	Description
RealmValue	A RealmValue containing the supplied val.

operator !=(RealmValue, RealmValue)

Compares two RealmValue instances for inequality.

Declaration

public static bool operator !=(RealmValue left, RealmValue right)

Parameters

Type	Name	Description
RealmValue	left	The left instance.
RealmValue	right	The right instance.

Returns

Type	Description
bool	true if the underlying values stored in both instances are not equal; false otherwise.

Implements

IEquatable<T>