IVsAsyncShellOpenDocument.OpenStandardEditorAsync Método

Referência

Definição

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Interop.dll

Pacote:: Microsoft.VisualStudio.Interop v17.9.37000

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 um arquivo usando o editor padrão. Primeiro, ele determinará se uma fábrica de editor padrão para o arquivo já está configurada. Se um padrão ainda não estiver configurado, ele passará por uma lista de fábricas de editores classificadas com prioridade para localizar a primeira que dá suporte ao documento. Uma exceção será gerada se o documento não puder ser aberto.

public Microsoft.VisualStudio.Shell.Interop.IVsTask OpenStandardEditorAsync (uint openStandardEditorFlags, string documentMoniker, Guid logicalView, string? ownerCaption, Microsoft.VisualStudio.Shell.Interop.IVsUIHierarchy? hierarchy, uint itemId, bool shouldGetDocDataFromRdt, object? docData, Microsoft.VisualStudio.OLE.Interop.IServiceProvider serviceProvider);

abstract member OpenStandardEditorAsync : uint32 * string * Guid * string * Microsoft.VisualStudio.Shell.Interop.IVsUIHierarchy * uint32 * bool * obj * Microsoft.VisualStudio.OLE.Interop.IServiceProvider -> Microsoft.VisualStudio.Shell.Interop.IVsTask

Public Function OpenStandardEditorAsync (openStandardEditorFlags As UInteger, documentMoniker 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

openStandardEditorFlags: UInt32

Sinalizadores cujos valores são obtidos da __VSOSEFLAGS enumeração ou __VSOSEFLAGS2 .

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.

logicalView: Guid

Um Guid que identifica o modo de exibição lógico. A 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 a exibição Guidlógica , você pode solicitar a exibição específica que corresponde ao motivo pelo qual você está solicitando a exibição. Por exemplo, especifique VSConstants.LOGVIEWID_DebuggingIVsCodeWindowpara 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 formulário: "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 doc 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

IVsTask

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.

Esse método usa o resultado de CreateEditorInstance(UInt32, String, String, IVsHierarchy, UInt32, IntPtr, IntPtr, IntPtr, String, Guid, Int32) para determinar se ele deve continuar fazendo loop para o próximo editor na lista para encontrar uma fábrica de editores com suporte. Especificamente, ele deve retornar um dos seguintes: 1. S_OK para indicar que ele deve parar de fazer loop se o editor der suporte ao arquivo e tiver sido inicializado com êxito 2. "VS_E_UNSUPPORTEDFORMAT" para indicar que ele deve continuar em loop se o editor não der suporte aos dados do documento 3 fornecidos. Qualquer outro código de erro para indicar que ele deve parar de fazer loop.

Aplica-se a

Compartilhar via