Class PropertyValue

Definition

Namespace:
Tizen.NUI
Assembly:
Tizen.NUI.dll
API Level:
3

A value-type representing a property value.

C#
Copy
public class PropertyValue : Disposable
Inheritance
PropertyValue

Constructors

View Source

PropertyValue()

The default constructor.

Declaration
C#
Copy
public PropertyValue()
API Level: 3
View Source

PropertyValue(Boolean)

Creates a boolean property value.

Declaration
C#
Copy
public PropertyValue(bool boolValue)
Parameters
Type Name Description
Boolean boolValue

A boolean value.

API Level: 3
View Source

PropertyValue(Int32)

Creates an integer property value.

Declaration
C#
Copy
public PropertyValue(int integerValue)
Parameters
Type Name Description
Int32 integerValue

An integer value.

API Level: 3
View Source

PropertyValue(Single)

Creates a float property value.

Declaration
C#
Copy
public PropertyValue(float floatValue)
Parameters
Type Name Description
Single floatValue

A floating-point value.

API Level: 3
View Source

PropertyValue(String)

Creates a string property value.

Declaration
C#
Copy
public PropertyValue(string stringValue)
Parameters
Type Name Description
String stringValue

A string.

API Level: 3
View Source

PropertyValue(Color)

Creates a Color property value.

Declaration
C#
Copy
public PropertyValue(Color vectorValue)
Parameters
Type Name Description
Color vectorValue

Color values.

API Level: 3
View Source

PropertyValue(Extents)

Creates a Extents value.

Declaration
C#
Copy
public PropertyValue(Extents extentsValue)
Parameters
Type Name Description
Extents extentsValue

A Extents value.

API Level: 4
View Source

PropertyValue(Position)

Creates a Position property value.

Declaration
C#
Copy
public PropertyValue(Position vectorValue)
Parameters
Type Name Description
Position vectorValue

Position values.

API Level: 3
View Source

PropertyValue(Position2D)

Creates a Position2D property value.

Declaration
C#
Copy
public PropertyValue(Position2D vectorValue)
Parameters
Type Name Description
Position2D vectorValue

Position2D values.

API Level: 3
View Source

PropertyValue(PropertyArray)

Creates an array property value.

Declaration
C#
Copy
public PropertyValue(PropertyArray arrayValue)
Parameters
Type Name Description
PropertyArray arrayValue

An array.

API Level: 3
View Source

PropertyValue(PropertyMap)

Creates a map property value.

Declaration
C#
Copy
public PropertyValue(PropertyMap mapValue)
Parameters
Type Name Description
PropertyMap mapValue

An array.

API Level: 3
View Source

PropertyValue(PropertyType)

Creates a PropertyType value.

Declaration
C#
Copy
public PropertyValue(PropertyType type)
Parameters
Type Name Description
PropertyType type

A PropertyType value.

API Level: 3
View Source

PropertyValue(PropertyValue)

Creates a PropertyValue value.

Declaration
C#
Copy
public PropertyValue(PropertyValue value)
Parameters
Type Name Description
PropertyValue value

A PropertyValue value.

API Level: 3
View Source

PropertyValue(Rectangle)

Creates a Rectangle property value.

Declaration
C#
Copy
public PropertyValue(Rectangle vectorValue)
Parameters
Type Name Description
Rectangle vectorValue

Rectangle values.

API Level: 3
View Source

PropertyValue(Rotation)

Creates a Rotation property value.

Declaration
C#
Copy
public PropertyValue(Rotation quaternion)
Parameters
Type Name Description
Rotation quaternion

Rotation values.

API Level: 3
View Source

PropertyValue(Size2D)

Creates a Size2D property value.

Declaration
C#
Copy
public PropertyValue(Size2D vectorValue)
Parameters
Type Name Description
Size2D vectorValue

Size2D values.

API Level: 3
View Source

PropertyValue(Vector2)

Creates a Vector2 property value.

Declaration
C#
Copy
public PropertyValue(Vector2 vectorValue)
Parameters
Type Name Description
Vector2 vectorValue

A vector of 2 floating-point values.

API Level: 3
View Source

PropertyValue(Vector3)

Creates a Vector3 property value.

Declaration
C#
Copy
public PropertyValue(Vector3 vectorValue)
Parameters
Type Name Description
Vector3 vectorValue

A vector of 3 floating-point values.

API Level: 3
View Source

PropertyValue(Vector4)

Creates a Vector4 property value.

Declaration
C#
Copy
public PropertyValue(Vector4 vectorValue)
Parameters
Type Name Description
Vector4 vectorValue

A vector of 4 floating-point values.

API Level: 3

Methods

View Source

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
C#
Copy
public static PropertyValue CreateFromObject(Object obj)
Parameters
Type Name Description
Tizen.System.Object obj

An object to create.

Returns
Type Description
PropertyValue

The created value.

API Level: 3
View Source

Dispose(Boolean)

Hidden API (Inhouse API). Dispose.

Declaration
C#
Copy
protected override void Dispose(bool disposing)
Parameters
Type Name Description
Boolean disposing

true in order to free managed objects

Overrides
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.

View Source

EqualTo(PropertyValue)

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

Declaration
C#
Copy
public bool EqualTo(PropertyValue rhs)
Parameters
Type Name Description
PropertyValue rhs

The ProperyValue to compare with the current ProperyValue.

Returns
Type Description
Boolean

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.

View Source

Get(out Boolean)

Retrieves a boolean value.

Declaration
C#
Copy
public bool Get(out bool boolValue)
Parameters
Type Name Description
Boolean boolValue

On return, a boolean value.

Returns
Type Description
Boolean

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

API Level: 3
View Source

Get(out Int32)

Retrieves an integer value.

Declaration
C#
Copy
public bool Get(out int integerValue)
Parameters
Type Name Description
Int32 integerValue

On return, an integer value.

Returns
Type Description
Boolean

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

API Level: 3
View Source

Get(out Single)

Retrieves a floating-point value.

Declaration
C#
Copy
public bool Get(out float floatValue)
Parameters
Type Name Description
Single floatValue

On return, a floating-point value.

Returns
Type Description
Boolean

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

API Level: 3
View Source

Get(out String)

Retrieves a string property value.

Declaration
C#
Copy
public bool Get(out string stringValue)
Parameters
Type Name Description
String stringValue

On return, a string.

Returns
Type Description
Boolean

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

API Level: 3
View Source

Get(Color)

Retrieves a Color value.

Declaration
C#
Copy
public bool Get(Color vectorValue)
Parameters
Type Name Description
Color vectorValue

On return, a color value.

Returns
Type Description
Boolean
API Level: 3
View Source

Get(Extents)

Retrieves a Extents value.

Declaration
C#
Copy
public bool Get(Extents extentsValue)
Parameters
Type Name Description
Extents extentsValue

On return, a extents.

Returns
Type Description
Boolean

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

API Level: 4
View Source

Get(Position)

Retrieves a Position value.

Declaration
C#
Copy
public bool Get(Position vectorValue)
Parameters
Type Name Description
Position vectorValue

On return, a position value.

Returns
Type Description
Boolean
API Level: 3
View Source

Get(Position2D)

Retrieves a Position2D value.

Declaration
C#
Copy
public bool Get(Position2D vectorValue)
Parameters
Type Name Description
Position2D vectorValue

On return, a Position2D value.

Returns
Type Description
Boolean
API Level: 3
View Source

Get(PropertyArray)

Retrieves an array property value.

Declaration
C#
Copy
public bool Get(PropertyArray arrayValue)
Parameters
Type Name Description
PropertyArray arrayValue

On return, the array as a vector property values.

Returns
Type Description
Boolean

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

API Level: 3
View Source

Get(PropertyMap)

Retrieves a map property value.

Declaration
C#
Copy
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
Boolean

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

API Level: 3
View Source

Get(ref PropertyMap)

Retrieves a map property value.

Declaration
C#
Copy
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
Boolean

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

View Source

Get(Rectangle)

Retrieves an integer rectangle.

Declaration
C#
Copy
public bool Get(Rectangle rect)
Parameters
Type Name Description
Rectangle rect

On return, an integer rectangle.

Returns
Type Description
Boolean

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

API Level: 3
View Source

Get(RelativeVector2)

Retrieves a vector value.

Declaration
C#
Copy
public bool Get(RelativeVector2 vectorValue)
Parameters
Type Name Description
RelativeVector2 vectorValue

On return, a vector value.

Returns
Type Description
Boolean

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

API Level: 5
View Source

Get(RelativeVector3)

Retrieves a vector value.

Declaration
C#
Copy
public bool Get(RelativeVector3 vectorValue)
Parameters
Type Name Description
RelativeVector3 vectorValue

On return, a vector value.

Returns
Type Description
Boolean

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

API Level: 5
View Source

Get(RelativeVector4)

Retrieves a vector value.

Declaration
C#
Copy
public bool Get(RelativeVector4 vectorValue)
Parameters
Type Name Description
RelativeVector4 vectorValue

On return, a vector value.

Returns
Type Description
Boolean

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

API Level: 5
View Source

Get(Rotation)

Retrieves a rotation value.

Declaration
C#
Copy
public bool Get(Rotation quaternionValue)
Parameters
Type Name Description
Rotation quaternionValue

On return, a rotation value.

Returns
Type Description
Boolean

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

API Level: 3
View Source

Get(Size)

Retrieves a Size value.

Declaration
C#
Copy
public bool Get(Size vectorValue)
Parameters
Type Name Description
Size vectorValue

On return, a size value.

Returns
Type Description
Boolean
View Source

Get(Size2D)

Retrieves a Size2D value.

Declaration
C#
Copy
public bool Get(Size2D vectorValue)
Parameters
Type Name Description
Size2D vectorValue

On return, a Size2D value.

Returns
Type Description
Boolean
API Level: 3
View Source

Get(Vector2)

Retrieves a vector value.

Declaration
C#
Copy
public bool Get(Vector2 vectorValue)
Parameters
Type Name Description
Vector2 vectorValue

On return, a vector value.

Returns
Type Description
Boolean

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

API Level: 3
View Source

Get(Vector3)

Retrieves a vector value.

Declaration
C#
Copy
public bool Get(Vector3 vectorValue)
Parameters
Type Name Description
Vector3 vectorValue

On return, a vector value.

Returns
Type Description
Boolean

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

API Level: 3
View Source

Get(Vector4)

Retrieves a vector value.

Declaration
C#
Copy
public bool Get(Vector4 vectorValue)
Parameters
Type Name Description
Vector4 vectorValue

On return, a vector value.

Returns
Type Description
Boolean

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

API Level: 3
View Source

GetType()

Queries the type of this property value.

Declaration
C#
Copy
public PropertyType GetType()
Returns
Type Description
PropertyType

The type ID

API Level: 3
View Source

NotEqualTo(PropertyValue)

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

Declaration
C#
Copy
public bool NotEqualTo(PropertyValue rhs)
Parameters
Type Name Description
PropertyValue rhs

The ProperyValue to compare with the current ProperyValue.

Returns
Type Description
Boolean

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

Remarks

Same as !EqualTo(rhs);

View Source

ReleaseSwigCPtr(Runtime.InteropServices.HandleRef)

Declaration
C#
Copy
protected override void ReleaseSwigCPtr(Runtime.InteropServices.HandleRef swigCPtr)
Parameters
Type Name Description
Tizen.System.Runtime.InteropServices.HandleRef swigCPtr
Overrides

Extension Methods