Class VisualBase

Definition

Namespace:

Tizen.NUI.Visuals

Assembly:

Tizen.NUI.dll

The base class of all visual in namespace Tizen.NUI.Visuals. This class is abstract class. We cannot use it without type of Properties.

public abstract class VisualBase : BaseHandle, IDynamicResourceHandler, INameScope, System.IDisposable

Inheritance

object

BindableObject

Element

BaseHandle

VisualBase

Derived

BorderVisual

BorderVisual

ColorVisual

ColorVisual

GradientVisual

GradientVisual

ImageVisual

ImageVisual

TextVisual

TextVisual

Implements

IDynamicResourceHandler

INameScope

System.IDisposable

Remarks

Visual is the smallest rendering unit that application can control without custom renderer. It will be used when we want to add a new visual to the View. We can change the size or offset of visuals, and sibling order.

When we change the property of visual, the visual will be recreated at end of event loop.

Properties

AliveCount

Gets the number of currently alived VisualBase object.

Declaration

public static int AliveCount { get; }

Property Value

Type	Description
int

Remarks

Visual is the smallest rendering unit that application can control without custom renderer. It will be used when we want to add a new visual to the View. We can change the size or offset of visuals, and sibling order.

When we change the property of visual, the visual will be recreated at end of event loop.

Color

Color for the visual. Default color is White

Declaration

public Color Color { get; set; }

Property Value

Type	Description
Color

Remarks

This is exclusive with the Opacity property. Opacity property be applied as Color.A.

ExtraHeight

Extra height of the visual as absolute policy.

Declaration

public float ExtraHeight { get; set; }

Property Value

Type	Description
float

Remarks

Visual is the smallest rendering unit that application can control without custom renderer. It will be used when we want to add a new visual to the View. We can change the size or offset of visuals, and sibling order.

When we change the property of visual, the visual will be recreated at end of event loop.

ExtraWidth

Extra width of the visual as absolute policy.

Declaration

public float ExtraWidth { get; set; }

Property Value

Type	Description
float

Remarks

Visual is the smallest rendering unit that application can control without custom renderer. It will be used when we want to add a new visual to the View. We can change the size or offset of visuals, and sibling order.

When we change the property of visual, the visual will be recreated at end of event loop.

FittingMode

FittingMode for the visual.

Declaration

public VisualFittingModeType FittingMode { get; set; }

Property Value

Type	Description
VisualFittingModeType

Remarks

The fitting mode is used to decide how the visual should be fitted to the control area. The default value is VisualFittingModeType.DontCare. If user set one of Transform property, it will be set as VisualFittingModeType.DontCare automatically.

Height

Height of the visual.

Declaration

public float Height { get; set; }

Property Value

Type	Description
float

Remarks

Visual is the smallest rendering unit that application can control without custom renderer. It will be used when we want to add a new visual to the View. We can change the size or offset of visuals, and sibling order.

When we change the property of visual, the visual will be recreated at end of event loop.

HeightPolicy

Policy of height. If it is Relative, The height will be relative by the View's height. If it is Absolute, The height will be used as the absolute Height value.

Declaration

public VisualTransformPolicyType HeightPolicy { get; set; }

Property Value

Type	Description
VisualTransformPolicyType

Remarks

Visual is the smallest rendering unit that application can control without custom renderer. It will be used when we want to add a new visual to the View. We can change the size or offset of visuals, and sibling order.

When we change the property of visual, the visual will be recreated at end of event loop.

Name

Name of the visual.

Declaration

public string Name { get; set; }

Property Value

Type	Description
string

Remarks

Visual is the smallest rendering unit that application can control without custom renderer. It will be used when we want to add a new visual to the View. We can change the size or offset of visuals, and sibling order.

When we change the property of visual, the visual will be recreated at end of event loop.

OffsetX

OffsetX of the visual.

Declaration

public float OffsetX { get; set; }

Property Value

Type	Description
float

Remarks

Visual is the smallest rendering unit that application can control without custom renderer. It will be used when we want to add a new visual to the View. We can change the size or offset of visuals, and sibling order.

When we change the property of visual, the visual will be recreated at end of event loop.

OffsetXPolicy

Policy of offsetX. If it is Relative, The offsetX will be relative by the View's width. If it is Absolute, The offsetX will be used as the absolute OffsetX value.

Declaration

public VisualTransformPolicyType OffsetXPolicy { get; set; }

Property Value

Type	Description
VisualTransformPolicyType

Remarks

Visual is the smallest rendering unit that application can control without custom renderer. It will be used when we want to add a new visual to the View. We can change the size or offset of visuals, and sibling order.

When we change the property of visual, the visual will be recreated at end of event loop.

OffsetY

OffsetY of the visual.

Declaration

public float OffsetY { get; set; }

Property Value

Type	Description
float

Remarks

Visual is the smallest rendering unit that application can control without custom renderer. It will be used when we want to add a new visual to the View. We can change the size or offset of visuals, and sibling order.

When we change the property of visual, the visual will be recreated at end of event loop.

OffsetYPolicy

Policy of offsetY. If it is Relative, The offsetY will be relative by the View's height. If it is Absolute, The offsetY will be used as the absolute OffsetY value.

Declaration

public VisualTransformPolicyType OffsetYPolicy { get; set; }

Property Value

Type	Description
VisualTransformPolicyType

Remarks

Visual is the smallest rendering unit that application can control without custom renderer. It will be used when we want to add a new visual to the View. We can change the size or offset of visuals, and sibling order.

When we change the property of visual, the visual will be recreated at end of event loop.

Opacity

Opacity for the visual.

Declaration

public float Opacity { get; set; }

Property Value

Type	Description
float

Remarks

This is exclusive with the Color property.

Origin

Origin of the visual from view.

Declaration

public Visual.AlignType Origin { get; set; }

Property Value

Type	Description
Visual.AlignType

Remarks

Visual is the smallest rendering unit that application can control without custom renderer. It will be used when we want to add a new visual to the View. We can change the size or offset of visuals, and sibling order.

When we change the property of visual, the visual will be recreated at end of event loop.

PivotPoint

Pivot point of the visual from view.

Declaration

public Visual.AlignType PivotPoint { get; set; }

Property Value

Type	Description
Visual.AlignType

Remarks

Visual is the smallest rendering unit that application can control without custom renderer. It will be used when we want to add a new visual to the View. We can change the size or offset of visuals, and sibling order.

When we change the property of visual, the visual will be recreated at end of event loop.

PropertyUpdateMode

The way of visual property update. Default is PropertyUpdateModeType.Auto.

Declaration

public VisualBase.PropertyUpdateModeType PropertyUpdateMode { get; set; }

Property Value

Type	Description
VisualBase.PropertyUpdateModeType

Remarks

Visual is the smallest rendering unit that application can control without custom renderer. It will be used when we want to add a new visual to the View. We can change the size or offset of visuals, and sibling order.

When we change the property of visual, the visual will be recreated at end of event loop.

SiblingOrder

Sibling order of this VisualBase.

Declaration

public uint SiblingOrder { get; set; }

Property Value

Type	Description
uint

Remarks

The sibling order is used to determine the draw order of the visuals. The visuals with smaller sibling order are drawn bottom, and the visuals with larger sibling order are drawn top.

It will be changed automatically when the visuals are added to the view. It is 0 before being added to the view.

Type

Type of this VisualObject. It will be set at construction time.

Declaration

public int Type { get; }

Property Value

Type	Description
int

Remarks

Visual is the smallest rendering unit that application can control without custom renderer. It will be used when we want to add a new visual to the View. We can change the size or offset of visuals, and sibling order.

When we change the property of visual, the visual will be recreated at end of event loop.

Width

Width of the visual.

Declaration

public float Width { get; set; }

Property Value

Type	Description
float

Remarks

Visual is the smallest rendering unit that application can control without custom renderer. It will be used when we want to add a new visual to the View. We can change the size or offset of visuals, and sibling order.

When we change the property of visual, the visual will be recreated at end of event loop.

WidthPolicy

Policy of width. If it is Relative, The width will be relative by the View's width. If it is Absolute, The width will be used as the absolute Width value.

Declaration

public VisualTransformPolicyType WidthPolicy { get; set; }

Property Value

Type	Description
VisualTransformPolicyType

Remarks

Visual is the smallest rendering unit that application can control without custom renderer. It will be used when we want to add a new visual to the View. We can change the size or offset of visuals, and sibling order.

When we change the property of visual, the visual will be recreated at end of event loop.

Methods

Detach()

Detach from View.

Declaration

public void Detach()

Remarks

Visual is the smallest rendering unit that application can control without custom renderer. It will be used when we want to add a new visual to the View. We can change the size or offset of visuals, and sibling order.

When we change the property of visual, the visual will be recreated at end of event loop.

Dispose(DisposeTypes)

Dispose for VisualObject

Declaration

protected override void Dispose(DisposeTypes type)

Parameters

Type	Name	Description
DisposeTypes	type

Overrides

BaseHandle.Dispose(DisposeTypes)

Remarks

Visual is the smallest rendering unit that application can control without custom renderer. It will be used when we want to add a new visual to the View. We can change the size or offset of visuals, and sibling order.

When we change the property of visual, the visual will be recreated at end of event loop.

GetOwner()

Get attached View.

Declaration

public View GetOwner()

Returns

Type	Description
View

Remarks

Visual is the smallest rendering unit that application can control without custom renderer. It will be used when we want to add a new visual to the View. We can change the size or offset of visuals, and sibling order.

When we change the property of visual, the visual will be recreated at end of event loop.

Lower()

Lower below the previous sibling visual object

Declaration

public void Lower()

Remarks

Visual is the smallest rendering unit that application can control without custom renderer. It will be used when we want to add a new visual to the View. We can change the size or offset of visuals, and sibling order.

When we change the property of visual, the visual will be recreated at end of event loop.

LowerBelow(VisualBase)

Lower below target visual objects. No effects if visual object is already below target.

Declaration

public void LowerBelow(VisualBase target)

Parameters

Type	Name	Description
VisualBase	target

Remarks

Visual is the smallest rendering unit that application can control without custom renderer. It will be used when we want to add a new visual to the View. We can change the size or offset of visuals, and sibling order.

When we change the property of visual, the visual will be recreated at end of event loop.

LowerToBottom()

Raise below all other sibling visual objects

Declaration

public void LowerToBottom()

Remarks

Visual is the smallest rendering unit that application can control without custom renderer. It will be used when we want to add a new visual to the View. We can change the size or offset of visuals, and sibling order.

When we change the property of visual, the visual will be recreated at end of event loop.

Raise()

Raise above the next sibling visual object

Declaration

public void Raise()

Remarks

Visual is the smallest rendering unit that application can control without custom renderer. It will be used when we want to add a new visual to the View. We can change the size or offset of visuals, and sibling order.

When we change the property of visual, the visual will be recreated at end of event loop.

RaiseAbove(VisualBase)

Raise above target visual objects. No effects if visual object is already above target.

Declaration

public void RaiseAbove(VisualBase target)

Parameters

Type	Name	Description
VisualBase	target

Remarks

Visual is the smallest rendering unit that application can control without custom renderer. It will be used when we want to add a new visual to the View. We can change the size or offset of visuals, and sibling order.

When we change the property of visual, the visual will be recreated at end of event loop.

RaiseToTop()

Raise above all other sibling visual objects

Declaration

public void RaiseToTop()

Remarks

Visual is the smallest rendering unit that application can control without custom renderer. It will be used when we want to add a new visual to the View. We can change the size or offset of visuals, and sibling order.

When we change the property of visual, the visual will be recreated at end of event loop.

UpdateProperty()

Update visual properties manually.

Declaration

public void UpdateProperty()

Remarks

Visual is the smallest rendering unit that application can control without custom renderer. It will be used when we want to add a new visual to the View. We can change the size or offset of visuals, and sibling order.

When we change the property of visual, the visual will be recreated at end of event loop.

Implements

IDynamicResourceHandler

INameScope

System.IDisposable

Extension Methods

BindableObjectExtensions.SetBinding(BindableObject, BindableProperty, string, BindingMode, IValueConverter, string)

NameScopeExtensions.FindByName<T>(Element, string)

EXamlExtensions.LoadFromEXamlByRelativePath<T>(T, string)

Extensions.LoadFromXaml<TXaml>(TXaml, string)

Extensions.LoadFromXaml<TXaml>(TXaml, Type)

Extensions.LoadFromXamlFile<TXaml>(TXaml, string)