Método IVsUIShellOpenDocument.InitializeEditorInstance (UInt32, IntPtr, IntPtr, String, Guid, String, Guid, String, String, IVsUIHierarchy, UInt32, IntPtr, IServiceProvider, Guid, IVsWindowFrame)

  • Artigo

 

Publicado: abril de 2016

Inicializa uma instância do editor do documento.

Namespace:   Microsoft.VisualStudio.Shell.Interop
Assembly:  Microsoft.VisualStudio.Shell.Interop (em Microsoft.VisualStudio.Shell.Interop.dll)

Sintaxe

int InitializeEditorInstance(
    uint grfIEI,
    IntPtr punkDocView,
    IntPtr punkDocData,
    string pszMkDocument,
    [InAttribute] ref Guid rguidEditorType,
    string pszPhysicalView,
    [InAttribute] ref Guid rguidLogicalView,
    string pszOwnerCaption,
    string pszEditorCaption,
    IVsUIHierarchy pHier,
    uint itemid,
    IntPtr punkDocDataExisting,
    IServiceProvider pSPHierContext,
    [InAttribute] ref Guid rguidCmdUI,
    out IVsWindowFrame ppWindowFrame
)

int InitializeEditorInstance(
    unsigned int grfIEI,
    IntPtr punkDocView,
    IntPtr punkDocData,
    String^ pszMkDocument,
    [InAttribute] Guid% rguidEditorType,
    String^ pszPhysicalView,
    [InAttribute] Guid% rguidLogicalView,
    String^ pszOwnerCaption,
    String^ pszEditorCaption,
    IVsUIHierarchy^ pHier,
    unsigned int itemid,
    IntPtr punkDocDataExisting,
    IServiceProvider^ pSPHierContext,
    [InAttribute] Guid% rguidCmdUI,
    [OutAttribute] IVsWindowFrame^% ppWindowFrame
)

abstract InitializeEditorInstance : 
        grfIEI:uint32 *
        punkDocView:nativeint *
        punkDocData:nativeint *
        pszMkDocument:string *
        rguidEditorType:Guid byref *
        pszPhysicalView:string *
        rguidLogicalView:Guid byref *
        pszOwnerCaption:string *
        pszEditorCaption:string *
        pHier:IVsUIHierarchy *
        itemid:uint32 *
        punkDocDataExisting:nativeint *
        pSPHierContext:IServiceProvider *
        rguidCmdUI:Guid byref *
        ppWindowFrame:IVsWindowFrame byref -> int

Function InitializeEditorInstance (
    grfIEI As UInteger,
    punkDocView As IntPtr,
    punkDocData As IntPtr,
    pszMkDocument As String,
    <InAttribute> ByRef rguidEditorType As Guid,
    pszPhysicalView As String,
    <InAttribute> ByRef rguidLogicalView As Guid,
    pszOwnerCaption As String,
    pszEditorCaption As String,
    pHier As IVsUIHierarchy,
    itemid As UInteger,
    punkDocDataExisting As IntPtr,
    pSPHierContext As IServiceProvider,
    <InAttribute> ByRef rguidCmdUI As Guid,
    <OutAttribute> ByRef ppWindowFrame As IVsWindowFrame
) As Integer

Parâmetros

  • grfIEI
    [in] Controlando a inicialização do editor de sinalizadores.Para obter uma lista dos valores de enumeração, consulte __VSIEIFLAGS.Se você especificar um valor de IEI_DoNotLoadDocData para este parâmetro, em seguida, esse método não tenta carregar o DocData chamando LoadDocData.
  • punkDocView
    [in] Ponteiro para o IUnknown interface do objeto de dados do documento.
  • punkDocData
    [in] Ponteiro para o IUnknown interface do objeto de dados do documento.
  • pszMkDocument
    [in] Formulário do identificador exclusivo do identificador de origem do documento em seqüência no sistema de projeto, por exemplo, o caminho completo para o arquivo.Em casos diferentes de arquivos, esse identificador é muitas vezes na forma de um URL.
  • rguidEditorType
    [in]GUID do tipo de editor.
  • pszPhysicalView
    [in] Nome do modo de exibição físico.
  • rguidLogicalView
    [in] GUID que identifica o modo de exibição lógico.Para obter uma lista de GUIDS de exibição lógica, consulte modos de exibição lógico e físico.Se você implementar IVsMultiViewDocumentView em seu objeto de dados do documento, em seguida, o valor passado para o rguidLogicalView parâmetro determina o modo de exibição é ativado quando a janela do editor é exibida.A janela do editor é exibida quando o editor é instanciado.Especificando o modo de exibição lógico GUID, o chamador de IVsUIShellOpenDocument::InitializeEditorInstance pode solicitar o modo de exibição específico que coincida com o motivo pelo qual o chamador está solicitando o modo de exibição.Por exemplo, o chamador deve especificar LOGVIEWID_Debugging para obter o modo de exibição apropriado para depuração de modo de exibição, ou LOGVIEWID_TextView para obter o modo de exibição apropriado para o editor de texto (ou seja, um modo de exibição que implementa IVsCodeWindow).
  • pszOwnerCaption
    [in] Legenda inicial definida pelo proprietário do documento (ou seja, o projeto) da janela do documento.Isso geralmente está no formato: "Nomedoprojeto – ItemName".
  • pszEditorCaption
    [in] Legenda inicial definida pelo editor do documento da janela do documento.Isso costuma ser uma seqüência de caracteres entre colchetes (por exemplo, [formulário]).O valor inicial deste parâmetro é retornado como um parâmetro [out] na CreateEditorInstance método.
  • pHier
    [in] Ponteiro para o IVsUIHierarchy interface do projeto que contém o documento.
  • itemid
    [in] Identificador de item de hierarquia de interface do usuário do documento no sistema de projeto.Para obter mais informações, consulte: VSITEMID.
  • punkDocDataExisting
    [in] Ponteiro para o IUnknown interface do objeto document dados se os dados do documento o objeto já existe na tabela de documento em execução.
  • pSPHierContext
    [in] Provedor de serviços de projeto específico.Para obter mais informações, consulte IServiceProvider.
  • rguidCmdUI
    [in] Comando GUID de interface do usuário dos comandos a serem exibidas para este editor.
  • ppWindowFrame
    [out, retval] O quadro de janela que contém o editor.Para obter mais informações, consulte IVsWindowFrame.

Valor de retorno

Type: System.Int32

Se o método for bem-sucedido, ele retorna S_OK.Se ele falhar, ele retorna um código de erro.

Comentários

COM assinatura

De vsshell.idl:

HRESULT IVsUIShellOpenDocument::InitializeEditorInstance(
   [in] VSIEIFLAGS grfIEI,
   [in] IUnknown *punkDocView,
   [in] IUnknown *punkDocData,
   [in] LPCOLESTR pszMkDocument,
   [in] REFGUID rguidEditorType,
   [in] LPCOLESTR pszPhysicalView,
   [in] REFGUID rguidLogicalView,
   [in] LPCOLESTR pszOwnerCaption,
   [in] LPCOLESTR pszEditorCaption,
   [in] IVsUIHierarchy *pHier,
   [in] VSITEMID itemid,
   [in] IUnknown *punkDocDataExisting,
   [in] IServiceProvider *pSPHierContext,
   [in] REFGUID rguidCmdUI,
   [out, retval] IVsWindowFrame **ppWindowFrame
);

Editores podem ser inicializados para documentos baseados em arquivos e documentos que não sejam baseados em arquivo.Porque IVsUIShellOpenDocument.InitializeEditorInstance leva pszMkDocumentString como um parâmetro de entrada, este método oferece suporte ao inicializar os editores de baseado em arquivo e não baseados em arquivo.

IVsUIShellOpenDocument.InitializeEditorInstanceé uma função auxiliar chamada CreateEditorInstance.InitializeEditorInstancechama os seguintes métodos na ordem:

Consulte também

Interface IVsUIShellOpenDocument
Namespace Microsoft.VisualStudio.Shell.Interop

Retornar ao topo