Class WidgetBase

Definition

Namespace:

Tizen.Applications

Assembly:

Tizen.Applications.WidgetApplication.dll

API Level:

3

The abstract class for widget instances.

public abstract class WidgetBase

Inheritance

Object

WidgetBase

Constructors

WidgetBase()

Constructor.

Declaration

public WidgetBase()

API Level: 3

Fields

Window

Window object for this widget instance. It will be created after OnCreate method is invoked.

Declaration

protected Window Window

Field Value

Type	Description
Window

API Level: 3

Properties

Id

ID for this widget instance. It will be created after OnCreate method is invoked.

Declaration

public string Id { get; }

Property Value

Type	Description
String

API Level: 6

Methods

Exit()

Finishes the context for the widget instance.

Declaration

public void Exit()

Exceptions

Type	Condition
NotSupportedException	Thrown when the API is not supported in this device.
InvalidOperationException	Thrown in case of an unrecoverable error.

API Level: 3

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

OnCreate(Bundle, Int32, Int32)

Overrides this method if want to handle the behavior when the widget instance is started.

Declaration

public virtual void OnCreate(Bundle content, int w, int h)

Parameters

Type	Name	Description
Bundle	content	The data set for the previous status.
Int32	w	The pixel value for the widget width.
Int32	h	The pixel value for the widget height.

API Level: 3

OnDestroy(WidgetBase.WidgetDestroyType, Bundle)

Overrides this method if want to handle the behavior when the widget instance is destroyed.

Declaration

public virtual void OnDestroy(WidgetBase.WidgetDestroyType reason, Bundle content)

Parameters

Type	Name	Description
WidgetBase.WidgetDestroyType	reason	The reason for destruction.
Bundle	content	The data set to save.

API Level: 3

OnPause()

Overrides this method if want to handle the behavior when the widget instance is paused.

Declaration

public virtual void OnPause()

API Level: 3

OnResize(Int32, Int32)

Overrides this method if want to handle the behavior when the widget instance is resized.

Declaration

public virtual void OnResize(int w, int h)

Parameters

Type	Name	Description
Int32	w	Widget width.
Int32	h	Widget height.

API Level: 3

OnResume()

Overrides this method if want to handle the behavior when the widget instance is resumed.

Declaration

public virtual void OnResume()

API Level: 3

OnUpdate(Bundle, Boolean)

Overrides this method if want to handle the behavior when the widget instance is updated.

Declaration

public virtual void OnUpdate(Bundle content, bool isForce)

Parameters

Type	Name	Description
Bundle	content	The data set for updating this widget will be provided by the requester.
Boolean	isForce	Although the widget is paused, if it is true, the widget can be updated.

API Level: 3

SetContent(Bundle)

Sets the content information to the widget.

Declaration

public void SetContent(Bundle info)

Parameters

Type	Name	Description
Bundle	info	The data set to save.

Exceptions

Type	Condition
ArgumentException	Thrown when failed because of an invalid argument.
NotSupportedException	Thrown when the API is not supported in this device.
InvalidOperationException	Thrown in case of an unrecoverable error.

API Level: 3

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

SetTitle(String)

Sends the title to the widget.

Declaration

public void SetTitle(string title)

Parameters

Type	Name	Description
String	title	When an accessibility mode is turned on, this string will be read.

Exceptions

Type	Condition
ArgumentException	Thrown when failed because of an invalid argument.
NotSupportedException	Thrown when the API is not supported in this device.
InvalidOperationException	Thrown in case of an unrecoverable error.

API Level: 3

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