Share via


VsDockStyle Enumeration

Defines constants for tool window orientation.

Namespace:  Microsoft.VisualStudio.Shell
Assembly:  Microsoft.VisualStudio.Shell (in Microsoft.VisualStudio.Shell.dll)

Syntax

'宣言
Public Enumeration VsDockStyle
'使用
Dim instance As VsDockStyle
public enum VsDockStyle
public enum class VsDockStyle
public enum VsDockStyle

Members

Member name Description
none The registration attribute ProvideToolWindowAttribute initializes to this value of no style specified.
MDI If the Style value is MDI, the tool window will be linked to the MDI area, and Window is ignored.
Float If the Style value is Float, the tool window will float initially, but when the title bar is double-clicked, Orientation and Window apply, and the window will default to Tabbed.
Linked If the Style value is Linked, Orientation can be Left, Right, Top, or Bottom.
Tabbed If the Style value is Tabbed, Orientation can be Left or Right and specifies where the tab will be placed.
AlwaysFloat If the Style value is AlwaysFloat, the tool window cannot be docked.

Remarks

Tool window orientation means the position where the tool window docks when the title bar is double-clicked. This is relative to the tool window specified in the Window keyword of the ProvideToolWindowAttribute attribute. For an example of ProvideToolWindowAttribute, see ToolWindowOrientation.

注意

You cannot specify that a tool window is docked by default; you can specify that it will dock once its title bar is double-clicked.

Examples

The attribute ProvideToolWindowAttribute, applied to your Microsoft.VisualStudio.Package-derived class and specifying that the tool window should always float, looks like this.

// MyToolWindow is the class that implements the tool window.
[Microsoft.VisualStudio.Package.ProvideToolWindowAttribute(typeof(MyToolWindow),Style= Microsoft.VisualStudio.Shell.VsDockStyle.AlwaysFloat)]

See Also

Reference

Microsoft.VisualStudio.Shell Namespace

ProvideToolWindowAttribute