EditorFactory::CreateEditorInstance Method

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

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)

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
)

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

Community Additions

Show: