Agregar propiedades personalizadas a diagramas de capas
Al escribir código de extensión para los diagramas de capas en Visual Studio Ultimate, puede almacenar valores en cualquier elemento de un diagrama de capas. Los valores se conservarán cuando el diagrama se guarde y se vuelva a abrir. También puede hacer que estas propiedades aparezcan en la ventana Propiedades para que los usuarios puedan verlas y editarlas. Por ejemplo, puede permitir que los usuarios especifiquen una expresión regular para cada capa y escriban código de validación para comprobar que los nombres de las clases de cada capa se ajustan al patrón especificado por el usuario.
Propiedades no visibles para el usuario
Si solo desea que el código asocie valores a cualquier elemento de un diagrama de capas, no es necesario definir un componente MEF. Hay un diccionario denominado Properties en ILayerElement. Solo tiene que agregar valores que calculan referencias al diccionario de cualquier elemento de capa. Estos se guardarán como parte del diagrama de capas. Para obtener más información, vea Navegar y actualizar modelos de capas en el código del programa.
Propiedades que el usuario puede editar
Preparación inicial
Importante
Para que las propiedades aparezcan, debe realizar el cambio siguiente en todos los equipos donde desee que las propiedades de capa sean visibles.
-
Ejecute el Bloc de notas mediante Ejecutar como administrador.Abra %ProgramFiles%\Microsoft Visual Studio 12.0\Common7\IDE\Extensions\Microsoft\Architecture Tools\ExtensibilityRuntime\extension.vsixmanifest.
-
Dentro del elemento Content, agregue:
<MefComponent>Microsoft.VisualStudio.ArchitectureTools.Extensibility.Layer.Provider.dll</MefComponent> -
En el menú Inicio de Windows, en Microsoft Visual Studio 2012, Visual Studio Tools, abra Símbolo del sistema para desarrolladores.
Especifique:
devenv /rootSuffix /updateConfiguration
devenv /rootSuffix Exp /updateConfiguration
-
Reinicie Visual Studio.
Asegurarse de que el código está en un proyecto VSIX
Si la propiedad forma parte de un proyecto de validación, gesto o comando, no es necesario agregar nada. El código de la propiedad personalizada debe definirse en un proyecto de extensibilidad de Visual Studio definido como componente MEF. Para obtener más información, vea Agregar comandos y gestos a diagramas de capas o Agregar validación de arquitectura personalizada a diagramas de capas.
Definir la propiedad personalizada
Para crear una propiedad personalizada, defina una clase como esta:
[Export(typeof(IPropertyExtension))]
public class MyProperty
: PropertyExtension<ILayerElement>
{
// Implement the interface.
}
Puede definir propiedades en ILayerElement o cualquiera de sus clases derivadas, entre las que se incluyen:
ILayerModel: el modelo
ILayer: cada capa
ILayerDependencyLink: los vínculos entre las capas
ILayerComment
ILayerCommentLink
Para ver las propiedades personalizadas
Importante
Las propiedades personalizadas solo aparecen si el Explorador de arquitectura se abre antes de cargar el proyecto de modelado.Quizá tenga que abrir el Explorador de arquitectura y, después, detener y reiniciar Visual Studio para ver las propiedades personalizadas.En el menú Arquitectura, elija Ventanas, Explorador de arquitectura.
Para probar las propiedades personalizadas, presione F5 para iniciar una instancia experimental de Visual Studio. Cree un ejemplo del elemento de capa adecuado y selecciónelo. La propiedad personalizada aparecerá en la ventana Propiedades.
Ejemplo
El siguiente código es un descriptor de propiedad personalizado típico. Define una propiedad booleana en el modelo de capas (ILayerModel) que permite al usuario proporcionar valores para un método de validación personalizado.
using System;
using System.ComponentModel.Composition;
using Microsoft.VisualStudio.ArchitectureTools.Extensibility.Layer;
namespace MyNamespace
{
/// <summary>
/// Custom properties are added to the Layer Designer via a custom
/// Property Descriptor. We have to export this Property Descriptor
/// using MEF to make it available in the Layer Designer.
/// </summary>
[Export(typeof(IPropertyExtension))]
public class AllTypesMustBeReferencedProperty
: PropertyExtension<ILayerModel>
{
/// <summary>
/// Each custom property must have a unique name.
/// Usually we use the full name of this class.
/// </summary>
public static readonly string FullName =
typeof(AllTypesMustBeReferencedProperty).FullName;
/// <summary>
/// Construct the property. Notice the use of FullName.
/// </summary>
public AllTypesMustBeReferencedProperty()
: base(FullName)
{ }
/// <summary>
/// The display name is shown in the Properties window.
/// We therefore use a localizable resource.
/// </summary>
public override string DisplayName
{
get { return Strings.AllTypesMustBeReferencedDisplayName; }
}
/// <summary>
/// Description shown at the bottom of the Properties window.
/// We use a resource string for easier localization.
/// </summary>
public override string Description
{
get { return Strings.AllTypesMustBeReferencedDescription; }
}
/// <summary>
/// This is called to set a new value for this property. We must
/// throw an exception if the value is invalid.
/// </summary>
/// <param name="component">The target ILayerElement</param>
/// <param name="value">The new value</param>
public override void SetValue(object component, object value)
{
ValidateValue(value);
base.SetValue(component, value);
}
/// <summary>
/// Helper to validate the value.
/// </summary>
/// <param name="value">The value to validate</param>
private static void ValidateValue(object value)
{ }
public override Type PropertyType
{ get { return typeof(bool); } }
/// <summary>
/// The segment label of the properties window.
/// </summary>
public override string Category
{
get
{
return Strings.AllTypesMustBeReferencedCategory;
}
}
}
}