Class WidgetControl

Definition

Namespace:: Tizen.Applications

Assembly:: Tizen.Applications.WidgetControl.dll

API Level:: 3

The class for receiving widget events and sending data to the widget.


                C#
                
                    Copy
                    
                
            
public class WidgetControl : IDisposable

Inheritance: System.Object

WidgetControl

Implements: System.IDisposable

Constructors

View Source

WidgetControl(String)

The constructor of the WidgetControl object.

Declaration


                C#
                
                    Copy
                    
                
            
public WidgetControl(string widgetId)

Parameters

Type	Name	Description
System.String	widgetId	Widget ID.

API Level: 3

Properties

View Source

Id

The widget ID.

Declaration


                C#
                
                    Copy
                    
                
            
public string Id { get; }

Property Value

Type	Description
System.String

API Level: 3

View Source

IsNoDisplay

The flag value for "nodisplay".

Declaration


                C#
                
                    Copy
                    
                
            
public bool IsNoDisplay { get; }

Property Value

Type	Description
Boolean

Exceptions

Type	Condition
UnauthorizedAccessException	Thrown when an application does not have the required privileges to access this method.
System.NotSupportedException	Thrown when the required features are not supported.

API Level: 3

Privilege Level: public

Privilege: http://tizen.org/privilege/widget.viewer

Feature: http://tizen.org/feature/shell.appwidget

View Source

MainAppId

Gets main appid of the widget.

Declaration


                C#
                
                    Copy
                    
                
            
public string MainAppId { get; }

Property Value

Type	Description
System.String

Exceptions

Type	Condition
UnauthorizedAccessException	Thrown when an application does not have the required privileges to access this method.
System.NotSupportedException	Thrown when the required features are not supported.

API Level: 6

Privilege Level: public

Privilege: http://tizen.org/privilege/widget.viewer

Feature: http://tizen.org/feature/shell.appwidget

View Source

PackageId

Gets package ID of the widget.

Declaration


                C#
                
                    Copy
                    
                
            
public string PackageId { get; }

Property Value

Type	Description
System.String

Exceptions

Type	Condition
UnauthorizedAccessException	Thrown when an application does not have the required privileges to access this method.
System.NotSupportedException	Thrown when the required features are not supported.

API Level: 6

Privilege Level: public

Privilege: http://tizen.org/privilege/widget.viewer

Feature: http://tizen.org/feature/shell.appwidget

View Source

SetupAppId

Gets setup app ID of the widget.

Declaration


                C#
                
                    Copy
                    
                
            
public string SetupAppId { get; }

Property Value

Type	Description
System.String

Exceptions

Type	Condition
UnauthorizedAccessException	Thrown when an application does not have the required privileges to access this method.
System.NotSupportedException	Thrown when the required features are not supported.
System.InvalidOperationException	Thrown in case of failed conditions.

API Level: 8

Privilege Level: public

Privilege: http://tizen.org/privilege/widget.viewer

Feature: http://tizen.org/feature/shell.appwidget

Methods

View Source

CreateAll(String)

Factory method for the WidgetControl. It will create all the objects of WidgetControl based on the package ID.

Declaration


                C#
                
                    Copy
                    
                
            
public static WidgetControl[] CreateAll(string pkgId)

Parameters

Type	Name	Description
System.String	pkgId	Package ID.

Returns

Type	Description
WidgetControl[]	The widget control array.

Exceptions

Type	Condition
System.ArgumentException	Thrown when failed because of an invalid argument.
System.InvalidOperationException	Thrown in case of failed conditions.
UnauthorizedAccessException	Thrown when an application does not have the required privileges to access this method.
System.NotSupportedException	Thrown when the required features are not supported.

API Level: 3

Privilege Level: public

Privilege: http://tizen.org/privilege/widget.viewer

Feature: http://tizen.org/feature/shell.appwidget

View Source

Dispose()

Releases all the resources used by the WidgetControl class.

Declaration


                C#
                
                    Copy
                    
                
            
public void Dispose()

Exceptions

Type	Condition
System.InvalidOperationException	Thrown in case of failed conditions.
UnauthorizedAccessException	Thrown when an application does not have the required privileges to access this method.
System.NotSupportedException	Thrown when the required features are not supported.

API Level: 3

Feature: http://tizen.org/feature/shell.appwidget

View Source

Finalize()

Finalizer of the WidgetControl class.

Declaration


                C#
                
                    Copy
                    
                
            
protected void Finalize()

View Source

GetIconPath(String)

Gets the widget icon path.

Declaration


                C#
                
                    Copy
                    
                
            
public string GetIconPath(string lang)

Parameters

Type	Name	Description
System.String	lang	Language.

Returns

Type	Description
System.String	The widget icon path.

Exceptions

Type	Condition
System.ArgumentNullException	Thrown when the argument is null.
UnauthorizedAccessException	Thrown when an application does not have the required privileges to access this method.
System.NotSupportedException	Thrown when the required features are not supported.

API Level: 3

Privilege Level: public

Privilege: http://tizen.org/privilege/widget.viewer

Feature: http://tizen.org/feature/shell.appwidget

View Source

GetInstances()

Gets the objects for widget instance information.

Declaration


                C#
                
                    Copy
                    
                
            
public IEnumerable<WidgetControl.Instance> GetInstances()

Returns

Type	Description
System.Collections.Generic.IEnumerable<WidgetControl.Instance>	The instances list.

Exceptions

Type	Condition
System.InvalidOperationException	Thrown in case of failed conditions.
System.NotSupportedException	Thrown when the API is not supported in this device.
UnauthorizedAccessException	Thrown when an application does not have the required privileges to access this method.

API Level: 3

Feature: http://tizen.org/feature/shell.appwidget

View Source

GetName(String)

Gets the widget name.

Declaration


                C#
                
                    Copy
                    
                
            
public string GetName(string lang)

Parameters

Type	Name	Description
System.String	lang	Language.

Returns

Type	Description
System.String	The widget name.

Exceptions

Type	Condition
System.ArgumentNullException	Thrown when the argument is null.
UnauthorizedAccessException	Thrown when an application does not have the required privileges to access this method.
System.NotSupportedException	Thrown when the required features are not supported.

API Level: 3

Privilege Level: public

Privilege: http://tizen.org/privilege/widget.viewer

Feature: http://tizen.org/feature/shell.appwidget

View Source

GetScales()

Gets the objects for widget scale information.

Declaration


                C#
                
                    Copy
                    
                
            
public IEnumerable<WidgetControl.Scale> GetScales()

Returns

Type	Description
System.Collections.Generic.IEnumerable<WidgetControl.Scale>	The scales list.

Exceptions

Type	Condition
System.InvalidOperationException	Thrown in case of failed conditions.
UnauthorizedAccessException	Thrown when an application does not have the required privileges to access this method.
System.NotSupportedException	Thrown when the required features are not supported.

API Level: 3

Privilege Level: public

Privilege: http://tizen.org/privilege/widget.viewer

Feature: http://tizen.org/feature/shell.appwidget

View Source

GetWidgetIds(String)

Gets all the widget IDs by the package ID.

Declaration


                C#
                
                    Copy
                    
                
            
public static string[] GetWidgetIds(string pkgId)

Parameters

Type	Name	Description
System.String	pkgId	Package ID.

Returns

Type	Description
System.String[]	The widget id array.

Exceptions

Type	Condition
System.ArgumentException	Thrown when failed because of an invalid argument.
System.InvalidOperationException	Thrown in case of failed conditions.
UnauthorizedAccessException	Thrown when an application does not have the required privileges to access this method.
System.NotSupportedException	Thrown when the required features are not supported.

API Level: 3

Privilege Level: public

Privilege: http://tizen.org/privilege/widget.viewer

Feature: http://tizen.org/feature/shell.appwidget

Events

View Source

Created

The event handler for a created widget instance.

Declaration


                C#
                
                    Copy
                    
                
            
public event EventHandler<WidgetLifecycleEventArgs> Created

Event Type

Type	Description
System.EventHandler<WidgetLifecycleEventArgs>

Exceptions

Type	Condition
System.InvalidOperationException	Thrown in case of failed conditions.
UnauthorizedAccessException	Thrown when an application does not have the required privileges to access this method.
System.NotSupportedException	Thrown when the required features are not supported.

API Level: 3

Feature: http://tizen.org/feature/shell.appwidget

View Source

Destroyed

The event handler for a destroyed widget instance.

Declaration


                C#
                
                    Copy
                    
                
            
public event EventHandler<WidgetLifecycleEventArgs> Destroyed

Event Type

Type	Description
System.EventHandler<WidgetLifecycleEventArgs>

Exceptions

Type	Condition
System.InvalidOperationException	Thrown in case of failed conditions.
UnauthorizedAccessException	Thrown when an application does not have the required privileges to access this method.
System.NotSupportedException	Thrown when the required features are not supported.

API Level: 3

Feature: http://tizen.org/feature/shell.appwidget

View Source

Paused

The event handler for a paused widget instance.

Declaration


                C#
                
                    Copy
                    
                
            
public event EventHandler<WidgetLifecycleEventArgs> Paused

Event Type

Type	Description
System.EventHandler<WidgetLifecycleEventArgs>

Exceptions

Type	Condition
System.InvalidOperationException	Thrown in case of failed conditions.
UnauthorizedAccessException	Thrown when an application does not have the required privileges to access this method.
System.NotSupportedException	Thrown when the required features are not supported.

API Level: 3

Feature: http://tizen.org/feature/shell.appwidget

View Source

Resumed

The event handler for a resumed widget instance.

Declaration


                C#
                
                    Copy
                    
                
            
public event EventHandler<WidgetLifecycleEventArgs> Resumed

Event Type

Type	Description
System.EventHandler<WidgetLifecycleEventArgs>

Exceptions

Type	Condition
System.InvalidOperationException	Thrown in case of failed conditions.
UnauthorizedAccessException	Thrown when an application does not have the required privileges to access this method.
System.NotSupportedException	Thrown when the required features are not supported.

API Level: 3

Feature: http://tizen.org/feature/shell.appwidget

Implements

System.IDisposable