Class PropertyValue

Definition

Namespace:

Tizen.NUI

Assembly:

Tizen.NUI.dll

A value-type representing a property value.

public class PropertyValue : Disposable

Inheritance

object

Disposable

PropertyValue

Constructors

PropertyValue()

The default constructor of PropertyValue class.

Declaration

public PropertyValue()

PropertyValue(bool)

Creates a boolean property value.

Declaration

public PropertyValue(bool boolValue)

Parameters

Type	Name	Description
bool	boolValue	A boolean value.

PropertyValue(int)

Creates an integer property value.

Declaration

public PropertyValue(int integerValue)

Parameters

Type	Name	Description
int	integerValue	An integer value.

PropertyValue(float)

Creates a float property value.

Declaration

public PropertyValue(float floatValue)

Parameters

Type	Name	Description
float	floatValue	A floating-point value.

PropertyValue(string)

Creates a string property value.

Declaration

public PropertyValue(string stringValue)

Parameters

Type	Name	Description
string	stringValue	A string.

PropertyValue(Color)

Creates a Color property value.

Declaration

public PropertyValue(Color vectorValue)

Parameters

Type	Name	Description
Color	vectorValue	Color values.

PropertyValue(Extents)

Creates a Extents value.

Declaration

public PropertyValue(Extents extentsValue)

Parameters

Type	Name	Description
Extents	extentsValue	A Extents value.

PropertyValue(Position)

Creates a Position property value.

Declaration

public PropertyValue(Position vectorValue)

Parameters

Type	Name	Description
Position	vectorValue	Position values.

PropertyValue(Position2D)

Creates a Position2D property value.

Declaration

public PropertyValue(Position2D vectorValue)

Parameters

Type	Name	Description
Position2D	vectorValue	Position2D values.

PropertyValue(PropertyArray)

Creates an array property value.

Declaration

public PropertyValue(PropertyArray arrayValue)

Parameters

Type	Name	Description
PropertyArray	arrayValue	An array.

PropertyValue(PropertyMap)

Creates a map property value.

Declaration

public PropertyValue(PropertyMap mapValue)

Parameters

Type	Name	Description
PropertyMap	mapValue	An array.

PropertyValue(PropertyType)

Creates a PropertyType value.

Declaration

public PropertyValue(PropertyType type)

Parameters

Type	Name	Description
PropertyType	type	A PropertyType value.

PropertyValue(PropertyValue)

Creates a PropertyValue value.

Declaration

public PropertyValue(PropertyValue value)

Parameters

Type	Name	Description
PropertyValue	value	A PropertyValue value.

PropertyValue(Rectangle)

Creates a Rectangle property value.

Declaration

public PropertyValue(Rectangle vectorValue)

Parameters

Type	Name	Description
Rectangle	vectorValue	Rectangle values.

PropertyValue(Rotation)

Creates a Rotation property value.

Declaration

public PropertyValue(Rotation quaternion)

Parameters

Type	Name	Description
Rotation	quaternion	Rotation values.

PropertyValue(Size2D)

Creates a Size2D property value.

Declaration

public PropertyValue(Size2D vectorValue)

Parameters

Type	Name	Description
Size2D	vectorValue	Size2D values.

PropertyValue(Vector2)

Creates a Vector2 property value.

Declaration

public PropertyValue(Vector2 vectorValue)

Parameters

Type	Name	Description
Vector2	vectorValue	A vector of 2 floating-point values.

PropertyValue(Vector3)

Creates a Vector3 property value.

Declaration

public PropertyValue(Vector3 vectorValue)

Parameters

Type	Name	Description
Vector3	vectorValue	A vector of 3 floating-point values.

PropertyValue(Vector4)

Creates a Vector4 property value.

Declaration

public PropertyValue(Vector4 vectorValue)

Parameters

Type	Name	Description
Vector4	vectorValue	A vector of 4 floating-point values.

Methods

CreateFromObject(Object)

An extension to the property value class that allows us to create a Property value from a C# object, for example, integer, float, or string.

Declaration

public static PropertyValue CreateFromObject(System.Object obj)

Parameters

Type	Name	Description
object	obj	An object to create.

Returns

Type	Description
PropertyValue	The created value.

Dispose(bool)

Hidden API (Inhouse API). Dispose.

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing	true in order to free managed objects

Overrides

Disposable.Dispose(bool)

Remarks

Following the guide of https://docs.microsoft.com/en-us/dotnet/standard/garbage-collection/implementing-dispose. This will replace "protected virtual void Dispose(DisposeTypes type)" which is exactly same in functionality.

EqualTo(PropertyValue)

Determines whether the ProperyValue has equal value with the current ProperyValue.

Declaration

public bool EqualTo(PropertyValue rhs)

Parameters

Type	Name	Description
PropertyValue	rhs	The ProperyValue to compare with the current ProperyValue.

Returns

Type	Description
bool	true if the specified ProperyValue is equal to the current ProperyValue; otherwise, false.

Remarks

Equal only if same type. PropertyArray and PropertyMap don't have EqaulTo method. In that case, always return false. EqualTo API consider absolute/relative error internally.

Get(out bool)

Retrieves a boolean value.

Declaration

public bool Get(out bool boolValue)

Parameters

Type	Name	Description
bool	boolValue	On return, a boolean value.

Returns

Type	Description
bool	Returns true if the value is successfully retrieved, false if the type is not convertible.

Get(out int)

Retrieves an integer value.

Declaration

public bool Get(out int integerValue)

Parameters

Type	Name	Description
int	integerValue	On return, an integer value.

Returns

Type	Description
bool	Returns true if the value is successfully retrieved, false if the type is not convertible.

Get(out float)

Retrieves a floating-point value.

Declaration

public bool Get(out float floatValue)

Parameters

Type	Name	Description
float	floatValue	On return, a floating-point value.

Returns

Type	Description
bool	Returns true if the value is successfully retrieved, false if the type is not convertible.

Get(out string)

Retrieves a string property value.

Declaration

public bool Get(out string stringValue)

Parameters

Type	Name	Description
string	stringValue	On return, a string.

Returns

Type	Description
bool	Returns true if the value is successfully retrieved, false if the type is not convertible.

Get(Color)

Retrieves a Color value.

Declaration

public bool Get(Color vectorValue)

Parameters

Type	Name	Description
Color	vectorValue	On return, a color value.

Returns

Type	Description
bool

Get(Extents)

Retrieves a Extents value.

Declaration

public bool Get(Extents extentsValue)

Parameters

Type	Name	Description
Extents	extentsValue	On return, a extents.

Returns

Type	Description
bool	Returns true if the value is successfully retrieved, false if the type is not convertible.

Get(Position)

Retrieves a Position value.

Declaration

public bool Get(Position vectorValue)

Parameters

Type	Name	Description
Position	vectorValue	On return, a position value.

Returns

Type	Description
bool

Get(Position2D)

Retrieves a Position2D value.

Declaration

public bool Get(Position2D vectorValue)

Parameters

Type	Name	Description
Position2D	vectorValue	On return, a Position2D value.

Returns

Type	Description
bool

Get(PropertyArray)

Retrieves an array property value.

Declaration

public bool Get(PropertyArray arrayValue)

Parameters

Type	Name	Description
PropertyArray	arrayValue	On return, the array as a vector property values.

Returns

Type	Description
bool	Returns true if the value is successfully retrieved, false if the type is not convertible.

Get(PropertyMap)

Retrieves a map property value.

Declaration

public bool Get(PropertyMap mapValue)

Parameters

Type	Name	Description
PropertyMap	mapValue	On return, the map as vector of string and property value pairs.

Returns

Type	Description
bool	Returns true if the value is successfully retrieved, false if the type is not convertible.

Get(ref PropertyMap)

Retrieves a map property value.

Declaration

public bool Get(ref PropertyMap mapValue)

Parameters

Type	Name	Description
PropertyMap	mapValue	On return, the map as vector of string and property value pairs.

Returns

Type	Description
bool	Returns true if the value is successfully retrieved, false if the type is not convertible.

Get(Rectangle)

Retrieves an integer rectangle.

Declaration

public bool Get(Rectangle rect)

Parameters

Type	Name	Description
Rectangle	rect	On return, an integer rectangle.

Returns

Type	Description
bool	Returns true if the value is successfully retrieved, false if the type is not convertible.

Get(RelativeVector2)

Retrieves a vector value.

Declaration

public bool Get(RelativeVector2 vectorValue)

Parameters

Type	Name	Description
RelativeVector2	vectorValue	On return, a vector value.

Returns

Type	Description
bool	Returns true if the value is successfully retrieved, false if the type is not convertible.

Get(RelativeVector3)

Retrieves a vector value.

Declaration

public bool Get(RelativeVector3 vectorValue)

Parameters

Type	Name	Description
RelativeVector3	vectorValue	On return, a vector value.

Returns

Type	Description
bool	Returns true if the value is successfully retrieved, false if the type is not convertible.

Get(RelativeVector4)

Retrieves a vector value.

Declaration

public bool Get(RelativeVector4 vectorValue)

Parameters

Type	Name	Description
RelativeVector4	vectorValue	On return, a vector value.

Returns

Type	Description
bool	Returns true if the value is successfully retrieved, false if the type is not convertible.

Get(Rotation)

Retrieves a rotation value.

Declaration

public bool Get(Rotation quaternionValue)

Parameters

Type	Name	Description
Rotation	quaternionValue	On return, a rotation value.

Returns

Type	Description
bool	Returns true if the value is successfully retrieved, false if the type is not convertible.

Get(Size)

Retrieves a Size value.

Declaration

public bool Get(Size vectorValue)

Parameters

Type	Name	Description
Size	vectorValue	On return, a size value.

Returns

Type	Description
bool

Get(Size2D)

Retrieves a Size2D value.

Declaration

public bool Get(Size2D vectorValue)

Parameters

Type	Name	Description
Size2D	vectorValue	On return, a Size2D value.

Returns

Type	Description
bool

Get(Vector2)

Retrieves a vector value.

Declaration

public bool Get(Vector2 vectorValue)

Parameters

Type	Name	Description
Vector2	vectorValue	On return, a vector value.

Returns

Type	Description
bool	Returns true if the value is successfully retrieved, false if the type is not convertible.

Get(Vector3)

Retrieves a vector value.

Declaration

public bool Get(Vector3 vectorValue)

Parameters

Type	Name	Description
Vector3	vectorValue	On return, a vector value.

Returns

Type	Description
bool	Returns true if the value is successfully retrieved, false if the type is not convertible.

Get(Vector4)

Retrieves a vector value.

Declaration

public bool Get(Vector4 vectorValue)

Parameters

Type	Name	Description
Vector4	vectorValue	On return, a vector value.

Returns

Type	Description
bool	Returns true if the value is successfully retrieved, false if the type is not convertible.

GetType()

Queries the type of this property value.

Declaration

public PropertyType GetType()

Returns

Type	Description
PropertyType	The type ID

NotEqualTo(PropertyValue)

Determines whether the ProperyValue doesn't have equal value with the current ProperyValue.

Declaration

public bool NotEqualTo(PropertyValue rhs)

Parameters

Type	Name	Description
PropertyValue	rhs	The ProperyValue to compare with the current ProperyValue.

Returns

Type	Description
bool	true if the specified ProperyValue is not equal to the current ProperyValue; otherwise, false.

Remarks

Same as !EqualTo(rhs);

ReleaseSwigCPtr(HandleRef)

Declaration

protected override void ReleaseSwigCPtr(System.Runtime.InteropServices.HandleRef swigCPtr)

Parameters

Type	Name	Description
System.Runtime.InteropServices.HandleRef	swigCPtr

Overrides

Disposable.ReleaseSwigCPtr(System.Runtime.InteropServices.HandleRef)

Extension Methods

EXamlExtensions.LoadFromEXamlByRelativePath<T>(T, string)

Extensions.LoadFromXaml<TXaml>(TXaml, string)

Extensions.LoadFromXaml<TXaml>(TXaml, Type)

Extensions.LoadFromXamlFile<TXaml>(TXaml, string)