Cómo: Definir un elemento personalizado en un cuadro de herramientas de modelado

Artículo
03/12/2013

Para que le resulte más fácil crear un elemento o grupo de elementos con arreglo a un modelo que utilice habitualmente, puede agregar nuevas herramientas al cuadro de herramientas de los diagramas de modelado de Visual Studio Ultimate.Puede distribuir estos elementos del cuadro de herramientas a otros usuarios de Visual Studio Ultimate.

Una herramienta personalizada crea uno o más nuevos elementos en un diagrama.No puede crear herramientas personalizadas de la conexión.

Por ejemplo, podría crear una herramienta personalizada para crear elementos como los siguientes:

Un paquete vinculado al perfil de .NET y una clase con el estereotipo de .NET.
Un par de clases vinculadas mediante una asociación que representen el modelo Observer.

Puede utilizar este método para crear herramientas de elementos.Es decir, puede crear herramientas que se arrastren desde el cuadro de herramientas a un diagrama.No se pueden crear herramientas de conectores.

Definir una herramienta de modelado personalizada

Para definir una herramienta de modelado personalizada

Cree un diagrama de UML que contenga un elemento o grupo de elementos.
- Estos elementos pueden tener relaciones entre ellos y pueden tener elementos secundarios, como puertos, atributos, operaciones o pins.
Guarde el diagrama mediante el nombre de la nueva herramienta.En el menú Archivo , utilice Guarde… as.
Con el Explorador de Windows, copie los dos archivos de diagrama en la carpeta que se indica a continuación o cualquier subcarpeta:

SusDocumentos**\Visual Studio 2012\Architecture Tools\Custom Toolbox Items**
- Cree esta carpeta, si es que no existe ya.Puede que tenga que crear Architecture Tools y Custom Toolbox Items.
- Copie los dos archivos de diagrama, uno con un nombre terminado en "...diagram" y otro con un nombre terminado en "...diagram.layout"
- Puede crear tantas herramientas personalizadas como desee.Utilice un diagrama para cada herramienta.
(Opcional) Cree un archivo .tbxinfo tal y como se describe en Definir las propiedades de las herramientas personalizadas y agréguelo al mismo directorio.De este modo, podrá definir un icono de cuadro de herramientas, una información sobre herramientas, etc.
- Se puede utilizar un solo archivo .tbxinfo para definir varias herramientas.Aquí pueden establecerse las referencias a los archivos de diagrama que se encuentran en subcarpetas.
Reinicie Visual Studio.La herramienta adicional aparecerá en el cuadro de herramientas del tipo de diagrama adecuado.

Qué va a replicar la herramienta personalizada

Una herramienta personalizada replicará la mayoría de las características del diagrama de origen:

Nombres.Cuando un elemento se crea a partir del cuadro de herramientas, se agrega un número al final del nombre si es necesario evitar que haya nombres duplicados en el mismo espacio de nombres.
Colores, tamaños y formas
Perfiles de estereotipos y paquetes
Valores de propiedad, como Is Abstract
Elementos de trabajo vinculados
Multiplicidades y otras propiedades de relaciones
Posiciones relativas de las formas.

Las siguientes características no se conservarán en una herramienta personalizada:

Formas simples.Estas son formas que no están relacionadas con elementos del modelo, que puede dibujar en algunos tipos de diagramas.
Enrutamiento de conectores.Si enruta conectores manualmente, no se conservará el enrutamiento cuando se use la herramienta.Las posiciones de algunas formas anidadas, como los Puertos, no se conservan con relación a sus propietarios.

Definir las propiedades de las herramientas personalizadas

Los archivos de información sobre el cuadro de herramientas (.tbxinfo) permiten especificar el nombre, el icono, la información sobre herramientas, la pestaña y la palabra clave del cuadro de herramientas de una o varias herramientas personalizadas.Dele cualquier nombre, por ejemplo MyTools.tbxinfo.

El formato general del archivo será similar al siguiente:

<?xml version="1.0" encoding="utf-8" ?>
<customToolboxItems xmlns="https://schemas.microsoft.com/visualstudio/2010/ArchitectureTools/CustomToolboxItems">
  <customToolboxItem fileName="MyObserverTool.classdiagram">
    <displayName>
       <value>Observer Pattern</value>
    </displayName>
    <tabName>
       <value>UML Class Diagram</value>
    </tabName>
    <image><bmp fileName="ObserverPatternIcon.bmp"/></image>
    <f1Keyword>
      <value>ObserverPatternHelp</value>
    </f1Keyword>
    <tooltip>
       <value>Create a pair of classes</value>
    </tooltip>
  </customToolboxItem>
</customToolboxItems>

El valor de cada elemento puede ser:

Como se muestra en el ejemplo, <bmp fileName="…"/>para el icono de cuadro de herramientas y <value>string</value> para los demás elementos.

-O bien-

<resource fileName="Resources.dll"

baseName="Observer.resources" id="Observer.tabname" />

En este caso, debe proporcionar un ensamblado compilado en el que los valores de cadena se hayan compilado como recursos.

Agregue un nodo <customToolboxItem> para cada elemento del cuadro de herramientas que desea definir.

Los nodos del archivo .tbxinfo son los siguientes.Hay un valor predeterminado para cada nodo.

Nombre del nodo	Define
displayName	El nombre del elemento del cuadro de herramientas.
tabName	La pestaña del cuadro de herramientas en la que debe aparecer el elemento.Puede especificar el nombre de la pestaña habitual para este tipo de diagrama o un nombre diferente.
image	La ubicación del archivo de mapa de bits (.bmp), cuyo alto y ancho debe ser de 16 y cuya profundidad de color debe ser de 24 bits.
f1Keyword	La palabra clave mediante la que se busca un tema de Ayuda.
tooltip	Una información sobre herramientas de esta herramienta.

Puede editar el archivo de mapa de bits en Visual Studio y establecer su alto y ancho en 16 a través de la ventana Propiedades.

[!NOTA]

Si empieza a utilizar un archivo .tbxinfo después de experimentar con archivos de diagrama en solitario, es posible que descubra que el cuadro de herramientas contiene la versión anterior y la versión nueva de un cuadro de herramientas.Esto también puede producirse si el nombre del archivo de diagrama se escribió incorrectamente en el archivo .tbxinfo.Si ocurre esto, en el menú contextual del cuadro de herramientas elija Restablecer cuadro de herramientas.Los elementos del cuadro de herramientas personalizados desaparecerán.Reinicie Visual Studio y aparecerán los elementos personalizados correctos.

Distribuir los elementos del cuadro de herramientas en una extensión de Visual Studio

Para distribuir los elementos del cuadro de herramientas a otros usuarios de Visual Studio, puede empaquetarlos en una extensión de Visual Studio (VSIX).Puede empaquetar comandos, los perfiles, y otras extensiones en el mismo archivo VSIX. Para obtener más información, vea Deploying Visual Studio Extensions.

La manera habitual de compilar una extensión de Visual Studio es utilizar la plantilla de proyecto de VSIX.Para ello, debe tener instalado Visual Studio SDK.

Para agregar un elemento del cuadro de herramientas a una extensión de Visual Studio

Cree y pruebe una o varias herramientas personalizadas.
Cree un archivo .tbxinfo que haga referencia a las herramientas.
Abra un proyecto de extensión de Visual Studio existente.

-O bien-

Defina un nuevo proyecto de extensión de Visual Studio.
1. en el menú de Archivo , elija Nuevo, proyecto.
2. En el cuadro de diálogo Nuevo proyecto , en Plantillas instaladas, elija Visual c#, Extensibilidad, Proyecto VSIX.
Agregue sus definiciones del cuadro de herramientas al proyecto.Incluya el archivo .tbxinfo, los archivos de diagrama, los archivos de mapa de bits y cualquier archivo de recursos, y asegúrese de que se incluyen en la extensión VSIX.
- En el explorador de soluciones, en el menú contextual del proyecto VSIX, elija Agregar, Elemento existente.En el cuadro de diálogo, establezca Objetos de tipo: Todos los archivos.Busque los archivos, selecciónelos y todos, y elija Agregar.
  
  [!NOTA]
  
  En este proyecto, los archivos de diagrama no se pueden abrir en el editor del modelo.
Establezca las siguientes propiedades de todos los archivos que acaba de agregar.Puede establecer sus propiedades al mismo tiempo seleccionándolos todos en el Explorador de soluciones.Tenga cuidado de no cambiar las propiedades de los demás archivos del proyecto.

Copiar en el directorio de salida = Copiar siempre

Acción de compilación = Contenido

Incluir en VSIX = true
Abra source.extension.vsixmanifest.El archivo se abre en el editor de manifiestos de la extensión.
En Metadatos, agregue una descripción de las herramientas personalizadas.

En Activos, elija Nuevo y establezca los campos del diálogo como sigue:
- Tipo = Tipo de extensión personalizado
- Tipo = Microsoft.VisualStudio.ArchitectureTools.CustomToolboxItems
  
  [!NOTA]
  
  Esto no es una de las opciones en la lista desplegable.Tiene que escribirlos en mediante el teclado.
- Origen = Archivo en filesystem.
- Ruta = el archivo de .tbxinfo , por ejemplo MyTools.tbxinfo
Compile el proyecto.
Para comprobar que la extensión, presione F5.La instancia experimental de Visual Studio comienza.

En la instancia experimental, cree o abra un diagrama UML de tipo pertinente.Compruebe que la nueva herramienta aparezca en el cuadro de herramientas y que crea elementos correctamente.
Para obtener un archivo VSIX para la implementación: en el Explorador de Windows, abra la carpeta .\bin\Debug o .\bin\Release para encontrar el archivo de .vsix .Es un archivo de la extensión de Visual Studio.Este archivo puede instalarse en el equipo y también enviarse a otros usuarios de Visual Studio.

Para instalar las herramientas personalizadas desde una extensión de Visual Studio

Abra el archivo de .vsix en el Explorador de Windows o en Visual Studio.
Elija Instalar en el cuadro de diálogo que aparece.
Para desinstalar o deshabilitar temporalmente la extensión, abra el Administrador de extensiones en el menú Herramientas.

Localización

Puede realizar una extensión que, cuando se instale en otro equipo, muestre los nombres de herramienta y la información sobre herramientas en el idioma del equipo de destino.

Para proporcionar versiones de la herramienta en varios idiomas

Cree un proyecto de extensión de Visual Studio que contenga una o varias herramientas personalizadas.

En el archivo .tbxinfo, utilice el método del archivo de recursos para definir la propiedad displayName de la herramienta, la propiedad tabName del cuadro de herramientas y la información sobre herramientas.Cree un archivo de recursos en el que se definan estas cadenas, compílelo en un ensamblado y establezca referencias a él en el archivo tbxinfo.
Cree ensamblados adicionales que contengan archivos de recursos con cadenas en otros idiomas.
Coloque cada ensamblado adicional en una carpeta cuyo nombre sea el código de referencia cultural del idioma.Por ejemplo, coloque una versión del ensamblado para el francés en una carpeta denominada fr.
Debe utilizar un código de referencia cultural neutro, normalmente dos letras, y no una referencia cultural concreta como fr-CA.Para obtener más información sobre los códigos de referencia cultural, vea CultureInfo.GetCultures method, donde se proporciona una lista completa de códigos de referencia cultural.
Compile la extensión de Visual Studio y distribúyala.
Cuando la extensión se instala en otro equipo, se carga automáticamente la versión del archivo de recursos de la referencia cultural local del usuario.Si no se proporciona ninguna versión para la referencia cultural del usuario, se utilizarán los recursos predeterminados.

No puede utilizar este método para instalar versiones diferentes del diagrama de prototipos.Los nombres de los elementos y conectores serán los mismos en cada instalación.

Otras operaciones del cuadro de herramientas

Normalmente, en Visual Studio, puede personalizar el cuadro de herramientas cambiando las herramientas, moviéndolas a diferentes pestañas del cuadro de herramientas, y eliminándolas. Pero los cambios no se conservan en las herramientas de modelado personalizadas creadas con los procedimientos que se describen en este tema.Cuando reinicie Visual Studio, las herramientas personalizadas volverán a aparecer con los nombres y las ubicaciones del cuadro de herramientas que se definieron.

Además, las herramientas personalizadas desaparecerán si ejecuta el comando Restablecer cuadro de herramientas.No obstante, volverán a aparecer cuando reinicie Visual Studio.

Vea también

Conceptos

Ampliar modelos y diagramas UML

Cómo: Definir un perfil para ampliar UML

Cómo: Definir un comando de menú en un diagrama de modelado

Cómo: Definir restricciones de validación para modelos UML