Creating Custom Text Editors and Designers

The Visual Studio integrated development environment (IDE) can host different types of editor:

• The Visual Studio core editor

• Custom editors

• External Editors

• Designers

The following information helps you choose the type of editor you need.

Types of Editor

For information about the Visual Studio core editor, see Extending the Editor.

Custom Editors

A custom editor is one that is designed to work in specialized circumstances. For example, you might create an editor whose function is to read and write data to a specific repository, such as a Microsoft Exchange server. Choose a custom editor if you want an editor that works with your project type only or if you want an editor that has only a few specific commands. Note, however, that users will not be able to use a custom editor to edit standard Visual Studio projects.

A custom editor can use an editor factory and add information about the editor to the registry. However, the project type associated with the custom editor can instantiate the custom editor in other ways.

A custom editor can use either in-place activation or simplified embedding to implement a view.

External Editors

External editors are editors that are not integrated into Visual Studio, such as Microsoft Word, Notepad, or Microsoft FrontPage. You might call such an editor if, for example, you are passing text to it from your VSPackage. External editors register themselves and can be used outside Visual Studio. When you call an external editor, and it can be embedded in a host window, then it appears in a window in the IDE. If not, then the IDE creates a separate window for it.

The IsDocumentInProject method sets the document priority by using the VSDOCUMENTPRIORITY enumeration. If the DP_External value is specified, the file can be opened by an external editor.

Editor Design Decisions

The following design questions will help you to choose the type of editor best suited to your application:

• Will your application save its data in files or not? If it will save its data in files, will they be in a custom or standard format?

  If you use a standard file format, other project types in addition to your project will be able to open and read/write data to them. If you use a custom file format, however, only your project type will be able to open and read/write data to them.

  If your project uses files, then you should customize the standard editor. If your project does not use files, but rather uses items in a database or other repository, then you should create a custom editor.

• Does your editor need to host ActiveX controls?

  If your editor hosts ActiveX controls, then implement an in-place activation editor, as outlined in In-Place Activation. If it does not host ActiveX controls, then either use a simplified embedding editor, or customize the Visual Studio default editor.

• Will your editor support multiple views? You must support multiple views if you want views of your editor to be visible at the same time as the default editor.

  If your editor needs to support multiple views, the document data and document view objects for the editor must be separate objects. For more information, see Supporting Multiple Document Views.

  If your editor supports multiple views, do you plan to use the Visual Studio core editor's text buffer implementation (VsTextBuffer object) for your document data object? That is, do you want to support your editor view side-by-side with the Visual Studio core editor? The ability to do this is the basis of the forms designer..

• If you need to host an external editor , can the editor be embedded inside Visual Studio?

  If it can be embedded, you should create a host window for the external editor and then call the IsDocumentInProject method and set the VSDOCUMENTPRIORITY enumeration value to DP_External. If the editor cannot be embedded, the IDE will automatically create a separate window for it.

In This Section

• Walkthrough: Creating a Custom Editor
  Explains how to create a custom editor.

• Walkthrough: Adding Features to a Custom Editor
  Explains how to add features to a custom editor.

• Designer Initialization and Metadata Configuration
  Explains how to initialize a designer.

• Supplying Undo Support to Designers
  Explains how to provide undo support for designers.

• Syntax Coloring in Custom Editors
  Explains the difference between syntax coloring in the core editor and in custom editors.

• Document Data and Document View in Custom Editors
  Explains how to implement document data and document views in custom editors.

Related Sections

• Accessing the Editor By Using Legacy Interfaces
  Explains how to access the core editor by means of the legacy API.

• Developing a Language Service
  Explains how to implement a language service.

• User Interfaces
  Explains how to create UI elements that match the rest of Visual Studio.

See Also

Reference

IVsEditorFactory