BaseEditorFactory.CreateEditorInstance Method

Creates an editor instance.

Namespace:  Microsoft.VisualStudio.Data.Schema.Project.Common.UI
Assembly:  Microsoft.VisualStudio.Data.Schema.Project (in Microsoft.VisualStudio.Data.Schema.Project.dll)

Syntax

'Declaration
Public Overridable Function CreateEditorInstance ( _
    createFlags As UInteger, _
    fileName 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 cmdUI As Guid, _
    <OutAttribute> ByRef createDocWinFlags As Integer _
) As Integer
'Usage
Dim instance As BaseEditorFactory
Dim createFlags As UInteger
Dim fileName As String
Dim physicalView As String
Dim hierarchy As IVsHierarchy
Dim itemId As UInteger
Dim existingDocData As IntPtr
Dim docView As IntPtr
Dim docData As IntPtr
Dim editorCaption As String
Dim cmdUI As Guid
Dim createDocWinFlags As Integer
Dim returnValue As Integer

returnValue = instance.CreateEditorInstance(createFlags, _
    fileName, physicalView, hierarchy, _
    itemId, existingDocData, docView, _
    docData, editorCaption, cmdUI, createDocWinFlags)

public virtual int CreateEditorInstance(
    uint createFlags,
    string fileName,
    string physicalView,
    IVsHierarchy hierarchy,
    uint itemId,
    IntPtr existingDocData,
    out IntPtr docView,
    out IntPtr docData,
    out string editorCaption,
    out Guid cmdUI,
    out int createDocWinFlags
)

public:
virtual int CreateEditorInstance(
    unsigned int createFlags, 
    String^ fileName, 
    String^ physicalView, 
    IVsHierarchy^ hierarchy, 
    unsigned int itemId, 
    IntPtr existingDocData, 
    [OutAttribute] IntPtr% docView, 
    [OutAttribute] IntPtr% docData, 
    [OutAttribute] String^% editorCaption, 
    [OutAttribute] Guid% cmdUI, 
    [OutAttribute] int% createDocWinFlags
)

public function CreateEditorInstance(
    createFlags : uint, 
    fileName : String, 
    physicalView : String, 
    hierarchy : IVsHierarchy, 
    itemId : uint, 
    existingDocData : IntPtr, 
    docView : IntPtr, 
    docData : IntPtr, 
    editorCaption : String, 
    cmdUI : Guid, 
    createDocWinFlags : int
) : int

abstract CreateEditorInstance : 
        createFlags:uint32 * 
        fileName:string * 
        physicalView:string * 
        hierarchy:IVsHierarchy * 
        itemId:uint32 * 
        existingDocData:IntPtr * 
        docView:IntPtr * 
        docData:IntPtr * 
        editorCaption:string * 
        cmdUI:Guid * 
        createDocWinFlags:int -> int 
override CreateEditorInstance : 
        createFlags:uint32 * 
        fileName:string * 
        physicalView:string * 
        hierarchy:IVsHierarchy * 
        itemId:uint32 * 
        existingDocData:IntPtr * 
        docView:IntPtr * 
        docData:IntPtr * 
        editorCaption:string * 
        cmdUI:Guid * 
        createDocWinFlags:int -> int 

Parameters

• createFlags
  Type: System.UInt32
  The creation flags.

• fileName
  Type: System.String
  The file name

• physicalView
  Type: System.String
  Contains extra information particular to this instance of the view

• hierarchy
  Type: Microsoft.VisualStudio.Shell.Interop.IVsHierarchy
  The hierarchy

• itemId
  Type: System.UInt32
  The item ID

• existingDocData
  Type: System.IntPtr
  The existing document data

• docView
  Type: System.IntPtr%
  The resulting document view

• docData
  Type: System.IntPtr%
  The resulting document data

• editorCaption
  Type: System.String%
  The text that appears next to the file name on the document tab

• cmdUI
  Type: System.Guid%
  The resulting command UI

• createDocWinFlags
  Type: System.Int32%
  The resulting create document window flags

Return Value

Type: System.Int32
Returns VSConstants.S_OK on success.

Implements

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

Remarks

Each editor factory must implement this to return the specific control and data.

.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

BaseEditorFactory Class

BaseEditorFactory Members

Microsoft.VisualStudio.Data.Schema.Project.Common.UI Namespace