System.Gadget.Sidebar.onDockSideChanged event
[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. ]
Event fired when the Windows Sidebar dock state changes.
Syntax
iRetVal = System.Gadget.Sidebar.onDockSideChanged(
handler
)
Parameters
-
handler
-
The name of the function to call when the event is fired.
Remarks
The Sidebar can be docked on the left or the right side of the screen.
This event updates the dockSide property.
Useful when changes to graphics alignment based on the Sidebar dockSide property are necessary.
Examples
The following example demonstrates how to listen for the onDockSideChanged event.
// Enable the gadget Sidebar functionality.
System.Gadget.Sidebar.onDockSideChanged = DockSideChanged;
// --------------------------------------------------------------------
// Handle the Sidebar dockside changed event.
// --------------------------------------------------------------------
function DockSideChanged()
{
SetContentText(System.Gadget.Sidebar.dockSide);
}
Requirements
| 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 |
|