EditorFactory.IVsEditorFactory.CreateEditorInstance Method

  • Article

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

This API supports the .NET Framework infrastructure and is not intended to be used directly from your code.

Used internally by the editor factory framework to initialize this EditorFactory object.

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

Syntax

'Declaration
Private Function CreateEditorInstance ( _
    createDocFlag As UInteger, _
    monikerDocument As String, _
    physicalView As String, _
    hierarchy As IVsHierarchy, _
    itemId As UInteger, _
    existingDocData As IntPtr, _
    <OutAttribute> ByRef docView As IntPtr, _
    <OutAttribute> ByRef docData As IntPtr, _
    <OutAttribute> ByRef editorCaption As String, _
    <OutAttribute> ByRef guidCmdUI As Guid, _
    <OutAttribute> ByRef canceled As Integer _
) As Integer Implements IVsEditorFactory.CreateEditorInstance

int IVsEditorFactory.CreateEditorInstance(
    uint createDocFlag,
    string monikerDocument,
    string physicalView,
    IVsHierarchy hierarchy,
    uint itemId,
    IntPtr existingDocData,
    out IntPtr docView,
    out IntPtr docData,
    out string editorCaption,
    out Guid guidCmdUI,
    out int canceled
)

private:
virtual int CreateEditorInstance(
    unsigned int createDocFlag, 
    String^ monikerDocument, 
    String^ physicalView, 
    IVsHierarchy^ hierarchy, 
    unsigned int itemId, 
    IntPtr existingDocData, 
    [OutAttribute] IntPtr  docView, 
    [OutAttribute] IntPtr  docData, 
    [OutAttribute] String^  editorCaption, 
    [OutAttribute] Guid  guidCmdUI, 
    [OutAttribute] int  canceled
) sealed = IVsEditorFactory::CreateEditorInstance

private abstract CreateEditorInstance : 
        createDocFlag:uint32 * 
        monikerDocument:string * 
        physicalView:string * 
        hierarchy:IVsHierarchy * 
        itemId:uint32 * 
        existingDocData:IntPtr * 
        docView:IntPtr byref * 
        docData:IntPtr byref * 
        editorCaption:string byref * 
        guidCmdUI:Guid byref * 
        canceled:int byref -> int  
private override CreateEditorInstance : 
        createDocFlag:uint32 * 
        monikerDocument:string * 
        physicalView:string * 
        hierarchy:IVsHierarchy * 
        itemId:uint32 * 
        existingDocData:IntPtr * 
        docView:IntPtr byref * 
        docData:IntPtr byref * 
        editorCaption:string byref * 
        guidCmdUI:Guid byref * 
        canceled:int byref -> int

JScript does not support explicit interface implementations.

Parameters

  • createDocFlag
    Type: System.UInt32

    A uint value where zero equals false and 1 equals true.

  • monikerDocument
    Type: System.String

    A string that contains the identifier of the document in the project system. If the document is a file, it must be a file path, but it can be a reference to records in a database table. Cannot be nulla null reference (Nothing in Visual Basic) or empty.

  • physicalView
    Type: System.String

    A string that contains the name of the physical view.

  • itemId
    Type: System.UInt32

    A uint value that identifies this instance.

  • guidCmdUI
    Type: System.Guid

    (Output) The command GUID.

  • canceled
    Type: System.Int32

    (Output) An int value that indicates whether the operation was canceled by the user.

Return Value

Type: System.Int32
S_OK .

Implements

IVsEditorFactory.CreateEditorInstance(UInt32, String, String, IVsHierarchy, UInt32, IntPtr, IntPtr , IntPtr , String , Guid , Int32 )

Remarks

This member is an explicit interface member implementation. It can be used only when the EditorFactory instance is cast to an IVsEditorFactory interface.

.NET Framework Security

See Also

Reference

EditorFactory Class

Microsoft.VisualStudio.TestTools.Vsip Namespace

IVsHierarchy

IVsEditorFactory