Související služby a rozhraní (balíček VSPackage správy zdrojového kódu)
Tato část obsahuje seznam všech rozhraní souvisejících se správou zdrojového kódu v sadě Visual Studio SDK. Balíček VSPackage správy zdrojového kódu implementuje některá z těchto rozhraní a používá jiné k provádění úloh správy zdrojového kódu.
Rozhraní implementovaná balíčky VSPackage a pro správu zdrojového kódu
Následující rozhraní jsou popsána v sadě Visual Studio SDK a balíček VSPackage správy zdrojového kódu implementuje podmnožinu v závislosti na požadované sadě funkcí. Některá rozhraní jsou označená jako povinná a musí být implementována každým balíčkem VSPackage správy zdrojového kódu.
Pro rozhraní, která balíček neimplementuje, sada Visual Studio poskytuje výchozí implementaci. Všimněte si, že výchozí implementace je určena pro případ, kdy není registrován žádný balíček VSPackage a není řízen žádný projekt. Správně napsaná sada VSPackage správy zdrojového kódu implementuje všechna potřebná rozhraní a neopouští je na výchozí implementaci těchto rozhraní.
Balíček VSPackage správy zdrojového kódu musí implementovat privátní službu, která zapouzdřuje některá nebo všechna následující rozhraní.
Rozhraní jsou:
Povinné: Příslušná entita (balíček VSPackage správy zdrojového kódu, zástupný kód správy zdrojového kódu, projekt) musí implementovat rozhraní.
Doporučeno: Entita by měla implementovat toto rozhraní; jinak může být funkce správy zdrojového kódu omezená.
Volitelné: Entita může implementovat toto rozhraní, aby poskytovala bohatší sadu funkcí.
| Rozhraní | Účel | Implementoval | Implementovat? |
|---|---|---|---|
| IVsQueryEditQuerySave2 | Editory volají toto rozhraní před úpravou nebo uložením souboru. Balíček VSPackage správy zdrojového kódu může rezervovat soubor nebo zakázat operaci, pokud se rezervace nezdaří. | Balíček VSPackage správy zdrojového kódu | Doporučené |
| IVsSccManager2 | Toto rozhraní poskytuje základní funkce správy zdrojového kódu pro projekty, jako je registrace a zrušení registrace projektů se správou zdrojového kódu a poskytování podpory základních glyfů správy zdrojového kódu. | Balíček VSPackage správy zdrojového kódu | Požaduje se |
| IVsSccProject2 | Toto rozhraní je získáno z IVsHierarchy funkce nebo QueryInterface jednoduše přetypováním objektu implementované IVsHierarchy na IVsSccProject2. Používá se k získání souborů ve správě zdrojového kódu v projektu nebo k informování projektu o aktuálním stavu nebo umístění správy zdrojového kódu. |
Projekt | Požaduje se |
| IVsSccProvider | Modul integrace používá toto rozhraní k nastavení aktuálního aktivního balíčku VSPackage. | Balíček VSPackage správy zdrojového kódu | Požaduje se |
| IVsTrackProjectDocuments2 | Toto rozhraní je založené na modelu předplatného. Jakýkoli balíček VSPackage může signalizovat, že chce přijímat události dokumentu a doporučovat prostředí událostí, ke kterým dochází. Je implementována a zpracována sadou Visual Studio, která následně předává události implementované IVsTrackProjectDocumentsEvents2 do balíčku VSPackage. |
Zástupný kód správy zdrojového kódu | Požaduje se |
| IVsTrackProjectDocuments3 | Toto rozhraní poskytuje dávkové zpracování, synchronizované operace čtení a zápisu a pokročilou OnQueryAddFiles metodu. |
Zástupný kód správy zdrojového kódu | Požaduje se |
| IVsTrackProjectDocumentsEvents2 | Průzkumník řešení a projekty toto rozhraní volají při přidání nových souborů do projektů nebo při přejmenování nebo odstranění souborů a složek z projektů. Balíček VSPackage správy zdrojového kódu může rezervovat soubor projektu nebo operaci zrušit. | Balíček VSPackage správy zdrojového kódu | Doporučené |
| IVsTrackProjectDocumentsEvents3 | Průzkumník řešení a projekty volají toto rozhraní v reakci na volání metod rozhraní IVstrackProjectDocuments3. Balíček VSPackage správy zdrojového kódu může sledovat dávkové operace, synchronizované operace čtení a zápisu a pracovat s pokročilejší OnQueryAddFiles metodou. |
Balíček VSPackage správy zdrojového kódu | Doporučené |
| IVsSccEnlistmentPathTranslation | Toto rozhraní poskytuje podporu správy zařazení pro webové projekty. | Balíček VSPackage správy zdrojového kódu | Doporučené |
| IVsSccManagerTooltip | Toto rozhraní slouží k načtení nástroje Tipy pro zdrojové soubory v projektech. | Balíček VSPackage správy zdrojového kódu | Volitelné |
| IVsSccOpenFromSourceControl | Toto rozhraní poskytuje podporu rozšíření oboru názvů. | Balíček VSPackage správy zdrojového kódu | Volitelné |
| IVsSccControlNewSolution | Balíček VSPackage používá toto rozhraní k integraci rozšíření oboru názvů do dialogových oken Nový, Otevřít nebo Uložit . V důsledku toho lze projekty automaticky přidat do správy zdrojového kódu při vytváření nebo přidat do správy zdrojového kódu, pokud je operace uložení účinná. | Balíček VSPackage správy zdrojového kódu | Volitelné |
| IVsSccGlyphs | Balíček VSPackage používá toto rozhraní k definování dalších glyfů jako glyfy správy zdrojového kódu pro uzly v Průzkumník řešení. | Balíček VSPackage správy zdrojového kódu | Volitelné |
| IVsSccAddWebProjectFromSourceControl | Toto rozhraní používá dialogové okno Přidat pro webové projekty. Poskytuje metody pro procházení umístění správy zdrojového kódu a pro otevření webového projektu dříve přidaného v úložišti správy zdrojového kódu v tomto umístění. | Balíček VSPackage správy zdrojového kódu | Doporučené |
| IVsAsynchOpenFromScc | Toto rozhraní poskytuje podporu asynchronního (pozadí) načítání projektů ze správy zdrojového kódu. | Balíček VSPackage správy zdrojového kódu | Volitelné |
| IVsAsynchOpenFromSccProjectEvents | Toto rozhraní umožňuje projektům sledovat průběh asynchronního načítání iniciovaného IVsAsynchOpenFromScc. | Projekt | Volitelné |
| IVsSccToolsOptions | Toto rozhraní umožňuje integrovanému vývojovému prostředí dotazovat aktivní balíček VSPackage správy zdrojového kódu. Integrované vývojové prostředí (IDE) se dotazuje na hodnotu nastavení správy zdrojového kódu, která mají význam, i když není zaregistrovaná žádná aktivní sada VSPackage. Toto rozhraní je implementováno a zpracováno sadou Visual Studio. | Zástupný kód správy zdrojového kódu | Požaduje se |
| IVsRegisterScciProvider | Toto rozhraní se používá při registraci balíčku VSPackage správy zdrojového kódu. | Zástupný kód správy zdrojového kódu | Požaduje se |
| SourceControl | Toto rozhraní se používá v automatizaci. Proto zpřístupňuje pouze funkce, které se dají spustit bez zobrazení uživatelského rozhraní. | Balíček VSPackage správy zdrojového kódu | Volitelné |
| IVsPersistSolutionProps | Toto rozhraní slouží k uložení nastavení správy zdrojového kódu do souboru řešení (.sln). Nastavení zahrnuje umístění správy zdrojového kódu a příznaky stavu správy zdrojového kódu. | Balíček VSPackage správy zdrojového kódu | Doporučené |
| IVsPersistSolutionOpts | Toto rozhraní slouží k uložení nastavení správy zdrojového kódu do souboru možností řešení (.suo). To může zahrnovat nastavení správy zdrojového kódu specifické pro uživatele, jako je umístění zařazení aktuálního uživatele. | Balíček VSPackage správy zdrojového kódu | Doporučené |
| IVsSolutionEvents3 | Toto rozhraní slouží k monitorování událostí, aby bylo možné provádět operace, jako je například vrácení souborů projektu před zavřením řešení nebo získání nových souborů ze správy zdrojového kódu při otevření projektu. | Balíček VSPackage správy zdrojového kódu | Doporučené |