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, INotifyPropertyChanged, IDisposable
    Inheritance
    object
    BindableObject
    Tizen.NUI.Binding.Element
    BaseHandle
    Animatable
    Container
    View
    WidgetView
    Implements
    System.ComponentModel.INotifyPropertyChanged
    System.IDisposable

    Constructors

    View Source

    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

    View Source

    ContentInfo

    Gets the content info.

    Declaration
    public string ContentInfo { get; }
    Property Value
    Type Description
    string
    View Source

    Effect

    Gets or sets effect.

    Declaration
    public PropertyMap Effect { get; set; }
    Property Value
    Type Description
    PropertyMap
    View Source

    InstanceID

    Gets the ID of the instance.

    Declaration
    public string InstanceID { get; }
    Property Value
    Type Description
    string
    View Source

    LoadingText

    Gets or sets the loading text.

    Declaration
    public bool LoadingText { get; set; }
    Property Value
    Type Description
    bool
    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
    bool
    View Source

    Preview

    Gets or sets the preview.

    Declaration
    public bool Preview { get; set; }
    Property Value
    Type Description
    bool
    View Source

    RetryText

    Gets or sets retry text.

    Declaration
    public PropertyMap RetryText { get; set; }
    Property Value
    Type Description
    PropertyMap
    View Source

    Title

    Gets the title.

    Declaration
    public string Title { get; }
    Property Value
    Type Description
    string
    View Source

    UpdatePeriod

    Gets the update period.

    Declaration
    public float UpdatePeriod { get; }
    Property Value
    Type Description
    float
    View Source

    WidgetID

    Gets the ID of the widget.

    Declaration
    public string WidgetID { get; }
    Property Value
    Type Description
    string
    View Source

    WidgetStateFaulted

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

    Declaration
    public bool WidgetStateFaulted { get; set; }
    Property Value
    Type Description
    bool

    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()
    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
    bool

    True on success, false otherwise.

    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
    View.Dispose(DisposeTypes)
    View Source

    PauseWidget()

    Pauses a given widget.

    Declaration
    public bool PauseWidget()
    Returns
    Type Description
    bool

    True on success, false otherwise.

    View Source

    ResumeWidget()

    Resumes a given widget.

    Declaration
    public bool ResumeWidget()
    Returns
    Type Description
    bool

    True on success, false otherwise.

    View Source

    TerminateWidget()

    Terminate a widget instance.

    Declaration
    public bool TerminateWidget()
    Returns
    Type Description
    bool

    True on success, false otherwise

    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
    public event EventHandler<WidgetView.WidgetViewEventArgs> WidgetAdded
    Event Type
    Type Description
    EventHandler<><WidgetViewEventArgs>
    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
    Type Description
    EventHandler<><WidgetViewEventArgs>
    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
    public event EventHandler<WidgetView.WidgetViewEventArgs> WidgetCreationAborted
    Event Type
    Type Description
    EventHandler<><WidgetViewEventArgs>
    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
    public event EventHandler<WidgetView.WidgetViewEventArgs> WidgetDeleted
    Event Type
    Type Description
    EventHandler<><WidgetViewEventArgs>
    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
    public event EventHandler<WidgetView.WidgetViewEventArgs> WidgetFaulted
    Event Type
    Type Description
    EventHandler<><WidgetViewEventArgs>
    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
    public event EventHandler<WidgetView.WidgetViewEventArgs> WidgetUpdatePeriodChanged
    Event Type
    Type Description
    EventHandler<><WidgetViewEventArgs>

    Implements

    System.ComponentModel.INotifyPropertyChanged
    System.IDisposable
    • View Source
    Back to top Copyright © 2016-2024 Samsung
    Generated by DocFX