ProvideToolWindowVisibilityAttribute Class

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell

Assembly:: Microsoft.VisualStudio.Shell.14.0.dll

Assembly:: Microsoft.VisualStudio.Shell.15.0.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Declares that a tool window is should be visible when a certain command UI guid becomes active.

public ref class ProvideToolWindowVisibilityAttribute sealed : Microsoft::VisualStudio::Shell::RegistrationAttribute

public ref class ProvideToolWindowVisibilityAttribute sealed : Microsoft::VisualStudio::Shell::RegistrationAttribute

[System.AttributeUsage(System.AttributeTargets.Class, AllowMultiple=true, Inherited=true)]
public sealed class ProvideToolWindowVisibilityAttribute : Microsoft.VisualStudio.Shell.RegistrationAttribute

[<System.AttributeUsage(System.AttributeTargets.Class, AllowMultiple=true, Inherited=true)>]
type ProvideToolWindowVisibilityAttribute = class
    inherit RegistrationAttribute

Public NotInheritable Class ProvideToolWindowVisibilityAttribute
Inherits RegistrationAttribute

Inheritance: Attribute

RegistrationAttribute
ProvideToolWindowVisibilityAttribute

Attributes: AttributeUsageAttribute

Remarks

Applying this attribute to a subclass of the ToolWindowPane results in a tool window that the Visual Studio shell automatically shows or hides. The appearance of this window depends on the internal visibility attribute and the UI context information described in the package's .vsct file. If Visual Studio automatically shows a window and the user closes it, after that Visual Studio will never automatically show the window again. In order to see the tool window again after it has been closed, the user must manually open the window or delete \<USER>\Application Data\Microsoft\Visual Studio\<version>\1033\windows.prf, the Visual Studio file that saves shell information (including which windows are open, their location and size) when Visual Studio shuts down. After the window's internal visibility state is reset to true, the expected visibility behavior again occurs.

Constructors

ProvideToolWindowVisibilityAttribute(Object, String)	Creates a new attribute for a specific tool window and a command UI guid.
ProvideToolWindowVisibilityAttribute(Object, String, Boolean)	Creates a new attribute for a specific tool window and a command UI guid.

Properties

CommandUIGuid	Get the command UI guid controlling the visibility of the tool window.
Name	Get or Set name of the toolwindow. This does not impact the runtime behavior.
TypeId	Gets the current instance of this attribute. (Inherited from RegistrationAttribute)

Methods

GetPackageRegKeyPath(Guid)	Gets the registry path (relative to the registry root of the application) of the VSPackage. (Inherited from RegistrationAttribute)
Register(RegistrationAttribute+RegistrationContext)	Called to register this attribute with the given context. The context contains the location where the registration information should be placed. it also contains such as the type being registered, and path information.
Unregister(RegistrationAttribute+RegistrationContext)	Unregister this visibility entry.

Applies to