RegisterEditorExtensionAttribute Class

 
Note: This API is now obsolete.

See ProvideEditorExtensionAttribute. Registers a file extension with a given editor factory. This class cannot be inherited.

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

[ObsoleteAttribute("RegisterEditorExtensionAttribute has been deprecated. Please use ProvideEditorExtensionAttribute instead.")]
[AttributeUsageAttribute(AttributeTargets.Class, AllowMultiple = true, 
	Inherited = true)]
public sealed class RegisterEditorExtensionAttribute : RegistrationAttribute

NameDescription
System_CAPS_pubmethodRegisterEditorExtensionAttribute(Object, String, Int32)

Initializes a new RegisterEditorExtensionAttribute for the supplied factory type and extension.

NameDescription
System_CAPS_pubpropertyEditorFactoryNotify

Gets or sets whether or not to create the EditorFactoryNotify registry key on registration.

System_CAPS_pubpropertyExtension

Gets the file extension of the file.

System_CAPS_pubpropertyFactory

Gets the editor factory GUID.

System_CAPS_pubpropertyNameResourceID

Gets or sets the name resource ID.

System_CAPS_pubpropertyPriority

Gets the priority of this extension registration.

System_CAPS_pubpropertyProjectGuid

Gets or sets the project GUID.

System_CAPS_pubpropertyTemplateDir

Gets or sets the template directory.

System_CAPS_pubpropertyTypeId

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

Apply the RegisterEditorExtensionAttribute attribute to classes implementing an editor factory

This attribute associates a file extension with a given editor factory. The file extension should include the prefixing ".".

This attribute is used only for registration purposes and does not affect runtime behavior. It should be placed on a package class.

Each editor factory also has an associated priority. For a given file extension, the editors with the highest priority number are 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 use RegisterEditorExtensionAttribute, place it on a package class, such as Package or IVsPackage.

The following registry entry is created by RegisterEditorExtensionAttribute:

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

Note   The GUIDS for the Visual C# and Visual Basic project types are:

C#: {FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}

VB: {F184B08F-C81C-45F6-A57F-5ABD9991F28F}

You can find implementations of RegisterEditorExtensionAttribute in the managed samples. The standard location for this and all other attributes used for automatic registration is adjacent to the implementation of Package in VsPkg.cs, VsPkg.vb, or VsPkg.cpp, depending on the language used in the sample.

System_CAPS_noteNote

C# automatically appends the word Attribute to the name of any attribute class. In C# code, refer to this attribute as RegisterEditorExtension.

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: