Gewusst wie: Erstellen benutzerdefinierter Optionsseiten

Das Dialogfeld Optionen zeigt eine Reihe von Seiten für unterschiedliche Bestandteile von Visual Studio an. Sie können die vorhandenen Optionsseiten steuern, wie unter Steuern der Einstellungen im Dialogfeld "Optionen" (Menü "Extras") beschrieben, und Sie können eigene Seiten erstellen. Mithilfe benutzerdefinierter Seiten versetzen Sie andere Benutzer in die Lage, Einstellungen für Ihre Add-Ins oder andere Programme zu ändern.

Sie müssen kein Add-In verwenden, um eine eigene benutzerdefinierte Optionsseite zu erstellen, da die Seitendefinition in einer XML-Datei und nicht in Registrierungsschlüsseln gespeichert wird. Folglich können Sie nun Optionsseiten erstellen, auf die in der integrierten Entwicklungsumgebung von Visual Studio (Integrated Development Environment, IDE) sowie in den Makro-IDEs zugegriffen werden kann.

In den folgenden Schritten wird veranschaulicht, wie Sie ein benutzerdefiniertes Benutzersteuerelement erstellen, das als benutzerdefinierte Optionsseite fungiert, und inwiefern eine ADDIN-Datei verändert werden muss, damit sie auf das Steuerelement verweist.

Tipp

Je nach den aktiven Einstellungen oder der Version unterscheiden sich die Dialogfelder und Menübefehle auf Ihrem Bildschirm möglicherweise von den in der Hilfe beschriebenen. Bei der Entwicklung dieser Verfahren war die Option Allgemeine Entwicklungseinstellungen aktiviert. Klicken Sie im Menü Extras auf Einstellungen importieren und exportieren, um die Einstellungen zu ändern. Weitere Informationen finden Sie unter Arbeiten mit Einstellungen.

So erstellen Sie eine benutzerdefinierte Optionsseite

  1. Erstellen Sie ein Windows-Steuerelementbibliothek-Projekt. Nennen Sie es ToolsOptionsLibrary.dll.

  2. Fügen Sie die gewünschten Steuerelemente und die gewünschte Funktionalität hinzu.

    Dieses Benutzersteuerelement wird zur benutzerdefinierten Optionsseite. Passen Sie die Größe des Steuerelements an, sodass es in den Innenbereich des Dialogfelds Optionen passt.

  3. Erstellen Sie das Projekt.

    Visual Studio sucht beim Starten alle gemeinsamen ADDIN-Dateien und lädt die vorhandenen Dateien. Auf der Optionsseite mit dem Namen Add-In/Makrosicherheit werden Token für Dateipfade von ADDIN-Dateien festgelegt. Dazu gehören z. B. die folgenden:

    • %ALLUSERSPROFILE%

    • %APPDATA%

    • %USERPROFILE%

    • %VSAPPDATA%

    • %VSCOMMONAPPDATA%

    Wenn Visual Studio die Suche nach ADDIN-Dateien startet, werden diese Token durch die folgenden Pfadzeichenfolgen ersetzt:

    Token

    Pfad

    %ALLUSERSPROFILE%

    .. \Dokumente und Einstellungen\Alle Benutzer\Anwendungsdaten\Microsoft\MSEnvShared\Addins\

    %APPDATA%

    .. \Dokumente und Einstellungen\Benutzername\Microsoft\MSEnvShared\Addins\

    %USERPROFILE%

    .. \Dokumente und Einstellungen\Benutzername\Eigene Dateien\Visual Studio 2010\Addins\

    %VSAPPDATA%

    .. \Dokumente und Einstellungen\Benutzername\Addins\

    %VSCOMMONAPPDATA%

    .. \Dokumente und Einstellungen\Alle Benutzer\Addins

    Weitere Informationen zum Registrieren von Add-Ins finden Sie unter Add-In-Sicherheit.

  4. Erstellen Sie in einem der zuvor aufgelisteten Verzeichnisse eine ADDIN-Datei, die auf die neue Optionsseite verweist.

    Sie können den folgenden Code als Vorlage verwenden:

    <?xml version="1.0" encoding="UTF-16" standalone="no"?>
    <Extensibility xmlns="https://schemas.microsoft.com/AutomationExtensibility">
        <HostApplication>
            <Name>Microsoft Visual Studio Macros</Name>
            <Version>10.0</Version>
        </HostApplication>
        <HostApplication>
            <Name>Microsoft Visual Studio</Name>
            <Version>10.0</Version>
        </HostApplication>
        <ToolsOptionsPage>
            <Category Name="Environment">
                <SubCategory Name="My Tools Options Page">
                    <Assembly><dll location></Assembly>
                    <FullClassName>ToolsOptionsLibrary.UserControl1
                    </FullClassName>
                </SubCategory>
            </Category>
        </ToolsOptionsPage>
    </Extensibility>
    
  5. Ersetzen Sie im <Assembly></Assembly>-Tag die Angabe <dll location> durch den Pfad von ToolsOptionsLibrary.dll.

  6. Ändern Sie die Einstellungen der <benutzerdefinierten Optionsseite im Menü Extras>(Kategoriename, Unterkategoriename usw.) entsprechend den spezifischen Eigenschaften Ihres Benutzersteuerelements.

    Wenn das Benutzersteuerelement beispielsweise "NewPage" heißt und das Projekt "MyTOLib", würde der Name des FullClassName-Tags wie folgt lauten: MyTOLib.NewPage. Die Assembly befindet sich dort, wo sich die DLL-Datei für die Optionen befindet. Der Kategoriename ist der Knoten im Dialogfeld Optionen, unter dem Sie die benutzerdefinierte Seite suchen möchten, beispielsweise Umgebung, Debuggen oder Projekte.

    Wenn Sie einen Namen angeben, der nicht vorhanden ist, wird ein Knoten mit diesem Namen erstellt. Die Unterkategorie ist der Name, der unter dem Knoten angezeigt wird. Es können maximal zwei Unterkategorien erstellt werden. Sie können keinen Knoten der dritten Ebene hinzufügen.

  7. Speichern Sie die Datei als Textdatei mit der Dateinamenerweiterung .addin in einem der zuvor beschriebenen Add-In-Dateiordner. Das Standardverzeichnis lautet \Dokumente und Einstellungen\Benutzername\Anwendungsdaten\Microsoft\MSEnvShared\Addins\.

    Visual Studio sucht beim Start in diesem Verzeichnis nach benutzerdefinierten Definitionen für Optionsseiten und lädt diese gegebenenfalls. Im Dialogfeld Optionen können Sie Add-In-Verzeichnisse unter dem Knoten Umgebung auf der Seite Add-In/Makrosicherheit ändern oder hinzufügen.

  8. Starten Sie Visual Studio, und klicken Sie im Menü Extras auf Optionen.

    Die neue Optionsseite wird angezeigt.

Siehe auch

Aufgaben

Gewusst wie: Ändern des Erscheinungsbilds eines Fensters

Konzepte

Steuern der Einstellungen im Dialogfeld "Optionen" (Menü "Extras")

Add-In-Registrierung

Diagramm "Automationsobjektmodell"

Weitere Ressourcen

Erstellen und Steuern von Umgebungsfenstern

Referenz zur Automatisierung und Erweiterbarkeit