Class BaseHandle

Definition

Namespace:

Tizen.NUI

Assembly:

Tizen.NUI.dll

BaseHandle is a handle to an internal Dali resource.

public class BaseHandle : Element, INotifyPropertyChanged, IDisposable

Inheritance

object

BindableObject

Element

BaseHandle

Derived

Animatable

Animation

Drawable

Gradient

DragAndDrop

FocusManager

FontClient

Geometry

Gesture

Hover

InputMethodContext

Key

KeyFrames

Path

PropertyBuffer

PropertyCondition

PropertyNotification

Sampler

MotionData

MotionIndex

MotionValue

ScrollViewEffect

StyleManager

TTSPlayer

Texture

TextureSet

Timer

Touch

TransitionData

TypeInfo

VertexBuffer

VisualBase

VisualFactory

Wheel

Widget

WidgetViewManager

Window

Implements

INotifyPropertyChanged

IDisposable

Remarks

Internal Dali resources with BaseHandle has reference count internally.
And Dali resources will release the object only if reference count become zero.
It mean, even we call Dispose(), the reousrce will not be released if some native has reference count.

Constructors

BaseHandle()

Create an instance of BaseHandle.

Declaration

public BaseHandle()

BaseHandle(BaseHandle)

Create an instance of BaseHandle.

Declaration

public BaseHandle(BaseHandle handle)

Parameters

Type	Name	Description
BaseHandle	handle	The BaseHandle instance.

Fields

disposed

The flag to check if it is already disposed of.

Declaration

[Obsolete("Deprecated in API9, will be removed in API11, Use Disposed")]
[SuppressMessage("Design", "CA1051:Do not declare visible instance fields", Justification = "<Pending>")]
protected bool disposed

Field Value

Type	Description
bool

swigCMemOwn

swigCMemOwn

Declaration

[Obsolete("Deprecated in API9, will be removed in API11, Use SwigCMemOwn")]
[SuppressMessage("Design", "CA1051:Do not declare visible instance fields", Justification = "<Pending>")]
protected bool swigCMemOwn

Field Value

Type	Description
bool

Methods

Dispose()

Dispose.

Declaration

public void Dispose()

Remarks

This method release only C# side objects. If someone hold BaseHandle at Native side
the object will not be removed until native side reset the handle.

Dispose(DisposeTypes)

Dispose. Releases unmanaged and optionally managed resources.

Declaration

protected virtual void Dispose(DisposeTypes type)

Parameters

Type	Name	Description
DisposeTypes	type	Explicit to release both managed and unmanaged resources. Implicit to release only unmanaged resources.

Remarks

When overriding this method, you need to distinguish between explicit and implicit conditions. For explicit conditions, release both managed and unmanaged resources. For implicit conditions, only release unmanaged resources.

DoAction(string, PropertyMap)

Performs an action on this object with the given action name and attributes.

Declaration

public bool DoAction(string actionName, PropertyMap attributes)

Parameters

Type	Name	Description
string	actionName	The command for the action.
PropertyMap	attributes	The list of attributes for the action.

Returns

Type	Description
bool	The action is performed by the object or not.

EqualTo(BaseHandle)

To check the BaseHandle instance is equal or not.

Declaration

public bool EqualTo(BaseHandle rhs)

Parameters

Type	Name	Description
BaseHandle	rhs	The baseHandle instance.

Returns

Type	Description
bool	True If equal.

Equals(object)

Compares the current instance with another object of the same type and returns true if they represent the same handle.

Declaration

public override bool Equals(object o)

Parameters

Type	Name	Description
object	o	The object to compare with the current instance.

Returns

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

Overrides

object.Equals(object)

~BaseHandle()

Finalizes the instance of the BaseHandle class. This method implements the finalization pattern for proper disposal of resources.

Declaration

protected ~BaseHandle()

GetHashCode()

Gets the hash code of this baseHandle.

Declaration

public override int GetHashCode()

Returns

Type	Description
int	The hash code.

Overrides

object.GetHashCode()

GetTypeInfo(TypeInfo)

Returns the type info for the Handle.

Declaration

public bool GetTypeInfo(TypeInfo info)

Parameters

Type	Name	Description
TypeInfo	info	The type information.

Returns

Type	Description
bool	True If get the type info.

GetTypeName()

Returns the type name for the Handle.
Will return an empty string if the typename does not exist. This will happen for types that have not registered with type-registry.

Declaration

public string GetTypeName()

Returns

Type	Description
string	The type name. Empty string if the typename does not exist.

HasBody()

To check the BaseHandle instance has body or not.

Declaration

public bool HasBody()

Returns

Type	Description
bool	True If the baseHandle instance has body.

IsEqual(BaseHandle)

To check the BaseHandle instance is equal or not.

Declaration

public bool IsEqual(BaseHandle rhs)

Parameters

Type	Name	Description
BaseHandle	rhs	The baseHandle instance.

Returns

Type	Description
bool	True If equal.

NotEqualTo(BaseHandle)

To check the BaseHandle instance is equal or not.

Declaration

public bool NotEqualTo(BaseHandle rhs)

Parameters

Type	Name	Description
BaseHandle	rhs	The baseHandle instance.

Returns

Type	Description
bool	True If not equal.

Reset()

Resets the handle.

Declaration

public void Reset()

Events

PropertySet

Event when a property is set.

Declaration

[Obsolete("Deprecated in API9, will be removed in API11, Use BindableObject.PropertyChanged instead.")]
public event PropertyChangedEventHandler PropertySet

Event Type

Type	Description
PropertyChangedEventHandler

See Also

PropertyChanged

Operators

operator &(BaseHandle, BaseHandle)

Logical AND operator. It's possible when doing a logical AND operation, this function (opBitwiseAnd) might never be called due to short circuiting.

Declaration

public static BaseHandle operator &(BaseHandle x, BaseHandle y)

Parameters

Type	Name	Description
BaseHandle	x	The first BaseHandle instance.
BaseHandle	y	The second BaseHandle instance.

Returns

Type	Description
BaseHandle	Returns the first BaseHandle instance if both instances are equal; otherwise, returns null.

operator |(BaseHandle, BaseHandle)

Logical OR operator for ||. It's possible when doing a || this function (opBitwiseOr) is never called due to short circuiting.

Declaration

public static BaseHandle operator |(BaseHandle x, BaseHandle y)

Parameters

Type	Name	Description
BaseHandle	x	The first BaseHandle to be compared.
BaseHandle	y	The second BaseHandle to be compared.

Returns

Type	Description
BaseHandle	A BaseHandle that contains either of the non-null bodies of the two operands.

operator ==(BaseHandle, BaseHandle)

Equality operator

Declaration

public static bool operator ==(BaseHandle x, BaseHandle y)

Parameters

Type	Name	Description
BaseHandle	x	The first BaseHandle instance to compare.
BaseHandle	y	The second BaseHandle instance to compare.

Returns

Type	Description
bool	true if both instances are equal; otherwise false.

explicit operator bool(BaseHandle)

Explicit conversion from Handle to bool.

Declaration

public static explicit operator bool(BaseHandle handle)

Parameters

Type	Name	Description
BaseHandle	handle

Returns

Type	Description
bool

operator false(BaseHandle)

Returns the bool false to indicate that an operand is false and returns true otherwise.

Declaration

public static bool operator false(BaseHandle handle)

Parameters

Type	Name	Description
BaseHandle	handle

Returns

Type	Description
bool

operator !=(BaseHandle, BaseHandle)

Inequality operator. Returns true if the operands are not equal, false otherwise. Returns true if either operand is null.

Declaration

public static bool operator !=(BaseHandle x, BaseHandle y)

Parameters

Type	Name	Description
BaseHandle	x	The first BaseHandle instance to compare.
BaseHandle	y	The second BaseHandle instance to compare.

Returns

Type	Description
bool	True if the operands are not equal, false otherwise. Returns true if either operand is null.

operator !(BaseHandle)

Logical ! operator for BaseHandle class.

Declaration

public static bool operator !(BaseHandle x)

Parameters

Type	Name	Description
BaseHandle	x	The BaseHandle instance to check.

Returns

Type	Description
bool	True if the handle is null or has no body; otherwise, false.

operator true(BaseHandle)

Returns the bool value true to indicate that an operand is true and returns false otherwise.

Declaration

public static bool operator true(BaseHandle handle)

Parameters

Type	Name	Description
BaseHandle	handle

Returns

Type	Description
bool

Implements

INotifyPropertyChanged

IDisposable