IVsAsyncShellOpenDocument.OpenSpecificEditorAsync Método
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
Abre de forma assíncrona um documento usando o editor especificado.
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
Parâmetros
- openSpecificEditorFlags
- UInt32
Sinalizadores cujos valores são retirados da __VSOSPEFLAGS enumeração .
- documentMoniker
- String
Forma de cadeia de caracteres do identificador de moniker exclusivo do documento no sistema de projeto, por exemplo, o caminho completo para o arquivo. Em casos que não são de arquivo, esse identificador geralmente está na forma de uma URL.
- physicalView
- String
Nome do modo de exibição físico ou null
.
Se null
, o ambiente chamará MapLogicalView(Guid, String)
na fábrica do editor para determinar a exibição física que corresponde à exibição lógica.
Nesse caso, null
não especifica a exibição primária, mas indica que você não sabe qual exibição corresponde à exibição lógica.
- logicalView
- Guid
Um Guid que identifica a exibição lógica. O modo de exibição padrão é VSConstants.LOGVIEWID_Primary
e cada editor deve dar suporte a essa exibição.
Se o editor implementar IVsMultiViewDocumentView no objeto de exibição de documento, o valor passado para ActivateLogicalView(Guid), que determina qual exibição é ativada quando a janela do editor é mostrada.
Ao especificar o modo de exibição lógico Guid, você pode solicitar a exibição específica que corresponda ao motivo pelo qual você está solicitando a exibição.
Por exemplo, especifique VSConstants.LOGVIEWID_Debugging
IVsCodeWindowpara obter a exibição apropriada para depuração ou VSConstants.LOGVIEWID_TextView
para obter a exibição apropriada para o editor de texto (ou seja, uma exibição que implementa ).
- ownerCaption
- String
A legenda inicial definida pelo proprietário do documento (ou seja, o projeto) para a janela do documento. Isso geralmente é do formato: "ProjectName – ItemName".
- hierarchy
- IVsUIHierarchy
Uma referência ao IVsUIHierarchy que possui o documento.
- itemId
- UInt32
O identificador de item de hierarquia de interface do usuário do editor padrão. Para obter mais informações, consulte VSConstants.VSITEMID
.
- shouldGetDocDataFromRdt
- Boolean
Se true
, o ambiente usará o objeto de dados do documento obtido da Tabela de Documentos em Execução; caso contrário, o serviço abrirá o documento usando os dados do documento passados para docData
.
- docData
- Object
Uma referência ao objeto de dados do documento do item a ser aberto ou null
. Esse valor passado para esse parâmetro será ignorado se shouldGetDocDataFromRdt
for true
.
- serviceProvider
- IServiceProvider
Uma referência ao IServiceProvider.
Retornos
Uma tarefa que representa que a operação aberta foi iniciada.
O resultado da tarefa é uma referência a um IVsAsyncOpenDocumentResult, se o documento foi aberto dentro do ambiente; caso contrário, null
.
Comentários
A tarefa retornada por esse método não indica que a exibição e o docdata do documento foram carregados. Consulte DocumentLoadTask para obter mais detalhes.