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.

C#
Copy
public class WidgetView : View, INotifyPropertyChanged, IDynamicResourceHandler, IElement, INameScope, IElementController, IDisposable, IResourcesProvider
Inheritance
System.Object
Tizen.NUI.Binding.Element
WidgetView
Implements
System.ComponentModel.INotifyPropertyChanged
System.IDisposable

Constructors

View Source

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

Creates a new WidgetView.

Declaration
C#
Copy
public WidgetView(string widgetId, string contentInfo, int width, int height, float updatePeriod)
Parameters
Type Name Description
System.String widgetId
System.String contentInfo
Int32 width
Int32 height
System.Single updatePeriod
API Level: 3

Properties

View Source

ContentInfo

Gets the content info.

Declaration
C#
Copy
public string ContentInfo { get; }
Property Value
Type Description
System.String
API Level: 3
View Source

Effect

Gets or sets effect.

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

InstanceID

Gets the ID of the instance.

Declaration
C#
Copy
public string InstanceID { get; }
Property Value
Type Description
System.String
API Level: 3
View Source

LoadingText

Gets or sets the loading text.

Declaration
C#
Copy
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
C#
Copy
public bool PermanentDelete { get; set; }
Property Value
Type Description
Boolean
API Level: 3
View Source

Preview

Gets or sets the preview.

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

RetryText

Gets or sets retry text.

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

Title

Gets the title.

Declaration
C#
Copy
public string Title { get; }
Property Value
Type Description
System.String
API Level: 3
View Source

UpdatePeriod

Gets the update period.

Declaration
C#
Copy
public float UpdatePeriod { get; }
Property Value
Type Description
System.Single
API Level: 3
View Source

WidgetID

Gets the ID of the widget.

Declaration
C#
Copy
public string WidgetID { get; }
Property Value
Type Description
System.String
API Level: 3
View Source

WidgetStateFaulted

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

Declaration
C#
Copy
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
C#
Copy
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
C#
Copy
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
C#
Copy
protected override void Dispose(DisposeTypes type)
Parameters
Type Name Description
DisposeTypes type
Overrides
API Level: 3
View Source

PauseWidget()

Pauses a given widget.

Declaration
C#
Copy
public bool PauseWidget()
Returns
Type Description
Boolean

True on success, false otherwise.

API Level: 3
View Source

ResumeWidget()

Resumes a given widget.

Declaration
C#
Copy
public bool ResumeWidget()
Returns
Type Description
Boolean

True on success, false otherwise.

API Level: 3
View Source

TerminateWidget()

Terminate a widget instance.

Declaration
C#
Copy
public bool TerminateWidget()
Returns
Type Description
Boolean

True on success, false otherwise

API Level: 4

Events

View Source

WidgetAdded

An event for the WidgetAdded signal which can be used to subscribe or unsubscribe the event handler.
This signal is emitted when widget is added.

Declaration
C#
Copy
public event EventHandler<WidgetView.WidgetViewEventArgs> WidgetAdded
Event Type
Type Description
EventHandler<WidgetView.WidgetViewEventArgs>
API Level: 3
View Source

WidgetContentUpdated

An event for the WidgetContentUpdated signal which can be used to subscribe or unsubscribe the event handler.
This signal is emitted when the widget content is updated.

Declaration
C#
Copy
public event EventHandler<WidgetView.WidgetViewEventArgs> WidgetContentUpdated
Event Type
Type Description
EventHandler<WidgetView.WidgetViewEventArgs>
API Level: 3
View Source

WidgetCreationAborted

An event for the WidgetCreationAborted signal which can be used to subscribe or unsubscribe the event handler.
This signal is emitted when the widget creation is aborted.

Declaration
C#
Copy
public event EventHandler<WidgetView.WidgetViewEventArgs> WidgetCreationAborted
Event Type
Type Description
EventHandler<WidgetView.WidgetViewEventArgs>
API Level: 3
View Source

WidgetDeleted

An event for the WidgetDeleted signal which can be used to subscribe or unsubscribe the event handler.
This signal is emitted when the widget is deleted.

Declaration
C#
Copy
public event EventHandler<WidgetView.WidgetViewEventArgs> WidgetDeleted
Event Type
Type Description
EventHandler<WidgetView.WidgetViewEventArgs>
API Level: 3
View Source

WidgetFaulted

An event for the WidgetFaulted signal which can be used to subscribe or unsubscribe the event handler.
This signal is emitted when the widget process is not running.

Declaration
C#
Copy
public event EventHandler<WidgetView.WidgetViewEventArgs> WidgetFaulted
Event Type
Type Description
EventHandler<WidgetView.WidgetViewEventArgs>
API Level: 3
View Source

WidgetUpdatePeriodChanged

An event for the WidgetUpdatePeriodChanged signal which can be used to subscribe or unsubscribe the event handler.
This signal is emitted when the widget update period is changed.

Declaration
C#
Copy
public event EventHandler<WidgetView.WidgetViewEventArgs> WidgetUpdatePeriodChanged
Event Type
Type Description
EventHandler<WidgetView.WidgetViewEventArgs>
API Level: 3

Implements

System.ComponentModel.INotifyPropertyChanged
System.IDisposable