Método IVsExternalFilesManager2.AddDocument (UInt32, String, IntPtr, IntPtr, Guid, String, Guid, String, String, Int32, IVsWindowFrame)

Artigo
04/23/2016

Programaticamente, informa ao projeto arquivos diversos para adicionar um nó.

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

Sintaxe

int AddDocument(
    uint dwCDW,
    string pszMkDocument,
    IntPtr punkDocView,
    IntPtr punkDocData,
    [InAttribute] ref Guid rguidEditorType,
    string pszPhysicalView,
    [InAttribute] ref Guid rguidCmdUI,
    string pszOwnerCaption,
    string pszEditorCaption,
    out int pfDefaultPosition,
    out IVsWindowFrame ppWindowFrame
)

int AddDocument(
    unsigned int dwCDW,
    String^ pszMkDocument,
    IntPtr punkDocView,
    IntPtr punkDocData,
    [InAttribute] Guid% rguidEditorType,
    String^ pszPhysicalView,
    [InAttribute] Guid% rguidCmdUI,
    String^ pszOwnerCaption,
    String^ pszEditorCaption,
    [OutAttribute] int% pfDefaultPosition,
    [OutAttribute] IVsWindowFrame^% ppWindowFrame
)

abstract AddDocument : 
        dwCDW:uint32 *
        pszMkDocument:string *
        punkDocView:nativeint *
        punkDocData:nativeint *
        rguidEditorType:Guid byref *
        pszPhysicalView:string *
        rguidCmdUI:Guid byref *
        pszOwnerCaption:string *
        pszEditorCaption:string *
        pfDefaultPosition:int byref *
        ppWindowFrame:IVsWindowFrame byref -> int

Function AddDocument (
    dwCDW As UInteger,
    pszMkDocument As String,
    punkDocView As IntPtr,
    punkDocData As IntPtr,
    <InAttribute> ByRef rguidEditorType As Guid,
    pszPhysicalView As String,
    <InAttribute> ByRef rguidCmdUI As Guid,
    pszOwnerCaption As String,
    pszEditorCaption As String,
    <OutAttribute> ByRef pfDefaultPosition As Integer,
    <OutAttribute> ByRef ppWindowFrame As IVsWindowFrame
) As Integer

Parâmetros

dwCDW
[in] Define o __VSCREATEDOCWIN sinalizadores, que determinam como a janela de documento é criada.

pszMkDocument
[in] Caminho para o documento.O ambiente usa esse caminho para registrar o modo de exibição na tabela de documento em execução (RDT).

punkDocView
[in] Ponteiro para o IUnknown interface para o objeto de modo de exibição de documento a ser exibido na janela do documento.

punkDocData
[in] Ponteiro para o IUnknown interface de um objeto que representa o objeto de dados de documento do documento que está sendo adicionado em situações onde não há separação de dados ou modo de exibição.Por exemplo, o editor de texto principal tem um objeto de exibição de texto (VsTextView objeto) e o objeto de buffer de texto (VsTextBuffer objeto).Esse parâmetro pode ser null.Passando null faz com que o ambiente para criar uma instância de uma implementação padrão da punkDocData em nome do chamador.

rguidEditorType
[in] Identificador exclusivo da fábrica de editor que criou os objetos de dados de modo de exibição e o documento de uma instância do documento.Isso deve ser GUID_NULL se o documento não é construído utilizando uma fábrica de editor (ou seja, uma instância é criada com conhecimento particular de um projeto específico).

pszPhysicalView
[in] Seqüência de caracteres para identificar o tipo de exibição física para o editor.

rguidCmdUI
[in] Especifica o GUID que indica qual conjunto de menus deve ser mesclado na barra de menu principal, quando este documento está ativo.Ele é usado para ativar a visibilidade das janelas de ferramenta e comandos.

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, [somente leitura]).O valor inicial deste parâmetro é retornado como um parâmetro [out] na CreateEditorInstance método.

pfDefaultPosition
[out] Pode ser null se o chamador não quer que as informações de posição padrão da janela.trueSe o ambiente não tinha todas as informações salvas sobre a última posição desta janela de ferramenta (ou seja, guidPersistenceSlot não encontrado), portanto ele foi colocado em algum local padrão na tela.falseSe esta janela foi colocada onde o usuário última localizada e dimensionado a ele.

ppWindowFrame
[out] Ponteiro para o quadro que contém este editor, que pode ser usado para manipular o local, tamanho, legenda e outras propriedades da janela.Também pode ser usado para obter o IUnknown ponteiro de interface da incorporar (ou seja, o punkDocView ou o punkDocData).

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.

Implementações

IVsExternalFilesManager.AddDocument(UInt32, String, IntPtr, IntPtr, Guid, String, Guid, String, String, Int32, IVsWindowFrame)

Comentários

COM assinatura

De vsshell.idl:

HRESULT IVsExternalFilesManager2::AddDocument(
   [in] VSCREATEDOCWIN dwCDW,
   [in] LPCOLESTR pszMkDocument,
   [in] IUnknown *punkDocView,
   [in] IUnknown *punkDocData,
   [in] REFGUID rguidEditorType,
   [in] LPCOLESTR pszPhysicalView,
   [in] REFGUID rguidCmdUI,
   [in] LPCOLESTR pszOwnerCaption,
   [in] LPCOLESTR pszEditorCaption,
   [out] BOOL *pfDefaultPosition,
   [out] IVsWindowFrame **ppWindowFrame
);

Muito semelhante ao CreateDocumentWindow método.AddDocumentnão inclui os parâmetros ItemId e pUIH (um ponteiro para IVsHierarchy) porque o projeto arquivos diversos atribui seu próprio ItemId e o pUIH emparelhar e utiliza o resto da AddDocument parâmetros para criar uma janela de documento.

Consulte também

Interface IVsExternalFilesManager2
Namespace Microsoft.VisualStudio.Shell.Interop

Retornar ao topo

Compartilhar via