Package.RegisterEditorFactory(IVsEditorFactory) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell

Assembly:: Microsoft.VisualStudio.Shell.14.0.dll

Assembly:: Microsoft.VisualStudio.Shell.15.0.dll

Package:: Microsoft.VisualStudio.Shell.15.0 v17.12.40392

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Registers an editor factory with Visual Studio.

protected:
 void RegisterEditorFactory(Microsoft::VisualStudio::Shell::Interop::IVsEditorFactory ^ factory);

protected:
 void RegisterEditorFactory(Microsoft::VisualStudio::Shell::Interop::IVsEditorFactory ^ factory);

void RegisterEditorFactory(Microsoft::VisualStudio::Shell::Interop::IVsEditorFactory const & factory);

protected void RegisterEditorFactory (Microsoft.VisualStudio.Shell.Interop.IVsEditorFactory factory);

member this.RegisterEditorFactory : Microsoft.VisualStudio.Shell.Interop.IVsEditorFactory -> unit

Protected Sub RegisterEditorFactory (factory As IVsEditorFactory)

Parameters

factory: IVsEditorFactory

The editor factory to register.

Exceptions

ArgumentNullException

factory is null.

Remarks

To register an editor factory for a VSPackage, perform the following steps:

Add a RegisterEditorExtensionAttribute to your Package class.
Override the Initialize method. In your implementation of the Initialize method, call the RegisterEditorFactorymethod and pass the instance of your editor factory.

Editor factories are automatically unregistered when the package is disposed. If the editor factory object implements IDisposable, its Dispose method is called after the factory has been unregistered with Visual Studio.

Applies to

Sdílet prostřednictvím