ProvideOptionPageAttribute Clase

Referencia

Definición

Espacio de nombres:: Microsoft.VisualStudio.Shell

Ensamblado:: Microsoft.VisualStudio.Shell.14.0.dll

Ensamblado:: Microsoft.VisualStudio.Shell.15.0.dll

Paquete:: Microsoft.VisualStudio.Shell.15.0 v17.11.40262

Importante

Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.

Aplique este atributo a objetos independientes para permitir a los usuarios configurar VSPackages a través de una página de opciones de herramientas personalizada.

public ref class ProvideOptionPageAttribute sealed : Microsoft::VisualStudio::Shell::ProvideOptionDialogPageAttribute

public ref class ProvideOptionPageAttribute sealed : Microsoft::VisualStudio::Shell::ProvideOptionDialogPageAttribute

[System.AttributeUsage(System.AttributeTargets.Class, AllowMultiple=true, Inherited=true)]
public sealed class ProvideOptionPageAttribute : Microsoft.VisualStudio.Shell.ProvideOptionDialogPageAttribute

[<System.AttributeUsage(System.AttributeTargets.Class, AllowMultiple=true, Inherited=true)>]
type ProvideOptionPageAttribute = class
    inherit ProvideOptionDialogPageAttribute

Public NotInheritable Class ProvideOptionPageAttribute
Inherits ProvideOptionDialogPageAttribute

Herencia: Attribute

RegistrationAttribute

ProvideOptionDialogPageAttribute
ProvideOptionPageAttribute

Atributos: AttributeUsageAttribute

Ejemplos

En el ejemplo siguiente, se aplica una instancia de ProvideOptionPageAttribute a una implementación de VSPackage para registrar la clase DesignerOptionsPage, que se deriva de DialogPage, como proporcionar el VSPackage con una página Opciones de herramientas .

Las clases derivadas de DialogPage se proporcionan con una implementación predeterminada de la funcionalidad de configuración de Visual Studio, que se puede invalidar. El IDE usa esta compatibilidad con la configuración de Visual Studio si, como en el ejemplo, ProvideProfileAttribute se aplica a la implementación de VSPackage. Para obtener más información sobre la compatibilidad con la configuración de Visual Studio, consulte Extensión de la configuración y las opciones de usuario.

using Microsoft.VisualStudio.Shell;  
namespace Example  
{  
[DefaultRegistryRoot("Software\\Microsoft\\VisualStudio\\8.0")]   
[ProvideOptionPage(typeof(DesignerOptionsPage), "MyDesigner", "OptionPage", 1000, 1001, true)]   
[ProvideProfileAttribute(typeof(DesignerOptionsPage), "MyDesigner", "OptionPage", 1002, 1003, true)]  
[ProvideProfileAttribute(typeof(PersistCurrentDesign), "MyDesigner","CurrentDesign", 1004, 1005, false)]  
[Guid("XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX")]  
public class MyPackage : Package  
{  
//Implementation here  
}  

[Guid("YYYYYYYY-YYYY-YYYY-YYYY-YYYYYYYYYYYY")]  
internal class DesignerOptionsPage: DialogPage {  
//Implementation here  
}  

[Guid("ZZZZZZZZ-ZZZZ-ZZZZ-ZZZZ-ZZZZZZZZZZZZ")]  
internal class PersistCurrentDesign: IProfileManager {  
//Implementation here  
}

Comentarios

Notas para los implementadores

Aplique a las ProvideOptionPageAttribute clases que implementan un VSPackage. Este atributo permite registrar que un objeto independiente específico proporciona a los usuarios de VSPackage acceso de configuración a través de una página de opciones de herramientas personalizada.

Contexto de atributo


Se aplica a	VSPackages permite la configuración a través de páginas de opciones de herramientas personalizadas implementadas a través de Managed Package Framework DialogPage o mediante el código del SDK de Visual Studio.
Reiterativo	Sí
Atributos necesarios	DefaultRegistryRootAttribute
Atributos no válidos	None

Notas para autores de la llamada

Este atributo solo se usa con fines de registro y no afecta al comportamiento en tiempo de ejecución del código.

ProvideOptionPageAttribute registra una clase determinada que implementa IProfileManager o DialogPage proporciona una compatibilidad determinada con VSPackage para conservar parte o todo el estado de VSPackage a través del mecanismo de configuración de Visual Studio. La información de estado persistente por la clase de implementación se conoce como categoría de configuración de Visual Studio y su entrada de definición en el Registro se conoce como punto de configuración personalizado.

Nota

Cuando se carga una página opciones de herramientas personalizadas basada en Managed Package Framework, el IDE crea una instancia del objeto registrado al ProvideOptionPageAttribute implementarlo. La compatibilidad con la página Opciones de las herramientas del marco de paquetes administrados debe implementarse en su propio objeto y no en el propio VSPackage.

Para obtener más información sobre cómo crear y aplicar instancias de ProvideOptionPageAttribute, vea el ejemplo siguiente y ProvideOptionPageAttribute.

Constructores

ProvideOptionPageAttribute(Type, String, String, Int16, Int16, Boolean, Int32)	Crea una instancia de ProvideOptionPageAttribute.
ProvideOptionPageAttribute(Type, String, String, Int16, Int16, Boolean, String)	Crea una instancia de ProvideOptionPageAttribute.
ProvideOptionPageAttribute(Type, String, String, Int16, Int16, Boolean, String[])	Crea una instancia de ProvideOptionPageAttribute.

Propiedades

CategoryDescriptionResourceId	Identificador de un recurso que contiene la descripción localizada de la categoría primaria de la página. Esta propiedad solo se usa si SupportsAutomation == true y SupportsProfiles == true. La descripción localizada aparece en el Asistente para la configuración de importación y exportación.
CategoryName	Obtiene el nombre canónico no localizado de la categoría de la página Opciones de herramientas.
CategoryPackageGuid	Identificador del paquete que posee la categoría en la que se registra esta página. Si no se establece, se supone que el paquete es el que se aplica a este atributo. Esta propiedad solo se usa si SupportsAutomation == true y SupportsProfiles == true. Genere esto a partir de un GUID con Guid.ToString("B").
CategoryResourceID	Obtiene el identificador de recurso de categoría de una página Opciones de herramientas.
DescriptionResourceId	Identificador de un recurso que contiene la descripción localizada de la página. Esta propiedad solo se usa si SupportsAutomation == true y SupportsProfiles == true. La descripción localizada aparece en el Asistente para la configuración de importación y exportación.
IsInUnifiedSettings	Obtiene o establece un valor que indica si la configuración de esta página se ha incorporado a La configuración unificada mediante la creación de un nuevo registro. Si es true, la página se oculta cuando la configuración unificada está habilitada para que su configuración no esté duplicada.
IsServerAware	Obtiene o establece un valor que indica si la interfaz de usuario de esta página muestra la configuración que se sincroniza con el servidor en un escenario de cliente-servidor conectado mediante ISettingsManager3 o una API con una funcionalidad similar.
Keywords	Obtiene las palabras clave que se pueden buscar para esta página de opciones. Cada palabra clave puede ser una cadena literal, un nombre o identificador de recurso (con el prefijo "@"/"#") que apunta a una sola palabra clave, o un nombre o identificador de recurso (con el prefijo "@"/"#") que apunta a una lista de palabras clave delimitada por punto y coma.
NoShowAllView	Obtiene o establece si se muestran las páginas de opciones de herramientas agregadas.
PageName	Obtiene el nombre canónico no localizado de la página Opciones de herramientas.
PageNameResourceId	Obtiene el identificador de recursos de nombre de la página. (Heredado de ProvideOptionDialogPageAttribute)
PageType	Obtiene el tipo de la página. (Heredado de ProvideOptionDialogPageAttribute)
ProfileMigrationType	Establece el tipo de migración de perfil.
ProvidesLocalizedCategoryName	Determina si el paquete tiene los recursos localizados para el nombre de categoría.
Sort	Criterio de ordenación de la página de opciones. Las páginas de opciones se intercalan en el orden siguiente: `1. The General page 2. Pages with a Sort value, sorted from low to high. 3. Pages without a Sort value, sorted alphabetically.`
SupportsAutomation	Obtiene si una implementación de la página Opciones de herramientas admite la automatización.
SupportsProfiles	Obtiene o establece si una implementación de la página Opciones de herramientas usa el mecanismo de configuración de Visual Studio para conservar su estado.
TypeId	Obtiene la instancia actual de ProvideOptionPageAttribute.
UnifiedSettingsCategoryMoniker	Para las páginas con IsInUnifiedSettings = false, obtiene o establece el moniker de la categoría primaria en la jerarquía De configuración unificada. Puede ser un moniker que ya existe, o uno que exista más otro "". Segmento delimitado. Si es el último, se crea una nueva categoría denominada por CategoryResourceID en la jerarquía De configuración unificada y esta página se inserta en ella. De lo contrario, esta página se inserta en la categoría existente.
VisibilityCmdUIContexts	Una lista delimitada por punto y coma de GUID de UIContext. La página de opciones está visible cuando cualquier UIContext de la lista está activa. Si no se especifica, la página de opciones siempre está visible.

Métodos

GetPackageRegKeyPath(Guid)	Obtiene la ruta del Registro (en relación con la raíz del Registro de la aplicación) del Paquete VSPackage. (Heredado de RegistrationAttribute)
Register(RegistrationAttribute+RegistrationContext)	Registra la página Opciones de herramientas.
Unregister(RegistrationAttribute+RegistrationContext)	Quita la clave de página Opciones de herramientas del Registro.

Se aplica a

Compartir a través de