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.9.0 (in Microsoft.VisualStudio.Shell.9.0.dll)

Syntax

'Declaration
<AttributeUsageAttribute(AttributeTargets.Class, AllowMultiple := True, Inherited := True)> _
<ObsoleteAttribute("RegisterEditorExtensionAttribute has been deprecated. Please use ProvideEditorExtensionAttribute instead.")> _
Public NotInheritable Class RegisterEditorExtensionAttribute _
    Inherits RegistrationAttribute

'Usage
Dim instance As RegisterEditorExtensionAttribute

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

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

public final class RegisterEditorExtensionAttribute extends RegistrationAttribute

Remarks

When to Call

Apply the RegisterEditorExtensionAttribute attribute to classes implementing an editor factory

Basic Usage

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.

Registry Entries

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}

Samples

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.

Inheritance Hierarchy

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

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.

See Also

Reference

RegisterEditorExtensionAttribute Members

Microsoft.VisualStudio.Shell Namespace

Other Resources

Determining Which Editor Opens a File in a Project

Managed VSPackage Registration Keys

Registering VSPackages (C#)