Creación de una categoría de configuración

En este tutorial, creará una categoría de configuración de Visual Studio y la usará para guardar valores en un archivo de configuración y restaurarlos. Una categoría de configuración es un grupo de propiedades relacionadas que aparecen como un "punto de configuración personalizado"; es decir, como una casilla en el asistente Importación y exportación de configuración. (Puede encontrarlo en el menú Herramientas). La configuración se guarda o restaura como una categoría, y la configuración individual no se muestra en el asistente. Para obtener más información, vea Configuración del entorno.

Una categoría de configuración se crea obteniéndola de la clase DialogPage.

Para iniciar este tutorial, primero debe completar la primera sección de Creación de una página de opciones. La cuadrícula de propiedades Opciones resultante permite examinar y cambiar las propiedades de la categoría. Después de guardar la categoría de propiedad en un archivo de configuración, examine el archivo para ver cómo se almacenan los valores de propiedad.

Creación de una categoría de configuración

En esta sección, usará un punto de configuración personalizado para guardar y restaurar los valores de la categoría de configuración.

Pasos para crear una categoría de configuración

1. Complete el proceso de Creación de una página de opciones.

2. Abra el archivo VSPackage.resx y agregue estos tres recursos de cadena:

   NOMBRE	Valor
   106	Mi Categoría
   107	Mi configuración
   108	OptionInteger y OptionFloat

   Esto crea recursos que denominan la categoría "Mi categoría", el objeto "Mi Configuración" y la descripción de categoría "OptionInteger y OptionFloat".

   Nota:

   De estos tres, solo el nombre de categoría no aparece en el asistente Importación y exportación de configuración.

3. En MyToolsOptionsPackage.cs, agregue una propiedad float llamada OptionFloat a la clase OptionPageGrid, como se muestra en el ejemplo siguiente.

   public class OptionPageGrid : DialogPage
   {
       private int optionInt = 256;
       private float optionFloat = 3.14F;
   
       [Category("My Options")]
       [DisplayName("My Integer option")]
       [Description("My integer option")]
       public int OptionInteger
       {
           get { return optionInt; }
           set { optionInt = value; }
       }
       [Category("My Options")]
       [DisplayName("My Float option")]
       [Description("My float option")]
       public float OptionFloat
       {
           get { return optionFloat; }
           set { optionFloat = value; }
       }
   }
   

   Nota:

   La categoría OptionPageGrid llamada "Mi categoría" ahora consta de las dos propiedades: OptionInteger y OptionFloat.

4. Agregue un ProvideProfileAttribute a la clase MyToolsOptionsPackage y asígnele el nombre de categoría "Mi categoría", el nombre de objeto "Mi configuración" y establezca la opción isToolsOptionPage en verdadera. Establezca categoryResourceID, objectNameResourceID y DescriptionResourceID en los identificadores de recursos de cadena correspondientes creados anteriormente.

   [ProvideProfileAttribute(typeof(OptionPageGrid),
       "My Category", "My Settings", 106, 107, isToolsOptionPage:true, DescriptionResourceID = 108)]
   

5. Compile la solución y comience la depuración. En la instancia experimental debería ver que Mi página de cuadrícula ahora tiene valores de integer y float.

Análisis del archivo de configuración

En esta sección, exportará los valores de categoría de propiedades a un archivo de configuración. Analice el archivo y, a continuación, vuelva a importar los valores a la categoría de propiedad.

1. Pulse F5 para iniciar el proyecto en modo de depuración. Esto inicia la instancia experimental.

2. Abra el cuadro de diálogo Herramientas>Opciones.

3. En la vista de árbol del panel izquierdo, expanda Mi categoría y, a continuación, haga clic en Mi página de cuadrícula.

4. Cambie el valor de OptionFloat a 3.1416 y OptionInteger a 12. Haga clic en OK.

5. En el menú Herramientas, haga clic en Importar y exportar configuraciones.

   Se muestra el asistente Importación y exportación de configuración.

6. Asegúrese de que la opción Exportar la configuración del entorno seleccionada esté seleccionada y, a continuación, haga clic en Siguiente.

   Se muestra la página Elegir configuración exportar.

7. Haga clic en Mi configuración.

   La Descripción cambia a OptionInteger y OptionFloat.

8. Asegúrese de que Mi configuración sea la única categoría seleccionada y, a continuación, haga clic en Siguiente.

   Se muestra la página Nombre del archivo de configuración.

9. Asigne al nuevo archivo de configuración el nombre MySettings.vssettings y guárdelo en un directorio adecuado. Haga clic en Finalizar

   El archivo .vssettings es el archivo de configuración de Visual Studio. El esquema del archivo está abierto. Normalmente, el esquema sigue una estructura XML donde cada categoría es una etiqueta que, a su vez, puede contener etiquetas de subcategoría. Estas etiquetas de subcategoría pueden contener etiquetas de valor de propiedad. Aunque en la mayoría de los paquetes se usa la estructura común, cualquier paquete de Visual Studio puede aportar código XML arbitrario al archivo con el esquema que elija.

   La página Exportación completada indica que la configuración se ha exportado correctamente.

10. En el menú Archivo , seleccione Abriry haga clic en Archivo. Busque MySettings.vssettings y ábralo.

    Puede encontrar la categoría de propiedad que exportó en la sección siguiente del archivo (los GUID serán diferentes).

    <Category name="My Category_My Settings"
          Category="{4802bc3e-3d9d-4591-8201-23d1a05216a6}"
          Package="{6bb6942e-014c-489e-a612-a935680f703d}"
          RegisteredName="My Category_My Settings">
          PackageName="MyToolsOptionsPackage">
       <PropertyValue name="OptionFloat">3.1416</PropertyValue>
       <PropertyValue name="OptionInteger">12</PropertyValue>
    </Category>
    

    Observe que el nombre de categoría completo está formado por la adición de un carácter de subrayado al nombre de la categoría, seguido del nombre del objeto. OptionFloat y OptionInteger aparecen en la categoría, junto con sus valores exportados.

11. Cierre el archivo de configuración sin cambiarlo.

12. En el menú Herramientas, haga clic en Opciones, expanda Mi categoría, haga clic en Mi página de cuadrícula y cambie el valor de OptionFloat a 1.0 y el valor de OptionInteger a 1. Haga clic en OK.

13. En el menú Herramientas, haga clic en Importación y exportación de configuración, seleccione Importar la configuración de entorno seleccionada y, a continuación, seleccione Siguiente.

    Se muestra la página Guardar configuración actual.

14. Seleccione No, solo importar la nueva configuración y, a continuación, haga clic en Siguiente.

    Se muestra la página Elija una colección de configuraciones para importar.

15. Seleccione el archivo MySettings.vssettings en el nodo Mi configuración de la vista de árbol. Si el archivo no aparece en la vista de árbol, haga clic en Examinar y búsquelo. Haga clic en Next.

    Se muestra el cuadro de diálogo Elija la configuración que desee importar.

16. Asegúrese de que Mi configuración esté seleccionado y haga clic en Finalizar. Cuando se muestre la página Importación completada, haga clic en Cerrar.

17. En el menú Herramientas, haga clic en Opciones, expanda Mi categoría, haga clic en Mi página de cuadrícula y compruebe que se han restaurado los valores de categoría de propiedad.