ProvideToolWindowVisibilityAttribute Class

Article
04/29/2015

Maps a tool window to one or more UI contexts, so that the window is displayed when the user switches to one of those contexts and is hidden when the user switches away from one of the contexts.

Inheritance Hierarchy

Object
  Attribute
    Microsoft.VisualStudio.Shell.RegistrationAttribute
      Microsoft.VisualStudio.Shell.ProvideToolWindowVisibilityAttribute

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

Syntax

'Declaration
<AttributeUsageAttribute(AttributeTargets.Class, AllowMultiple := True, Inherited := True)> _
Public NotInheritable Class ProvideToolWindowVisibilityAttribute _
    Inherits RegistrationAttribute

[AttributeUsageAttribute(AttributeTargets.Class, AllowMultiple = true, Inherited = true)]
public sealed class ProvideToolWindowVisibilityAttribute : RegistrationAttribute

[AttributeUsageAttribute(AttributeTargets::Class, AllowMultiple = true, Inherited = true)]
public ref class ProvideToolWindowVisibilityAttribute sealed : public RegistrationAttribute

[<Sealed>]
[<AttributeUsageAttribute(AttributeTargets.Class, AllowMultiple = true, Inherited = true)>]
type ProvideToolWindowVisibilityAttribute =  
    class 
        inherit RegistrationAttribute 
    end

public final class ProvideToolWindowVisibilityAttribute extends RegistrationAttribute

The ProvideToolWindowVisibilityAttribute type exposes the following members.

Constructors

	Name	Description
	ProvideToolWindowVisibilityAttribute	Initializes a new instance of ProvideToolWindowVisibilityAttribute for the specified type of the tool window and a GUID to associate with its visibility.

Top

Properties

	Name	Description
	CommandUIGuid	Gets the GUID of a command associated with showing or hiding the tool window.
	Name	Gets or sets the name of the window.
	TypeId	Gets the current instance of this attribute. (Inherited from RegistrationAttribute.)

Top

Methods

	Name	Description
	Equals	Infrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
	GetHashCode	Returns the hash code for this instance. (Inherited from Attribute.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IsDefaultAttribute	When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
	Match	When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
	Register	Registers the tool window visibility. (Overrides RegistrationAttribute.Register(RegistrationAttribute.RegistrationContext).)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	Unregister	Removes the registry key. (Overrides RegistrationAttribute.Unregister(RegistrationAttribute.RegistrationContext).)

Top

Explicit Interface Implementations

	Name	Description
	System#Runtime#InteropServices#_Attribute#GetIDsOfNames	Maps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
	System#Runtime#InteropServices#_Attribute#GetTypeInfo	Retrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
	System#Runtime#InteropServices#_Attribute#GetTypeInfoCount	Retrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
	System#Runtime#InteropServices#_Attribute#Invoke	Provides access to properties and methods exposed by an object. (Inherited from Attribute.)

Top

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.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Partager via