Share via


System.Gadget.Sidebar.dockSide property

[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. ]

Gets the Windows Sidebar dock state.

This property is read-only.

Syntax

strdockSide = System.Gadget.Sidebar.dockSide

Property value

A String that receives the dock state of the Sidebar.

(Right)

The Sidebar is docked on the right side of the monitor.

(Left)

The Sidebar is docked on the left side of the monitor.

Examples

The following example demonstrates how to get the dock state of the Sidebar.

// --------------------------------------------------------------------
// Initialize the gadget.
// --------------------------------------------------------------------
function Init()
{
    // Initialize the gadget content.
    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
Sidebar.idl
DLL
Sidebar.Exe (version 1.00 or later)

See also

System.Gadget.Sidebar

onDockSideChanged