Compartir a través de

Empaquetar e implementar mis extensiones personalizadas (Visual Basic)

Visual Basic proporciona una manera sencilla de implementar las extensiones de espacio de nombres personalizadas My mediante plantillas de Visual Studio. Si va a crear una plantilla de proyecto para la que las My extensiones forman parte integral del nuevo tipo de proyecto, solo puede incluir el código de extensión personalizado My con el proyecto al exportar la plantilla. Para obtener más información sobre cómo exportar plantillas de proyecto, vea How to: Create Project Templates.

Si la extensión personalizada My está en un solo archivo de código, puede exportar el archivo como una plantilla de elemento que los usuarios pueden agregar a cualquier tipo de proyecto de Visual Basic. A continuación, puede personalizar la plantilla de elemento para habilitar funcionalidades y comportamientos adicionales para la extensión personalizada My en un proyecto de Visual Basic. Estas funcionalidades incluyen lo siguiente:

  • Permitir que los usuarios administren la extensión personalizada My desde la página Mis extensiones del Diseñador de proyectos de Visual Basic.

  • Agregar automáticamente la extensión personalizada My cuando se agrega una referencia a un ensamblado especificado a un proyecto.

  • Ocultar la My plantilla de elemento de extensión en el cuadro de diálogo Agregar elemento para que no se incluya en la lista de elementos del proyecto.

En este tema se describe cómo empaquetar una extensión personalizada My como una plantilla de elemento oculta que se puede administrar desde la página Mis extensiones del Diseñador de proyectos de Visual Basic. La extensión personalizada My también se puede agregar automáticamente cuando se agrega una referencia a un ensamblado especificado a un proyecto.

Creación de una extensión my namespace

El primer paso para crear un paquete de implementación para una extensión personalizada My es crear la extensión como un único archivo de código. Para obtener más información e instrucciones sobre cómo crear una extensión personalizada My , vea Extender el espacio de nombres My en Visual Basic.

Exportación de una extensión de espacio de nombres My como una plantilla de elementos

Después de tener un archivo de código que incluya la extensión de espacio de nombres My, puede exportar el archivo de código como una plantilla de elementos de Visual Studio. Para obtener instrucciones sobre cómo exportar un archivo como plantilla de elemento de Visual Studio, vea How to: Create Item Templates.

Nota:

Si la extensión de espacio de nombres My tiene una dependencia de un ensamblado determinado, puede personalizar la plantilla de elementos para que instale automáticamente su extensión de espacio de nombres My cuando se agregue una referencia a ese ensamblado. Como resultado, querrá excluir esa referencia de ensamblado al exportar el archivo de código como plantilla de elemento de Visual Studio.

Personalización de la plantilla de elemento

Puede permitir que la plantilla de elemento se administre desde la página Mis extensiones del Diseñador de proyectos de Visual Basic. También puede habilitar que la plantilla de elemento se agregue automáticamente cuando se agregue una referencia a un ensamblado especificado a un proyecto. Para habilitar estas personalizaciones, agregará un nuevo archivo, denominado archivo CustomData, a la plantilla y, a continuación, agregará un nuevo elemento al XML en el archivo .vstemplate.

Agregar el archivo CustomData

El archivo CustomData es un archivo de texto que tiene una extensión de nombre de archivo de . CustomData (el nombre de archivo se puede establecer en cualquier valor significativo para la plantilla) y que contiene XML. El XML del archivo CustomData indica a Visual Basic que incluya la My extensión cuando los usuarios usen la página Mis extensiones del Diseñador de proyectos de Visual Basic. Opcionalmente, puede agregar el atributo <AssemblyFullName> al archivo XML de CustomData. Esto indica a Visual Basic que instale automáticamente la extensión personalizada My cuando se agrega una referencia a un ensamblado determinado al proyecto. Puede usar cualquier editor de texto o editor XML para crear el archivo CustomData y, a continuación, agregarlo a la carpeta comprimida de la plantilla de elemento (.zip archivo).

Por ejemplo, el siguiente XML muestra el contenido de un archivo CustomData que agregará el elemento de plantilla a la carpeta Mis extensiones de un proyecto de Visual Basic cuando se agregue una referencia al ensamblado Microsoft.VisualBasic.PowerPacks.Vs.dll al proyecto.

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

El archivo CustomData contiene un <VBMyExtensionTemplate> elemento que tiene atributos como se muestra en la tabla siguiente.

Atributo Descripción
ID Obligatorio. Identificador único de la extensión. Si la extensión que tiene este identificador ya se ha agregado al proyecto, no se le pedirá al usuario que lo agregue de nuevo.
Version Obligatorio. Número de versión de la plantilla de elemento.
AssemblyFullName Opcional. Nombre de ensamblado. Cuando se añade una referencia a este ensamblado, se solicitará al usuario añadir la extensión My de esta plantilla de elementos al proyecto.

Agregue el <elemento CustomDataSignature> al archivo .vstemplate.

Para identificar la plantilla de elemento de Visual Studio como una extensión de espacio de nombres My, también debe modificar el archivo .vstemplate para la plantilla de elemento. Debe agregar un <CustomDataSignature> elemento al <TemplateData> elemento . El <CustomDataSignature> elemento debe contener el texto Microsoft.VisualBasic.MyExtension, como se muestra en el ejemplo siguiente.

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

No se pueden modificar archivos en una carpeta comprimida (archivo.zip) directamente. Debe copiar el archivo .vstemplate de la carpeta comprimida, modificarlo y, a continuación, reemplazar el archivo .vstemplate en la carpeta comprimida por la copia actualizada.

En el ejemplo siguiente se muestra el contenido de un archivo .vstemplate que tiene agregado el <CustomDataSignature> elemento .

<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>

Instalación de la plantilla

Para instalar la plantilla, puede copiar la carpeta comprimida (.zip archivo) en la carpeta plantillas de elemento de Visual Basic. De forma predeterminada, las plantillas de elementos de usuario se encuentran en %USERPROFILE%\Documents\Visual Studio <Version>\Templates\ItemTemplates\Visual Basic. Como alternativa, puede publicar la plantilla como un archivo del Instalador de Visual Studio (.vsi).

Consulte también