RegisterEditorExtensionAttribute Class

Note: This API is now obsolete.

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

Inheritance Hierarchy

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

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

Syntax

'Declaration
<ObsoleteAttribute("RegisterEditorExtensionAttribute has been deprecated. Please use ProvideEditorExtensionAttribute instead.")> _
<AttributeUsageAttribute(AttributeTargets.Class, AllowMultiple := True, Inherited := True)> _
Public NotInheritable Class RegisterEditorExtensionAttribute _
    Inherits RegistrationAttribute
[ObsoleteAttribute("RegisterEditorExtensionAttribute has been deprecated. Please use ProvideEditorExtensionAttribute instead.")]
[AttributeUsageAttribute(AttributeTargets.Class, AllowMultiple = true, Inherited = true)]
public sealed class RegisterEditorExtensionAttribute : RegistrationAttribute
[ObsoleteAttribute(L"RegisterEditorExtensionAttribute has been deprecated. Please use ProvideEditorExtensionAttribute instead.")]
[AttributeUsageAttribute(AttributeTargets::Class, AllowMultiple = true, Inherited = true)]
public ref class RegisterEditorExtensionAttribute sealed : public RegistrationAttribute
[<Sealed>]
[<ObsoleteAttribute("RegisterEditorExtensionAttribute has been deprecated. Please use ProvideEditorExtensionAttribute instead.")>]
[<AttributeUsageAttribute(AttributeTargets.Class, AllowMultiple = true, Inherited = true)>]
type RegisterEditorExtensionAttribute =  
    class 
        inherit RegistrationAttribute 
    end
public final class RegisterEditorExtensionAttribute extends RegistrationAttribute

The RegisterEditorExtensionAttribute type exposes the following members.

Constructors

  Name Description
Public method RegisterEditorExtensionAttribute Initializes a new RegisterEditorExtensionAttribute for the supplied factory type and extension.

Top

Properties

  Name Description
Public property EditorFactoryNotify Gets or sets whether or not to create the EditorFactoryNotify registry key on registration.
Public property Extension Gets the file extension of the file.
Public property Factory Gets the editor factory GUID.
Public property NameResourceID Gets or sets the name resource ID.
Public property Priority Gets the priority of this extension registration.
Public property ProjectGuid Gets or sets the project GUID.
Public property TemplateDir Gets or sets the template directory.
Public property TypeId Gets the current instance of this attribute. (Inherited from RegistrationAttribute.)

Top

Methods

  Name Description
Public method Equals Infrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Public method GetHashCode Returns the hash code for this instance. (Inherited from Attribute.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method 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.)
Public method Match When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Public method Register Registers the editor extension. (Overrides RegistrationAttribute.Register(RegistrationAttribute.RegistrationContext).)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Public method Unregister Removes the editor extension registry key. (Overrides RegistrationAttribute.Unregister(RegistrationAttribute.RegistrationContext).)

Top

Explicit Interface Implementations

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

Top

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.

Note

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

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

Microsoft.VisualStudio.Shell Namespace

Other Resources

Determining Which Editor Opens a File in a Project

Managed Package Registration

Registering VSPackages