Ask Learn
Preview
Please sign in to use this experience.
Sign inThis browser is no longer supported.
Upgrade to Microsoft Edge to take advantage of the latest features, security updates, and technical support.
Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
[The Windows Gadget Platform/Sidebar is available for use in the operating systems specified in the Requirements section. It may be altered or unavailable in subsequent versions. ]
Defines the properties, methods, and events that provide basic gadget functionality.
The System.Gadget object has these types of members:
The System.Gadget object has these events.
Event | Description |
---|---|
[onDock](system-gadget-ondock.md) | Event fired when the gadget is docked on the Sidebar. [!Note] |
[onSettingsClosed](system-gadget-onsettingsclosed.md) | Event fired when the gadget Settings dialog is closed. |
[onSettingsClosing](system-gadget-onsettingsclosing.md) | Event fired when the gadget Settings dialog begins the process of closing. |
[onShowSettings](system-gadget-onshowsettings.md) | Event fired when the gadget Settings dialog is requested. |
[onUndock](system-gadget-onundock.md) | Event fired when the gadget is docked on the Sidebar. [!Note] |
[visibilityChanged](system-gadget-visibilitychanged.md) | Event fired when the gadget visibility changes due to the Sidebar being hidden or displayed. |
The System.Gadget object has these methods.
Method | Description |
---|---|
[beginTransition](system-gadget-begintransition.md) | Suspends all gadget updates, animations, and effects until a docking or undocking transition has completed. [!Note] |
[close](system-gadget-close.md) | Ends a running instance of a gadget. |
[endTransition](system-gadget-endtransition.md) | Refreshes the gadget view and resumes updates, animations, and effects once a gadget docking or undocking transition has completed. [!Note] |
The System.Gadget object has these properties.
Property | Access type | Description |
---|---|---|
background |
Read/write |
Gets or sets the file path for the gadget background image. |
docked |
Read-only |
Gets the dock state of the gadget in relation to the Sidebar. |
document |
Read-only |
Gets an object that represents the DOM of the gadget HTML file. |
name |
Read-only |
Gets the gadget name as specified in the gadget manifest file. |
opacity |
Read-only |
Gets the gadget opacity. |
path |
Read-only |
Gets the UNC location of the gadget source files. |
platformVersion |
Read-only |
Gets the Sidebar version. |
settingsUI |
Read/write |
Gets or sets the HTML filename for the gadget Settings dialog UI. |
version |
Read-only |
Gets the gadget version as specified in the gadget manifest file. |
visible |
Read-only |
Gets the visibility state of the gadget. |
Minimum supported client |
Windows Vista [desktop apps only] |
Minimum supported server |
Windows Server 2008 [desktop apps only] |
End of client support |
Windows 7 |
End of server support |
Windows Server 2008 |
IDL |
|
DLL |
|
Please sign in to use this experience.
Sign in