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

Artykuł
10/14/2015

Programowo informuje projektu różne pliki, aby dodać węzeł.

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

Składnia

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

Parametry

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

pszMkDocument
[w] Ścieżka do dokumentu.Środowiska używa tej ścieżki, aby zarejestrować widoku w uruchomiony dokumentu tabeli (RDT).

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

punkDocData
[w] Wskaźnik, aby IUnknown interfejsu obiekt reprezentujący obiekt danych dokumentu z dokumentu, która jest dodawana 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 (VsTextBuffer obiektu).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, utworzony widok i dokumentu obiekty danych instancji 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, jaki zestaw menu powinny być scalane w główny pasek menu Jeśli 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.

pfDefaultPosition
[out] Może być null , jeśli obiekt wywołujący nie chce, aby 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.

Implementuje

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

Uwagi

Podpis COM

Z 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
);

Bardzo podobny do CreateDocumentWindow metody.AddDocumentnie ma parametrów ItemId i pUIH (wskaźnik do IVsHierarchy) ponieważ projekt różne pliki przypisuje jej własnych ItemId i pUIH parą i używa pozostałej części AddDocument parametrów w celu utworzenia okna dokumentu.

Zobacz też

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

Powrót do początku

Udostępnij za pośrednictwem