Návod: Vytvoření průvodce

Článek
06/10/2015

Ve verzi Visual Studio 2013 jsou zastaralé doplňky.Doporučujeme upgradovat doplňky na rozšíření VSPackage.Další informace o upgradu najdete v tématu Nejčastější dotazy: Převádění doplňků na rozšíření VSPackage.

Průvodci jako Průvodce doplňkem jsou programy, které provedou uživatele řadou akcí ke splnění složitějšího, opakovaného nebo obtížného úkolu.Systém Windows například používá průvodce pro připojení k síťovým prostředkům, připojení k tiskárnám a tak dále.

V Visual Studio průvodci obecně požádají o odpovědi na řadu otázek, které vyžadují vstup od uživatele a výsledky pak použijí ke generování kódu.Průvodci však ne vždy zobrazují uživatelské rozhraní (UI).Mohou být naprogramovány na neviditelné generování kódu na pozadí.

Existují tři různé typy průvodců:

Noví průvodci projektu– Jak již název naznačuje, tito průvodci slouží ke generování nového kódu pro určitý typ projektu a poskytnou tak uživateli počáteční bod, ze kterého může přidat vlastní kód.Toto je nejčastěji používaný typ průvodce.
Průvodce Přidat novou položku– Tito průvodci se používají k přidání nových položek, jako jsou například webové formuláře, textové soubory, stránky HTML, XML stránky a tak dále, do projektu.
Vlastní průvodci – tito průvodci nejsou voláni z dialogového okna.Místo toho se volají přímo z doplňků, maker nebo jiných typů kódu.Mohou nebo nemusí zobrazit uživatelské rozhraní.V obou případech vygenerují kód.Tento typ průvodce se používá nejméně často.

Bez ohledu na druh průvodce mají všechny společné vlastnosti.

Existují objekty .NET, které implementují rozhraní IDTWizard a mají přidruženou metodu, Execute, která obsahuje kód pro spuštění v průvodci.
Všechny používají souboru .vsz k zobrazení sebe sama v Visual Studio.
Všechny generují kód nebo provádějí některé další úlohy.

Můžete přizpůsobit vzhled elementů v průvodcích, které vytvoříte.Průvodci jsou nejčastěji tvořeny jedním nebo více okny nebo stránkami.Stránky mohou obsahovat popisný obraz, jako v horní nebo v levé části stránky, popisek, pokyny a oblast, ve které budou navigační ovládací prvky, jako Další a Předchozí.

Proces vytvoření průvodců v Visual C++ se trochu liší od vytvoření standardních průvodců Visual Studio.Další informace o tom, jak vytvořit průvodce zaměřené na jazyk Visual C++ naleznete v tématech Návrh průvodce a Vytvoření vlastního průvodce.

[!POZNÁMKA]

Váš počítač může zobrazit jiné názvy nebo umístění pro některé prvky uživatelského rozhraní sady Visual Studio v následujících pokynech.Tyto prvky jsou určeny verzí aplikace Visual Studio a použitým nastavením.Další informace naleznete v tématu Přizpůsobení nastavení pro vývoj v sadě Visual Studio.

Příklad základního průvodce

Průvodce zadejte sady Visual Studio

Tento obrázek ukazuje panel průvodce doplňky, nový typ průvodce, který vás provede řadou kroků k vytvoření doplňku.Můžete přizpůsobit vzhled průvodců, ale Průvodce doplňkem je typickým příkladem stylu standardního typu průvodce.Dokončení průvodci se stanou přístupnými v šablonách v dialogovém okně Nový projekt nebo Přidat novou položku.

Následující příklad ukazuje, jak vytvořit základního průvodce a volitelně mu přidělit vlastní ikonu.

Vytvoření základního průvodce v jazyce Visual Basic a Visual C#

Spusťte Visual Studio jako správce.Registrace průvodce vyžaduje aktualizaci registru, proto potřebuje toto oprávnění.
Vytvořte nový projekt knihovny tříd s názvem MyNewWizard.
Přidání odkazů na EnvDTE a EnvDTE80 do projektu.

Klikněte pravým tlačítkem myši na projekt a klikněte na Přidat, Odkaz.Na kartě .NET dialogového okna Odkaz klikněte na tlačítko EnvDTE a EnvDTE80 a potom klikněte na tlačítko OK.

V modulu třídy jsou obsaženy odkazy na EnvDTE a EnvDTE80 a implementaci rozhraní IDTWizard.Pro tento příklad Visual C# musíte také přidat odkaz na System.Windows.Forms a System.Runtime.InteropServices.

Imports EnvDTE 
Imports EnvDTE80
Public Class Class1
    Implements IDTWizard

using System;
using System.Collections.Generic;
using System.Text;
using EnvDTE; 
using EnvDTE80; 
using System. Windows.Forms;

using System.Runtime.InteropServices;

namespace MyNewWizard
{

[ComVisible(true)]

[Guid("20184B81-7C38-4E02-A1E3-8D564EEC2D25"),

ProgId("MyNewWizard.Class1")]

    public class Class1 : IDTWizard
    {
    }
}

Po přidání příkazu Implements do Visual Basic umístěte kurzor na konec řádku a stiskněte klávesu enter, chcete-li automaticky vytvořit postup metody Execute.Pro aplikaci Visual C# však musíte ručně přidat proceduru Execute:

public class Class1 : IDTWizard
    {
    public void Execute(object Application,  
        int hwndOwner, ref object[] contextParams,  
        ref object[] customParams,  
        ref EnvDTE.wizardResult retval)

Přidejte kód, který má průvodce spustit, do postupu Execute.V tomto příkladu přidáme pouze jednoduché okno zprávy.

Měli byste postupovat následovně:

Imports EnvDTE
Imports EnvDTE80

Public Class Class1
    Implements IDTWizard

    Public Sub Execute(ByVal Application As Object, ByVal _
    hwndOwner As Integer, ByRef ContextParams() As Object, ByRef _
    CustomParams() As Object, ByRef retval As EnvDTE.wizardResult) _
    Implements EnvDTE.IDTWizard.Execute
        MsgBox("The wizard is now running.")
    End Sub
End Class

using System.Text;
using EnvDTE;
using EnvDTE80;
using System.Windows.Forms;
using System.Runtime.InteropServices;

namespace MyNewWizardCS
{
    public class Class1 : IDTWizard
    {

    public void Execute(object Application, 
        int hwndOwner, ref object[] contextParams, 
        ref object[] customParams, 
        ref EnvDTE.wizardResult retval)
    {
        MessageBox.Show("The wizard is now running.");
    }
}

}

Procedura Execute je volána po spuštění průvodce.

Klepněte pravým tlačítkem na projekt v Průzkumníkovi řešení a klepnutím na tlačítko Vlastnosti otevřete stránku Vlastnosti projektu, kde klepněte na tlačítko sestavení a zaškrtněte pole Zaregistrovat pro spolupráci s COM v dolní části stránky.
V souboru AssemblyInfo.cs vyhledejte atribut ComVisible a nastavte ho na true.
Sestavení projektu pro vytvoření knihovny tříd DLL kliknutím na Sestavit řešení v nabídce Sestavení.
Vytvoření textového souboru VSZ pro průvodce s názvem MyNewWizard.vsz.

Chcete-li to provést, vytvořte kopii existujícího souboru .vsz, například některý z těch, který je umístěn ve složce <Visual Studio Install Directory>\VC#\CSharpProjectItems\Windows Forms a přejmenujte ho na "MyNewWizard.vsz".

Soubor VSZ je textový soubor, který umožňuje Visual Studio rozpoznat průvodce a zobrazit jej v dialogovém okně Nový projekt nebo Přidat novou položku .Parametr Wizard by měl být nastaven na hodnotu progID (Project.Classname) projektu nebo na identifikátor GUID.Další informace naleznete v tématu Konfigurace souborů .Vsz ke spouštění průvodců.

[!POZNÁMKA]

Volitelně můžete také vytvořit soubor VSDir pro průvodce.Obsahuje informace, které se zobrazí jako popis pro průvodce v dialogovém okně Nový projekt nebo Nový soubor.Také umožňuje určit ikonu a její umístění v seznamu uspořádat.Další informace naleznete v tématu Přidávání průvodců do dialogových oken Přidat položku a Nový projekt pomocí souborů .Vsdir.

Nahraďte obsah souboru MyNewWizard.vsz následujícím:

VSWizard 7.0
Wizard=MyNewWizard.Class1
Param=First Item
Param=Second Item

Uložte nový soubor VSZ do adresáře, kde chcete zobrazit průvodce.

V tomto příkladu chceme, aby se průvodce zobrazil v dialogovém okně Přidat novou položku pro projekty Visual Basic, takže uložte soubor s příponou VSZ do následujícího adresáře: <Visual Studio Install Directory>\VB\VBProjectItems.
Ukončete aplikaci Visual Studio a pak ji znovu spusťte.

To vynutí čtení nového souboru .vsz v Visual Studio.
Vytvořte nový projekt aplikace Visual Basic, například projekt Aplikace systému Windows.
Klikněte pravým tlačítkem na projekt, přejděte na položku Přidat a poté klikněte na možnost Nová položka.

V dialogovém okně Přidat nové položky by se měl zobrazit nový průvodce (MyNewWizard).
Klepněte na tlačítko průvodce a klepněte na tlačítko Přidat.

Zobrazí se zpráva Průvodce je nyní spuštěn.

K zobrazení vlastní ikony pro nového průvodce

Umístěte soubor ikony se stejným základním názvem, jako soubor DLL, ale s příponou ICO, do stejného adresáře, kde se nachází soubor průvodce.

Například pokud má průvodce název MyNewWizard.dll, zadejte název souboru .ico MyNewWizard.ico.

-nebo-
Pokud jste vytvořili soubor VSDir, zadejte tam cestu k souboru ikony (ICO).

Viz také

Návod: Vytvoření průvodce

Příklad základního průvodce

Vytvoření základního průvodce v jazyce Visual Basic a Visual C#

K zobrazení vlastní ikony pro nového průvodce

Viz také

Úkoly

Referenční dokumentace

Koncepty

Další zdroje

Další materiály