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, IDynamicResourceHandler, IElement, INameScope, IElementController, System.IDisposable, IResourcesProvider
- Inheritance
-
- Implements
-
Constructors
Declaration
public WidgetView(string widgetId, string contentInfo, int width, int height, float updatePeriod)
Parameters
API Level: 3
Fields
Declaration
public static readonly BindableProperty EffectProperty
Field Value
Declaration
public static readonly BindableProperty KeepWidgetSizeProperty
Field Value
Declaration
public static readonly BindableProperty LoadingTextProperty
Field Value
Declaration
public static readonly BindableProperty PermanentDeleteProperty
Field Value
Declaration
public static readonly BindableProperty PreviewProperty
Field Value
Declaration
public static readonly BindableProperty RetryTextProperty
Field Value
Declaration
public static readonly BindableProperty WidgetStateFaultedProperty
Field Value
Properties
Declaration
public string ContentInfo { get; }
Property Value
API Level: 3
Declaration
public PropertyMap Effect { get; set; }
Property Value
API Level: 4
Declaration
public string InstanceID { get; }
Property Value
API Level: 3
View Source
Gets or sets KeepWidgetSize
if this value is true, WidgetView keep widget instance's size and don't resize even if WidgetView is resized.
Declaration
public bool KeepWidgetSize { get; set; }
Property Value
Declaration
public bool LoadingText { get; set; }
Property Value
API Level: 3
View Source
Gets or sets whether the widget is to delete permanently or not.
Declaration
public bool PermanentDelete { get; set; }
Property Value
API Level: 3
Declaration
public bool Preview { get; set; }
Property Value
API Level: 3
Declaration
public PropertyMap RetryText { get; set; }
Property Value
API Level: 4
Declaration
public string Title { get; }
Property Value
API Level: 3
Declaration
public float UpdatePeriod { get; }
Property Value
API Level: 3
Declaration
public string WidgetID { get; }
Property Value
API Level: 3
View Source
Gets or sets whether the widget state is faulted or not.
Declaration
public bool WidgetStateFaulted { get; set; }
Property Value
API Level: 3
Methods
View Source
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
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
Used in xaml as factory method to create WidgetView.
Declaration
public static WidgetView CreateWidgetView(string widgetId, string contentInfo, int width, int height, float updatePeriod)
Parameters
Returns
Declaration
protected override void Dispose(DisposeTypes type)
Parameters
Overrides
API Level: 3
View Source
The touch event handler for ControlState.
Please change ControlState value by touch state if needed.
Declaration
protected override bool HandleControlStateOnTouch(Touch touch)
Parameters
| Type |
Name |
Description |
| Touch |
touch |
|
Returns
Overrides
Declaration
public bool PauseWidget()
Returns
| Type |
Description |
| Boolean |
True on success, false otherwise.
|
API Level: 3
Declaration
protected override void ReleaseSwigCPtr(Runtime.InteropServices.HandleRef swigCPtr)
Parameters
| Type |
Name |
Description |
| Tizen.System.Runtime.InteropServices.HandleRef |
swigCPtr |
|
Overrides
Declaration
public bool ResumeWidget()
Returns
| Type |
Description |
| Boolean |
True on success, false otherwise.
|
API Level: 3
Declaration
public bool TerminateWidget()
Returns
| Type |
Description |
| Boolean |
True on success, false otherwise
|
API Level: 4
Events
View Source
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
public event EventHandler<WidgetView.WidgetViewEventArgs> WidgetAdded
Event Type
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
public event EventHandler<WidgetView.WidgetViewEventArgs> WidgetContentUpdated
Event Type
API Level: 3
View Source
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
public event EventHandler<WidgetView.WidgetViewEventArgs> WidgetCreationAborted
Event Type
API Level: 3
View Source
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
public event EventHandler<WidgetView.WidgetViewEventArgs> WidgetDeleted
Event Type
API Level: 3
View Source
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
public event EventHandler<WidgetView.WidgetViewEventArgs> WidgetFaulted
Event Type
API Level: 3
View Source
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
public event EventHandler<WidgetView.WidgetViewEventArgs> WidgetUpdatePeriodChanged
Event Type
API Level: 3
Implements
Extension Methods