EditorFactory.CreateEditorInstance Method

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
Protected Overridable 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

protected virtual int 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
)

protected:
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
)

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 
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 

protected function CreateEditorInstance(
    createDocFlag : uint, 
    monikerDocument : String, 
    physicalView : String, 
    hierarchy : IVsHierarchy, 
    itemId : uint, 
    existingDocData : IntPtr, 
    docView : IntPtr, 
    docData : IntPtr, 
    editorCaption : String, 
    guidCmdUI : Guid, 
    canceled : int
) : int

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.

• hierarchy
  Type: Microsoft.VisualStudio.Shell.Interop.IVsHierarchy
  An IVsHierarchy value.

• itemId
  Type: System.UInt32
  A uint value that identifies this instance.

• existingDocData
  Type: System.IntPtr
  An IntPtr value.

• docView
  Type: System.IntPtr%
  An IntPtr value.

• docData
  Type: System.IntPtr%
  An IntPtr value.

• editorCaption
  Type: System.String%
  (Output) The editor caption.

• 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 .

.NET Framework Security

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

EditorFactory Class

Microsoft.VisualStudio.TestTools.Vsip Namespace

Interop