Pakowanie i wdrażanie niestandardowych rozszerzeń Moje (Visual Basic)

Artykuł
06/08/2023

Program Visual Basic umożliwia łatwe wdrażanie niestandardowych My rozszerzeń przestrzeni nazw przy użyciu szablonów programu Visual Studio. Jeśli tworzysz szablon projektu, dla którego My rozszerzenia są integralną częścią nowego typu projektu, możesz po prostu dołączyć niestandardowy My kod rozszerzenia do projektu podczas eksportowania szablonu. Aby uzyskać więcej informacji na temat eksportowania szablonów projektów, zobacz How to: Create Project Templates (Instrukcje: tworzenie szablonów projektów).

Jeśli rozszerzenie niestandardowe My znajduje się w jednym pliku kodu, możesz wyeksportować plik jako szablon elementu, który użytkownicy mogą dodać do dowolnego typu projektu Visual Basic. Następnie możesz dostosować szablon elementu, aby włączyć dodatkowe możliwości i zachowanie rozszerzenia niestandardowego My w projekcie Visual Basic. Te możliwości obejmują następujące funkcje:

Zezwalanie użytkownikom na zarządzanie rozszerzeniem niestandardowym My na stronie Moje rozszerzenia w programie Visual Basic Project Projektant.
Automatyczne dodawanie rozszerzenia niestandardowego My po dodaniu odwołania do określonego zestawu do projektu.
My Ukrywanie szablonu elementu rozszerzenia w oknie dialogowym Dodawanie elementu, aby nie było ono uwzględnione na liście elementów projektu.

W tym temacie omówiono sposób tworzenia pakietu rozszerzenia niestandardowego My jako szablonu elementu ukrytego, który można zarządzać na stronie Moje rozszerzenia w programie Visual Basic Project Projektant. Rozszerzenie niestandardowe My można również dodać automatycznie po dodaniu odwołania do określonego zestawu do projektu.

Tworzenie rozszerzenia Moja przestrzeń nazw

Pierwszym krokiem tworzenia pakietu wdrożeniowego dla rozszerzenia niestandardowego My jest utworzenie rozszerzenia jako pojedynczego pliku kodu. Aby uzyskać szczegółowe informacje i wskazówki dotyczące tworzenia rozszerzenia niestandardowego My , zobacz Rozszerzanie przestrzeni nazw w Visual Basic.

Eksportowanie rozszerzenia Moja przestrzeń nazw jako szablonu elementu

Po utworzeniu pliku kodu zawierającego My rozszerzenie przestrzeni nazw możesz wyeksportować plik kodu jako szablon elementu programu Visual Studio. Aby uzyskać instrukcje dotyczące eksportowania pliku jako szablonu elementu programu Visual Studio, zobacz How to: Create Item Templates (Instrukcje: tworzenie szablonów elementów).

Uwaga

My Jeśli rozszerzenie przestrzeni nazw ma zależność od określonego zestawu, możesz dostosować szablon elementu, aby automatycznie zainstalować My rozszerzenie przestrzeni nazw po dodaniu odwołania do tego zestawu. W związku z tym należy wykluczyć to odwołanie do zestawu podczas eksportowania pliku kodu jako szablonu elementu programu Visual Studio.

Dostosowywanie szablonu elementu

Szablon elementu można włączyć na stronie Moje rozszerzenia w Projektant projektu Visual Basic. Można również włączyć automatyczne dodawanie szablonu elementu po dodaniu odwołania do określonego zestawu do projektu. Aby włączyć te dostosowania, do szablonu zostanie dodany nowy plik o nazwie CustomData, a następnie dodaj nowy element do pliku XML w pliku vstemplate.

Dodawanie pliku CustomData

Plik CustomData to plik tekstowy z rozszerzeniem nazwy pliku . CustomData (nazwa pliku może być ustawiona na dowolną wartość zrozumiałą dla szablonu) i zawierającą kod XML. Plik XML w pliku CustomData instruuje język Visual Basic, aby zawierał My rozszerzenie, gdy użytkownicy korzystają ze strony Moje rozszerzenia w programie Visual Basic Project Projektant. Opcjonalnie możesz dodać <AssemblyFullName> atrybut do pliku CustomData XML. Spowoduje to, że program Visual Basic automatycznie zainstaluje rozszerzenie niestandardowe My po dodaniu odwołania do określonego zestawu do projektu. Możesz użyć dowolnego edytora tekstów lub edytora XML, aby utworzyć plik CustomData, a następnie dodać go do skompresowanego folderu szablonu elementu (.zip pliku).

Na przykład poniższy kod XML przedstawia zawartość pliku CustomData, który doda element szablonu do folderu Moje rozszerzenia projektu Visual Basic, gdy odwołanie do zestawu Microsoft.VisualBasic.PowerPacks.Vs.dll zostanie dodane do projektu.

<VBMyExtensionTemplate
    ID="Microsoft.VisualBasic.Samples.MyExtensions.MyPrinterInfo"
    Version="1.0.0.0"
    AssemblyFullName="Microsoft.VisualBasic.PowerPacks.vs"
/>

Plik CustomData zawiera <VBMyExtensionTemplate> element zawierający atrybuty wymienione w poniższej tabeli.

Atrybut	opis
`ID`	Wymagane. Unikatowy identyfikator rozszerzenia. Jeśli rozszerzenie, które ma ten identyfikator, zostało już dodane do projektu, użytkownik nie będzie monitowany o dodanie go ponownie.
`Version`	Wymagany. Numer wersji szablonu elementu.
`AssemblyFullName`	Opcjonalny. Nazwa zestawu. Po dodaniu odwołania do tego zestawu do projektu użytkownik zostanie poproszony o dodanie `My` rozszerzenia z tego szablonu elementu.

<Dodaj element CustomDataSignature> do pliku vstemplate

Aby zidentyfikować szablon elementu programu Visual Studio jako My rozszerzenie przestrzeni nazw, należy również zmodyfikować plik vstemplate dla szablonu elementu. Musisz dodać <CustomDataSignature> element do <TemplateData> elementu . Element <CustomDataSignature> musi zawierać tekst Microsoft.VisualBasic.MyExtension, jak pokazano w poniższym przykładzie.

<CustomDataSignature>Microsoft.VisualBasic.MyExtension</CustomDataSignature>

Nie można bezpośrednio modyfikować plików w skompresowanym folderze (.zip pliku). Musisz skopiować plik vstemplate z skompresowanego folderu, zmodyfikować go, a następnie zastąpić plik vstemplate w skompresowanym folderze zaktualizowaną kopią.

W poniższym przykładzie pokazano zawartość pliku vstemplate, który ma <CustomDataSignature> dodany element.

<VSTemplate Version="2.0.0" xmlns="http://schemas.microsoft.com/developer/vstemplate/2005" Type="Item">
  <TemplateData>
    <DefaultName>MyCustomExtensionModule.vb</DefaultName>
    <Name>MyPrinterInfo</Name>
    <Description>Custom My Extensions Item Template</Description>
    <ProjectType>VisualBasic</ProjectType>
    <SortOrder>10</SortOrder>
    <Icon>__TemplateIcon.ico</Icon>
    <CustomDataSignature      >Microsoft.VisualBasic.MyExtension</CustomDataSignature>
  </TemplateData>
  <TemplateContent>
    <References />
    <ProjectItem SubType="Code"
                 TargetFileName="$fileinputname$.vb"
                 ReplaceParameters="true"
     >MyCustomExtensionModule.vb</ProjectItem>
  </TemplateContent>
</VSTemplate>

Instalowanie szablonu

Aby zainstalować szablon, możesz skopiować skompresowany folder (plik .zip ) do folderu szablonów elementów języka Visual Basic. Domyślnie szablony elementów użytkownika znajdują się w folderze %USERPROFILE%\Documents\Visual Studio <Version>\Templates\ItemTemplates\Visual Basic. Alternatywnie możesz opublikować szablon jako plik Instalator programu Visual Studio (vsi).

Udostępnij za pośrednictwem