Class WidgetView

Definition

Namespace:

Tizen.NUI

Assembly:

Tizen.NUI.dll

The WidgetView is a class for displaying the widget image and controlling the widget.
Input events that the WidgetView gets are delivered to the widget.

public class WidgetView : View, IDisposable

Inheritance

object

BaseHandle

Animatable

Container

View

WidgetView

Implements

System.IDisposable

Constructors

WidgetView(string, string, int, int, float)

Creates a new WidgetView.

Declaration

public WidgetView(string widgetId, string contentInfo, int width, int height, float updatePeriod)

Parameters

Type	Name	Description
string	widgetId
string	contentInfo
int	width
int	height
float	updatePeriod

Properties

ContentInfo

Gets the content info.

Declaration

public string ContentInfo { get; }

Property Value

Type	Description
string

Effect

Gets or sets effect.

Declaration

public PropertyMap Effect { get; set; }

Property Value

Type	Description
PropertyMap

InstanceID

Gets the ID of the instance.

Declaration

public string InstanceID { get; }

Property Value

Type	Description
string

LoadingText

Gets or sets the loading text.

Declaration

public bool LoadingText { get; set; }

Property Value

Type	Description
bool

PermanentDelete

Gets or sets whether the widget is to delete permanently or not.

Declaration

public bool PermanentDelete { get; set; }

Property Value

Type	Description
bool

Preview

Gets or sets the preview.

Declaration

public bool Preview { get; set; }

Property Value

Type	Description
bool

RetryText

Gets or sets retry text.

Declaration

public PropertyMap RetryText { get; set; }

Property Value

Type	Description
PropertyMap

Title

Gets the title.

Declaration

public string Title { get; }

Property Value

Type	Description
string

UpdatePeriod

Gets the update peroid.

Declaration

public float UpdatePeriod { get; }

Property Value

Type	Description
float

WidgetID

Gets the ID of the widget.

Declaration

public string WidgetID { get; }

Property Value

Type	Description
string

WidgetStateFaulted

Gets or sets whether the widget state is faulted or not.

Declaration

public bool WidgetStateFaulted { get; set; }

Property Value

Type	Description
bool

Methods

ActivateFaultedWidget()

Activates a widget in the faulted state. A widget in faulted state must be activated before adding the widget.

Declaration

public void ActivateFaultedWidget()

CancelTouchEvent()

Cancels the touch event procedure. If you call this function after feed the touch down event, the widget will get ON_HOLD events. If a widget gets ON_HOLD event, it will not do anything even if you feed touch up event.

Declaration

public bool CancelTouchEvent()

Returns

Type	Description
bool	True on success, false otherwise.

Dispose(DisposeTypes)

To make the Button instance be disposed.

Declaration

protected override void Dispose(DisposeTypes type)

Parameters

Type	Name	Description
DisposeTypes	type

Overrides

View.Dispose(DisposeTypes)

PauseWidget()

Pauses a given widget.

Declaration

public bool PauseWidget()

Returns

Type	Description
bool	True on success, false otherwise.

ResumeWidget()

Resumes a given widget.

Declaration

public bool ResumeWidget()

Returns

Type	Description
bool	True on success, false otherwise.

TerminateWidget()

Terminate a widget instance.

Declaration

public bool TerminateWidget()

Returns

Type	Description
bool	True on success, false otherwise

Events

WidgetAdded

An event for the ResourceReady signal which can be used to subscribe or unsubscribe the event handler.
This signal is emitted after all resources required by a control are loaded and ready.
Most resources are only loaded when the control is placed on the stage.

Declaration

public event EventHandler<WidgetView.WidgetViewEventArgs> WidgetAdded

Event Type

Type	Description
EventHandler<><WidgetViewEventArgs>

WidgetContentUpdated

An event for the ResourceReady signal which can be used to subscribe or unsubscribe the event handler.
This signal is emitted after all resources required by a control are loaded and ready.
Most resources are only loaded when the control is placed on the stage.

Declaration

public event EventHandler<WidgetView.WidgetViewEventArgs> WidgetContentUpdated

Event Type

Type	Description
EventHandler<><WidgetViewEventArgs>

WidgetCreationAborted

An event for the ResourceReady signal which can be used to subscribe or unsubscribe the event handler.
This signal is emitted after all resources required by a control are loaded and ready.
Most resources are only loaded when the control is placed on the stage.

Declaration

public event EventHandler<WidgetView.WidgetViewEventArgs> WidgetCreationAborted

Event Type

Type	Description
EventHandler<><WidgetViewEventArgs>

WidgetDeleted

An event for the ResourceReady signal which can be used to subscribe or unsubscribe the event handler.
This signal is emitted after all resources required by a control are loaded and ready.
Most resources are only loaded when the control is placed on the stage.

Declaration

public event EventHandler<WidgetView.WidgetViewEventArgs> WidgetDeleted

Event Type

Type	Description
EventHandler<><WidgetViewEventArgs>

WidgetFaulted

An event for the ResourceReady signal which can be used to subscribe or unsubscribe the event handler.
This signal is emitted after all resources required by a control are loaded and ready.
Most resources are only loaded when the control is placed on the stage.

Declaration

public event EventHandler<WidgetView.WidgetViewEventArgs> WidgetFaulted

Event Type

Type	Description
EventHandler<><WidgetViewEventArgs>

WidgetUpdatePeriodChanged

An event for the ResourceReady signal which can be used to subscribe or unsubscribe the event handler.
This signal is emitted after all resources required by a control are loaded and ready.
Most resources are only loaded when the control is placed on the stage.

Declaration

public event EventHandler<WidgetView.WidgetViewEventArgs> WidgetUpdatePeriodChanged

Event Type

Type	Description
EventHandler<><WidgetViewEventArgs>

Implements

System.IDisposable