IVsAsyncShellOpenDocument.OpenSpecificEditorAsync Метод
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Асинхронно открывает документ с помощью указанного редактора.
public Microsoft.VisualStudio.Shell.Interop.IVsTask OpenSpecificEditorAsync (uint openSpecificEditorFlags, string documentMoniker, Guid editorType, string? physicalView, Guid logicalView, string? ownerCaption, Microsoft.VisualStudio.Shell.Interop.IVsUIHierarchy? hierarchy, uint itemId, bool shouldGetDocDataFromRdt, object? docData, Microsoft.VisualStudio.OLE.Interop.IServiceProvider serviceProvider);
abstract member OpenSpecificEditorAsync : uint32 * string * Guid * string * Guid * string * Microsoft.VisualStudio.Shell.Interop.IVsUIHierarchy * uint32 * bool * obj * Microsoft.VisualStudio.OLE.Interop.IServiceProvider -> Microsoft.VisualStudio.Shell.Interop.IVsTask
Public Function OpenSpecificEditorAsync (openSpecificEditorFlags As UInteger, documentMoniker As String, editorType As Guid, physicalView As String, logicalView As Guid, ownerCaption As String, hierarchy As IVsUIHierarchy, itemId As UInteger, shouldGetDocDataFromRdt As Boolean, docData As Object, serviceProvider As IServiceProvider) As IVsTask
Параметры
- openSpecificEditorFlags
- UInt32
Флаги, значения которых взяты из перечисления __VSOSPEFLAGS .
- documentMoniker
- String
Строковая форма уникального моникера документа в системе проектов, например полный путь к файлу. В случаях, когда документ не является файлом, этот идентификатор часто имеет вид URL-адреса.
- physicalView
- String
Имя физического представления или null
.
Если null
, среда вызывает MapLogicalView(Guid, String)
на фабрике редактора, чтобы определить физическое представление, соответствующее логическому представлению.
В этом случае null
не задает первичное представление, а указывает, что неизвестно, какое представление соответствует логическому представлению.
- logicalView
- Guid
Объект , Guid определяющий логическое представление. По умолчанию используется представление , VSConstants.LOGVIEWID_Primary
и каждый редактор должен поддерживать это представление.
Если редактор реализует IVsMultiViewDocumentView в объекте представления документа, то значение, передаваемое в ActivateLogicalView(Guid), которое определяет, какое представление активируется при отображении окна редактора.
Указав логическое представление Guid, можно запросить конкретное представление, соответствующее причине запроса представления.
Например, укажите VSConstants.LOGVIEWID_Debugging
для получения представления, подходящего для отладки, или VSConstants.LOGVIEWID_TextView
для получения представления, подходящего для текстового редактора (т. е. представления, которое реализует IVsCodeWindow).
- ownerCaption
- String
Начальная подпись определяется владельцем документа (т. е. проектом) для окна документа. Часто имеет следующий формат: "Имя проекта – имя элемента".
- hierarchy
- IVsUIHierarchy
Ссылка на объект , IVsUIHierarchy которому принадлежит документ.
- itemId
- UInt32
Идентификатор элемента иерархии пользовательского интерфейса стандартного редактора. Дополнительные сведения см. в разделе VSConstants.VSITEMID
.
- shouldGetDocDataFromRdt
- Boolean
Если true
задано значение , среда будет использовать объект данных документа, полученный из таблицы выполняющихся документов; в противном случае служба откроет документ, используя данные документа, переданные в docData
.
- docData
- Object
Ссылка на объект данных документа открываемого элемента или null
. Это значение, передаваемое в этот параметр, игнорируется, если shouldGetDocDataFromRdt
имеет значение true
.
- serviceProvider
- IServiceProvider
Ссылка на IServiceProvider.
Возвращаемое значение
Задача, представляющая, что операция открытия запущена.
Результатом задачи является ссылка на IVsAsyncOpenDocumentResult, если документ был открыт в среде; в противном случае — null
значение .
Комментарии
Задача, возвращаемая этим методом, не указывает, что представление и docdata документа загружены. Дополнительные сведения см. в статье DocumentLoadTask.