IVsExternalFilesManager2.AddDocument(UInt32, String, IntPtr, IntPtr, Guid, String, Guid, String, String, Int32, IVsWindowFrame) 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.
Orienta de forma programática o projeto de arquivos diversos para adicionar um nó.
public:
int AddDocument(System::UInt32 dwCDW, System::String ^ pszMkDocument, IntPtr punkDocView, IntPtr punkDocData, Guid % rguidEditorType, System::String ^ pszPhysicalView, Guid % rguidCmdUI, System::String ^ pszOwnerCaption, System::String ^ pszEditorCaption, [Runtime::InteropServices::Out] int % pfDefaultPosition, [Runtime::InteropServices::Out] Microsoft::VisualStudio::Shell::Interop::IVsWindowFrame ^ % ppWindowFrame);
public int AddDocument (uint dwCDW, string pszMkDocument, IntPtr punkDocView, IntPtr punkDocData, ref Guid rguidEditorType, string pszPhysicalView, ref Guid rguidCmdUI, string pszOwnerCaption, string pszEditorCaption, out int pfDefaultPosition, out Microsoft.VisualStudio.Shell.Interop.IVsWindowFrame ppWindowFrame);
abstract member AddDocument : uint32 * string * nativeint * nativeint * Guid * string * Guid * string * string * int * IVsWindowFrame -> int
Public Function AddDocument (dwCDW As UInteger, pszMkDocument As String, punkDocView As IntPtr, punkDocData As IntPtr, ByRef rguidEditorType As Guid, pszPhysicalView As String, ByRef rguidCmdUI As Guid, pszOwnerCaption As String, pszEditorCaption As String, ByRef pfDefaultPosition As Integer, ByRef ppWindowFrame As IVsWindowFrame) As Integer
Parâmetros
- dwCDW
- UInt32
no Define os __VSCREATEDOCWIN sinalizadores, que determinam como a janela do documento é criada.
- pszMkDocument
- String
no Caminho para o documento. O ambiente usa esse caminho para registrar a exibição na tabela de documentos em execução (RDT).
- punkDocView
- IntPtr
no Ponteiro para a IUnknown interface do objeto de exibição de documento a ser exibido na janela do documento.
- punkDocData
- IntPtr
no Ponteiro para a IUnknown interface de um objeto que representa o objeto de dados de documento do documento que está sendo adicionado em situações em que há exibição ou separação de dados. 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. nullA passagem faz com que o ambiente crie uma instância de uma implementação padrão do punkDocData em nome do chamador.
- rguidEditorType
- Guid
no Identificador exclusivo da fábrica do editor que criou uma instância do modo de exibição de documento e dos objetos de dados de documento. Isso deve ser GUID_NULL se o documento não for construído usando uma fábrica de editor (ou seja, uma instância é criada com conhecimento privado de um projeto específico).
- pszPhysicalView
- String
no Cadeia de caracteres para identificar o tipo de exibição física do editor.
- rguidCmdUI
- Guid
no Especifica o GUID que indica qual conjunto de menus deve ser mesclado na barra de menus principal quando este documento estiver ativo. Ele é usado para ativar a visibilidade de comandos e janelas de ferramentas.
- pszOwnerCaption
- String
no Legenda inicial definida pelo proprietário do documento (ou seja, o projeto) para a janela do documento. Em geral, isso é do formato: "ProjectName – ItemName".
- pszEditorCaption
- String
no Legenda inicial definida pelo editor de documento para a janela do documento. Normalmente, essa é uma cadeia de caracteres entre colchetes (por exemplo, [somente leitura]). O valor inicial desse parâmetro é retornado como um parâmetro [out] no CreateEditorInstance(UInt32, String, String, IVsHierarchy, UInt32, IntPtr, IntPtr, IntPtr, String, Guid, Int32) método.
- pfDefaultPosition
- Int32
fora Pode ser null se o chamador não quiser as informações de posição padrão para a janela. true Se o ambiente não tiver nenhuma informação salva sobre a última posição desta janela de ferramentas (ou seja, guidPersistenceSlot não foi encontrado), por isso ele foi colocado em algum local padrão na tela. false Se essa janela foi colocada onde o usuário o modificou e o dimensionou pela última vez.
- ppWindowFrame
- IVsWindowFrame
fora Ponteiro para o quadro que contém este editor, que pode ser usado para manipular o local, o tamanho, a legenda e outras propriedades da janela. Ele também pode ser usado para obter o IUnknown ponteiro de interface da incorporação (ou seja, o punkDocView ou o punkDocData ).
Retornos
Se o método for bem-sucedido, retornará S_OK. Se falhar, retornará um código de erro.
Implementações
Comentários
Assinatura COM
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. AddDocument Não inclui os parâmetros ItemId e pUIH (um ponteiro para IVsHierarchy ) porque o projeto de arquivos diversos atribui seu próprio ItemId e o par e pUIH usa o restante dos AddDocument parâmetros para criar uma janela de documento.