ProvideKeyBindingTableAttribute Class

Article
07/12/2014

Provides a key binding table GUID.

Inheritance Hierarchy

System.Object
  System.Attribute
    Microsoft.VisualStudio.Shell.RegistrationAttribute
      Microsoft.VisualStudio.Shell.ProvideKeyBindingTableAttribute

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

Syntax

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

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

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

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

public final class ProvideKeyBindingTableAttribute extends RegistrationAttribute

The ProvideKeyBindingTableAttribute type exposes the following members.

Constructors

	Name	Description
	ProvideKeyBindingTableAttribute	Initializes a new instance of ProvideKeyBindingTableAttribute for the specified table and name resource ID.

Top

Properties

	Name	Description
	AllowNavKeyBinding	Gets or sets whether the user is allowed to bind new commands to navigation keys.
	NameResourceID	Gets the name resource ID.
	TableGuid	Gets the GUID of the key binding table.
	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	Called to register this attribute with the given context. (Overrides RegistrationAttribute.Register(RegistrationAttribute.RegistrationContext).)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	Unregister	Removes the registration information about a VSPackage when called by an external registration tool such as regpkg.exe. For more information, see Registering VSPackages. (Overrides RegistrationAttribute.Unregister(RegistrationAttribute.RegistrationContext).)

Top

Explicit Interface Implementations

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

Top

Remarks

This attribute provides a key binding table GUID. By putting this attribute on your package you will declare that it has the given key binding table in its .vsct . This allows your package to offer its command set without being loaded. The package will be loaded if the user invokes any of the commands. For more information about the .vsct file, see VSCT XML Schema Reference.

Registry Entries

The following registry entries are created during registration of this attribute:

VSROOT\KeyBindingTables\{TableGuid}
VSROOT\KeyBindingTables\{TableGuid}\@=#NameResourceID
VSROOT\KeyBindingTables\{TableGuid}\Package={PackageGuid}

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.

Share via