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.

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

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

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

NameDescription
System_CAPS_pubmethodProvideEditorExtensionAttribute(Object, String, Int32)

Initializes an instance of ProvideEditorExtensionAttribute.

NameDescription
System_CAPS_pubpropertyDefaultName

Gets or sets the default name of the editor.

System_CAPS_pubpropertyEditorFactoryNotify

Determines whether or not the extension should be registered with a EditorFactoryNotify registry value, which associates a file extension with a specific editor factory.

System_CAPS_pubpropertyExtension

Gets the file extension associated with this editor.

System_CAPS_pubpropertyFactory

Returns the GUID of the associated factory.

System_CAPS_pubpropertyNameResourceID

Gets and sets the integer NameResourceID.

System_CAPS_pubpropertyPriority

Gets the editor's priority as set in the constructor.

System_CAPS_pubpropertyProjectGuid

Sets and gets the GUID of the project associated with this editor.

System_CAPS_pubpropertyTemplateDir

Gets or sets the template directory to be used by the editor factory to retrieve its source files.

System_CAPS_pubpropertyTypeId

Gets the current instance of this attribute.(Inherited from RegistrationAttribute.)

NameDescription
System_CAPS_pubmethodEquals(Object)

(Inherited from Attribute.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Attribute.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodIsDefaultAttribute()

(Inherited from Attribute.)

System_CAPS_pubmethodMatch(Object)

(Inherited from Attribute.)

System_CAPS_pubmethodRegister(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 the type being registered and path information.(Overrides RegistrationAttribute.Register(RegistrationAttribute.RegistrationContext).)

System_CAPS_pubmethodToString()

(Inherited from Object.)

System_CAPS_pubmethodUnregister(RegistrationAttribute.RegistrationContext)

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).)

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.

Apply this file extension attribute to a package class that implements an editor factory. The package class must inherit from Package or IVsPackage.

The following registry entry is created by this attribute:

VSROOT\Editors\{FactoryGuid}\Extensions\Extension = Priority

System_CAPS_noteNote

The GUIDs for the Visual C# and Visual Basic project types are {FAE04EC0-301F-11D3-BF4B-00C04F79EFBC} and {F184B08F-C81C-45F6-A57F-5ABD9991F28F}, respectively.

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

Return to top
Show: