EditorFactory.CreateEditorView Method

Definition

Namespace:

Microsoft.VisualStudio.Package

Assembly:

Microsoft.VisualStudio.Package.LanguageService.15.0.dll

Package:

Microsoft.VisualStudio.Package.LanguageService.15.0 v17.12.40392

Return docView IUnknown COM object.

public:
 virtual IntPtr CreateEditorView(System::String ^ moniker, Microsoft::VisualStudio::TextManager::Interop::IVsTextLines ^ buffer, System::String ^ physicalView, [Runtime::InteropServices::Out] System::String ^ % editorCaption, [Runtime::InteropServices::Out] Guid % cmdUI);

public virtual IntPtr CreateEditorView (string moniker, Microsoft.VisualStudio.TextManager.Interop.IVsTextLines buffer, string physicalView, out string editorCaption, out Guid cmdUI);

abstract member CreateEditorView : string * Microsoft.VisualStudio.TextManager.Interop.IVsTextLines * string * string * Guid -> nativeint
override this.CreateEditorView : string * Microsoft.VisualStudio.TextManager.Interop.IVsTextLines * string * string * Guid -> nativeint

Public Overridable Function CreateEditorView (moniker As String, buffer As IVsTextLines, physicalView As String, ByRef editorCaption As String, ByRef cmdUI As Guid) As IntPtr

Parameters

moniker

String

String form of the moniker identifier of the document in the project system. In the case of documents that are files, this is always the path to the file.

buffer

IVsTextLines

The buffer used to set the text buffer for all views in the code window.

physicalView

String

Name of the physical view.

editorCaption

String

Initial caption defined by the document editor for the document window. This is typically a string enclosed in square brackets, such as "[Form]". This value is passed as an input parameter to the CreateDocumentWindow(UInt32, String, IVsUIHierarchy, UInt32, IntPtr, IntPtr, Guid, String, Guid, IServiceProvider, String, String, Int32[], IVsWindowFrame) method. If the file is [ReadOnly] the caption will be set during load of the file.

cmdUI

Guid

GUID_TextEditorFactory

Returns

IntPtr

nativeint

If the method succeeds, it returns S_OK. If it fails, it returns an error code.