Class WidgetView

Definition

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

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, INotifyPropertyChanged, IDynamicResourceHandler, IElement, INameScope, IElementController, IDisposable, IResourcesProvider
Inheritance
Object
Tizen.NUI.Binding.BindableObject
Tizen.NUI.Binding.Element
BaseHandle
Animatable
Container
View
WidgetView
Implements
INotifyPropertyChanged
IDisposable

Constructors

View Source

WidgetView(String, String, Int32, Int32, Single)

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
Int32 width
Int32 height
Single updatePeriod
API Level: 3

Properties

View Source

ContentInfo

Gets the content info.

Declaration
public string ContentInfo { get; }
Property Value
Type Description
String
API Level: 3
View Source

Effect

Gets or sets effect.

Declaration
public PropertyMap Effect { get; set; }
Property Value
Type Description
PropertyMap
API Level: 4
View Source

InstanceID

Gets the ID of the instance.

Declaration
public string InstanceID { get; }
Property Value
Type Description
String
API Level: 3
View Source

LoadingText

Gets or sets the loading text.

Declaration
public bool LoadingText { get; set; }
Property Value
Type Description
Boolean
API Level: 3
View Source

PermanentDelete

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

Declaration
public bool PermanentDelete { get; set; }
Property Value
Type Description
Boolean
API Level: 3
View Source

Preview

Gets or sets the preview.

Declaration
public bool Preview { get; set; }
Property Value
Type Description
Boolean
API Level: 3
View Source

RetryText

Gets or sets retry text.

Declaration
public PropertyMap RetryText { get; set; }
Property Value
Type Description
PropertyMap
API Level: 4
View Source

Title

Gets the title.

Declaration
public string Title { get; }
Property Value
Type Description
String
API Level: 3
View Source

UpdatePeriod

Gets the update peroid.

Declaration
public float UpdatePeriod { get; }
Property Value
Type Description
Single
API Level: 3
View Source

WidgetID

Gets the ID of the widget.

Declaration
public string WidgetID { get; }
Property Value
Type Description
String
API Level: 3
View Source

WidgetStateFaulted

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

Declaration
public bool WidgetStateFaulted { get; set; }
Property Value
Type Description
Boolean
API Level: 3

Methods

View Source

ActivateFaultedWidget()

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

Declaration
public void ActivateFaultedWidget()
API Level: 3
View Source

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
Boolean

True on success, false otherwise.
API Level: 3
View Source

Dispose(DisposeTypes)

To make the Button instance be disposed.

Declaration
protected override void Dispose(DisposeTypes type)
Parameters
Type Name Description
DisposeTypes type
Overrides
API Level: 3
View Source

PauseWidget()

Pauses a given widget.

Declaration
public bool PauseWidget()
Returns
Type Description
Boolean

True on success, false otherwise.
API Level: 3
View Source

ResumeWidget()

Resumes a given widget.

Declaration
public bool ResumeWidget()
Returns
Type Description
Boolean

True on success, false otherwise.
API Level: 3
View Source

TerminateWidget()

Terminate a widget instance.

Declaration
public bool TerminateWidget()
Returns
Type Description
Boolean

True on success, false otherwise
API Level: 4

Events

View Source

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<WidgetView.WidgetViewEventArgs>
API Level: 3
View Source

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<WidgetView.WidgetViewEventArgs>
API Level: 3
View Source

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<WidgetView.WidgetViewEventArgs>
API Level: 3
View Source

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<WidgetView.WidgetViewEventArgs>
API Level: 3
View Source

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<WidgetView.WidgetViewEventArgs>
API Level: 3
View Source

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<WidgetView.WidgetViewEventArgs>
API Level: 3

Implements