Sdílet prostřednictvím

Referenční dokumentace schématu manifestu šablony sady Visual Studio

  • Článek

Toto schéma popisuje formát souborů manifestu šablon sady Visual Studio (.vstman), které jsou generovány pro šablony projektů nebo položek sady Visual Studio. Schéma také popisuje umístění a další relevantní informace o šabloně.

: Protože existují samostatné adresáře položek a šablon projektů, manifest by nikdy neměl obsahovat kombinaci položek a šablon projektů.

Důležité

Tento manifest je k dispozici od sady Visual Studio 2017.

VSTemplateManifest – element

Kořenový prvek manifestu.

Atributy

  • Verze: Řetězec představující verzi manifestu šablony. Povinný:

  • Národní prostředí: Řetězec představující národní prostředí nebo národní prostředí manifestu šablony. Hodnota národního prostředí se vztahuje na všechny šablony. Pro každé národní prostředí musíte použít samostatný manifest. Nepovinné.

Podřízené prvky

  • Volitelné VSTemplateContainer .

  • VSTemplateDir Volitelné.

Nadřazený prvek

Nezaokrouhlovat.

VSTemplateContainer

Kontejner elementů manifestu šablony. Manifest má jeden kontejner šablony pro každou šablonu, která definuje.

Atributy

VSTemplateType: Řetězcová hodnota, která určuje typ šablony ("Project", "Item"nebo "ProjectGroup"). Požaduje se

Podřízené prvky

  • RelativePathOnDisk: Relativní cesta k souboru šablony na disku. Toto umístění také definuje umístění šablony ve stromu šablony zobrazeném v dialogovém okně Nový projekt nebo Nová položka . Pro šablony nasazené jako adresář a jednotlivé soubory tato cesta odkazuje na adresář obsahující soubory šablony. U šablon nasazených jako soubor .zip by tato cesta měla být cesta k souboru .zip .

  • **VSTemplateHeader: Element TemplateData , který popisuje hlavičku.

Nadřazený prvek

VSTemplateManifest

VSTemplateDir

Popisuje adresář, ve kterém se šablona nachází. Manifest může obsahovat více položek VSTemplateDir , aby bylo možné zadat lokalizovaný název a řazení adresářů, aby bylo možné řídit jejich vzhled ve stromu kategorií šablony.

Vzhledem k jejich návrhu by se položky VSTemplateDir měly zobrazovat pouze v jiných než národních prostředích určených manifestech.

Atributy

Nezaokrouhlovat.

Podřízené prvky

  • RelativePath: Cesta šablony. Pro každou cestu může existovat pouze jedna položka, takže první z nich vyhraje pro všechny manifesty.

  • LocalizedName: Element NameDescriptionIcon , který určuje lokalizovaný název. Nepovinné.

  • SortOrder: Řetězec, který určuje pořadí řazení. Nepovinné.

  • ParentFolderOverrideName: Přepsaný název nadřazené složky. Nepovinné. Tento prvek má atribut Name , což je řetězcová hodnota, která určuje název.

Nadřazený prvek

VSTemplateManifest

NameDescriptionIcon

Určuje název a popis, pravděpodobně pro lokalizované šablony. Viz LocalizedName výše.

Atributy

  • Balíček: Řetězcová hodnota, která určuje balíček. Nepovinné.

  • ID: Řetězcová hodnota, která určuje ID. Nepovinné.

Podřízené prvky

Nezaokrouhlovat.

Nadřazený prvek

LocalizedName

Příklady

Následující kód je příkladem souboru .vstman šablony projektu.

<VSTemplateManifest Version="1.0" Locale="1033" xmlns="http://schemas.microsoft.com/developer/vstemplatemanifest/2015">
  <VSTemplateContainer TemplateType="Project">
    <RelativePathOnDisk>CSharp\1033\TestProjectTemplate</RelativePathOnDisk>
    <TemplateFileName>TestProjectTemplate.vstemplate</TemplateFileName>
    <VSTemplateHeader>
      <TemplateData xmlns="http://schemas.microsoft.com/developer/vstemplate/2005">
        <Name>TestProjectTemplate</Name>
        <Description>TestProjectTemplate</Description>
        <Icon>TestProjectTemplate.ico</Icon>
        <ProjectType>CSharp</ProjectType>
        <RequiredFrameworkVersion>2.0</RequiredFrameworkVersion>
        <SortOrder>1000</SortOrder>
        <TemplateID>aac0aeea-7883-4003-992f-937d53d70ab1</TemplateID>
        <CreateNewFolder>true</CreateNewFolder>
        <DefaultName>TestProjectTemplate</DefaultName>
        <ProvideDefaultName>true</ProvideDefaultName>
      </TemplateData>
    </VSTemplateHeader>
  </VSTemplateContainer>
</VSTemplateManifest>

Následující kód je příkladem souboru .vstman šablony položky.

<VSTemplateManifest Version="1.0" Locale="1033" xmlns="http://schemas.microsoft.com/developer/vstemplatemanifest/2015">
  <VSTemplateContainer TemplateType="Item">
    <RelativePathOnDisk>CSharp\1033\ItemTemplate1</RelativePathOnDisk>
    <TemplateFileName>ItemTemplate1.vstemplate</TemplateFileName>
    <VSTemplateHeader>
      <TemplateData xmlns="http://schemas.microsoft.com/developer/vstemplate/2005">
        <Name>ItemTemplate1</Name>
        <Description>ItemTemplate1</Description>
        <Icon>ItemTemplate1.ico</Icon>
        <TemplateID>bfeadf8e-a251-4109-b605-516b88e38c8d</TemplateID>
        <ProjectType>CSharp</ProjectType>
        <RequiredFrameworkVersion>2.0</RequiredFrameworkVersion>
        <NumberOfParentCategoriesToRollUp>1</NumberOfParentCategoriesToRollUp>
        <DefaultName>Class.cs</DefaultName>
      </TemplateData>
    </VSTemplateHeader>
  </VSTemplateContainer>
</VSTemplateManifest>