EditorFactory Class

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

Provides an abstract base class for other editor factories that support a single physical view.

This API is not CLS-compliant. The CLS-compliant alternative is [None.].

Inheritance Hierarchy

System.Object
  Microsoft.VisualStudio.TestTools.Vsip.EditorFactory

Namespace:  Microsoft.VisualStudio.TestTools.Vsip
Assembly:  Microsoft.VisualStudio.QualityTools.Vsip (in Microsoft.VisualStudio.QualityTools.Vsip.dll)

Syntax

'Declaration
<CLSCompliantAttribute(False)> _
Public MustInherit Class EditorFactory _
    Implements IVsEditorFactory
[CLSCompliantAttribute(false)]
public abstract class EditorFactory : IVsEditorFactory
[CLSCompliantAttribute(false)]
public ref class EditorFactory abstract : IVsEditorFactory
[<AbstractClass>]
[<CLSCompliantAttribute(false)>]
type EditorFactory =  
    class 
        interface IVsEditorFactory 
    end
public abstract class EditorFactory implements IVsEditorFactory

The EditorFactory type exposes the following members.

Constructors

  Name Description
Protected method EditorFactory Initializes a new instance of the EditorFactory class.

Top

Properties

  Name Description
Protected property EditorCaption Gets the caption that is appended to the file name to create the display name for this editor.
Protected property GuidCmdUI Returns a GUID that indicates which menu and toolbars will be displayed when the editor window is active.
Protected property VSServiceProvider Gets the service provider.

Top

Methods

  Name Description
Protected method Close Releases all cached interface pointers and cancels any event sinks.
Protected method CreateEditor When overridden in a derived class, creates and returns the editor panel for the specified data.
Protected method CreateEditorInstance Used internally by the editor factory framework to initialize this EditorFactory object.
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MapLogicalView Maps a logical view to a physical view.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method SetSite Initializes an editor in the environment.
Protected method ShouldOpenDocument Determines whether the specified document is a test and therefore should be opened.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IVsEditorFactory.Close Infrastructure. Closes the editor and releases all resources.
Explicit interface implemetationPrivate method IVsEditorFactory.CreateEditorInstance Infrastructure. Used internally by the editor factory framework to initialize this EditorFactory object.
Explicit interface implemetationPrivate method IVsEditorFactory.MapLogicalView Infrastructure. Maps the specified logical view to the actual physical view.
Explicit interface implemetationPrivate method IVsEditorFactory.SetSite Initializes an editor in the environment.

Top

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.TestTools.Vsip Namespace

IVsEditorFactory