Metoda IVsExternalFilesManager2.AddDocumentEx — (UInt32, String, IntPtr, IntPtr, Guid, String, Guid, String, String, IServiceProvider, IntPtr, Int32, IVsWindowFrame)

Artykuł
10/14/2015

Programowo informuje projektu różne pliki, aby dodać węzeł, pozwala na kontrolę nad ikonę dla węzła i stwarza okazję do edytora dla usług kontekstowe kwerendy.

Przestrzeń nazw: Microsoft.VisualStudio.Shell.Interop
Zestaw: Microsoft.VisualStudio.Shell.Interop (w Microsoft.VisualStudio.Shell.Interop.dll)

Składnia

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

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

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

Function AddDocumentEx (
    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,
    pspContext As IServiceProvider,
    hicon As IntPtr,
    <OutAttribute> ByRef pfDefaultPosition As Integer,
    <OutAttribute> ByRef ppWindowFrame As IVsWindowFrame
) As Integer

Parametry

dwCDW
[w] Definiuje __VSCREATEDOCWIN flagi, które określają sposób tworzenia okna dokumentu.

pszMkDocument
[w] Ścieżka do dokumentu.Ta ścieżka jest używany przez środowisko do rejestracji tego widoku w uruchomiony dokumentu tabeli (RDT).

punkDocView
[w] Wskaźnik, aby IUnknown interfejsu dla obiektu widoku dokumentu mają być wyświetlane w tym oknie.

punkDocData
[w] Wskaźnik, aby IUnknown interfejsu obiekt reprezentujący obiekt danych dokumentu tego dokumentu w sytuacjach, w przypadku gdy istnieje rozdzielenie widoku lub danych.Na przykład edytor tekstu podstawowego ma widok obiektu tekstowego (VsTextView obiektu) i obiekt bufor tekstowy (VsTextBufferobiektu).Ten parametr może być null.Przekazując null powoduje, że środowisko do utworzenia wystąpienia domyślnego wykonania punkDocData w imieniu obiektu wywołującego.

rguidEditorType
[w] Unikatowy identyfikator fabryki edytora, że utworzone wystąpienie widok dokumentu i obiektów dataobjects dokumentu.Powinno to być GUID_NULL, jeśli dokument nie został skonstruowany przy użyciu edytora factory (wystąpienie jest tworzony z prywatnych wiedzy na temat konkretnego projektu).

pszPhysicalView
[w] Ciąg do identyfikacji typu widoku fizyczny dla edytora.

rguidCmdUI
[w] Określa identyfikator GUID, który wskazuje, który zestaw menu powinno być scalone z menu głównego kiedy ten dokument jest aktywny.Jest on używany do włączania widoczność polecenia i narzędzia systemu windows.

pszOwnerCaption
[w] Podpis początkowe określone przez właściciela dokumentu (to znaczy, projekt) w oknie dokumentu.Często jest to format: "NazwaProjektu – ItemName."

pszEditorCaption
[w] Podpis początkowe określone przez Edytor dokumentu w oknie dokumentu.Zazwyczaj jest to ciąg w nawiasach kwadratowych (na przykład [tylko do odczytu]).Początkowa wartość tego parametru jest zwracany jako parametr [out] w CreateEditorInstance metody.

pspContext
[out] Wskaźnik, aby IServiceProvider interfejsu.Can be null.Jest to usługodawca dodatkowe dostarczone przez wywołującego (projekt różne pliki), umożliwiając wywołującego podania dodatkowych kontekstu (poprzez zastosowanie usługi) do osadzony edytora.W ten sposób kiedy żądanie usługi sprawia, że obiekt osadzony, ramki próbuje spełnić to żądanie.Jeśli usługa nie jest świadczona przez ramki, pSP zostanie podjęta próba.Jeśli usługa nie zostaną znalezione, usługodawca globalnego środowiska jest kwerenda.

hicon
[w] Określa dojście do ikony.Pozwala określić ikonę dla węzła różne projektu.

pfDefaultPosition
[out] Może być null, jeśli obiekt wywołujący nie domyślne informacje o pozycji okna.trueJeśli nie wszystkie zapisane informacje o ostatniej pozycji tego okna narzędzia środowiska (oznacza to, że guidPersistenceSlot nie znaleziono), więc został umieszczony w niektórych lokalizacji domyślnej na ekranie.falseJeśli okno to został umieszczony, gdzie użytkownik ostatnio znajduje się i jej wielkości.

ppWindowFrame
[out] Wskaźnik, aby ramka zawierająca to edytor, który może służyć do manipulowania położenie, rozmiar, podpis i inne właściwości okna.Może również służyć do uzyskania IUnknown wskaźnika interfejsu osadzania (to znaczy punkDocView) lub punkDocData.

Wartość zwracana

Type: System.Int32

Jeśli metoda się powiedzie, zwraca S_OK.Jeśli nie powiedzie się, zwraca kod błędu.

Uwagi

Podpis COM

Z vsshell.idl:

HRESULT IVsExternalFilesManager2::AddDocumentEx(
   [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,
   [in] IServiceProvider *pspContext,
   [in] HICON hIcon,
   [out] BOOL *pfDefaultPosition,
   [out] IVsWindowFrame **ppWindowFrame
);

Podobny do AddDocument metody.Udostępnia dodatkowe funkcje określania ikonę różne projekty i stwarza okazję do edytora do kwerendy dla usług kontekstowych.

Zobacz też

Interfejs IVsExternalFilesManager2
Przestrzeń nazw Microsoft.VisualStudio.Shell.Interop

Powrót do początku

Udostępnij za pośrednictwem