ProvideEditorExtensionAttribute Class
Associates a file extension to a given editor factory when applied to a class that inherits from Package or implements the interface IVsPackage.
System.Attribute
Microsoft.VisualStudio.Shell.RegistrationAttribute
Microsoft.VisualStudio.Shell.ProvideEditorExtensionAttribute
Assembly: Microsoft.VisualStudio.Shell.10.0 (in Microsoft.VisualStudio.Shell.10.0.dll)
The ProvideEditorExtensionAttribute type exposes the following members.
| Name | Description | |
|---|---|---|
|
ProvideEditorExtensionAttribute | Initializes an instance of ProvideEditorExtensionAttribute. |
| Name | Description | |
|---|---|---|
|
DefaultName | Gets or sets the default name of the editor. |
|
|
EditorFactoryNotify | Determines whether or not the extension should be registered with a EditorFactoryNotify registry value, which associates a file extension with a specific editor factory. |
|
|
Extension | Gets the file extension associated with this editor. |
|
|
Factory | Returns the GUID of the associated factory. |
|
|
NameResourceID | Gets and sets the integer NameResourceID. |
|
|
Priority | Gets the editor's priority as set in the constructor. |
|
|
ProjectGuid | Sets and gets the GUID of the project associated with this editor. |
|
|
TemplateDir | Gets or sets the template directory to be used by the editor factory to retrieve its source files. |
|
|
TypeId | Gets the current instance of this attribute. (Inherited from RegistrationAttribute.) |
| Name | Description | |
|---|---|---|
|
|
Equals | Infrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.) |
|
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
|
|
GetHashCode | Returns the hash code for this instance. (Inherited from Attribute.) |
|
|
GetPackageRegKeyPath | Gets the registry path (relative to the registry root of the application) of the VSPackage. (Inherited from RegistrationAttribute.) |
|
|
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.) |
|
|
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
|
Register | Called to register this attribute with the given context. The context contains the location where the registration information should be placed. It also contains the type being registered and path information. (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).) |
| 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.) |
This attribute associates a file extension with a given editor factory. The file extension should include the prefixing ".". The editor factory may be specified as either a GUID or a type.
This attribute also associates a priority with the editor factory. For a given file extension, the editor with the highest priority is given the chance to read a file first. If the editor fails to read the file, the remaining editors are used in order of priority. To make a given editor the default, assign a priority greater than 0x60.
This attribute class is only used to provide data for external registration tools. It does not affect runtime behavior.
When to Call
Apply this file extension attribute to a package class that implements an editor factory. The package class must inherit from Package or IVsPackage.
Registry Entries
The following registry entry is created by this attribute:
VSROOT\Editors\{FactoryGuid}\Extensions\Extension = Priority
Note
|
|---|
|
The GUIDs for the Visual C# and Visual Basic project types are {FAE04EC0-301F-11D3-BF4B-00C04F79EFBC} and {F184B08F-C81C-45F6-A57F-5ABD9991F28F}, respectively. |
