Classe ProvideOptionPageAttribute

Articolo
10/30/2012

Applicare questo attributo agli oggetti indipendenti per consentire agli utenti di configurare Vspackage di una pagina personalizzata di Opzioni degli strumenti .

Gerarchia di ereditarietà

System.Object
  System.Attribute
    Microsoft.VisualStudio.Shell.RegistrationAttribute
      Microsoft.VisualStudio.Shell.ProvideOptionDialogPageAttribute
        Microsoft.VisualStudio.Shell.ProvideOptionPageAttribute

Spazio dei nomi: Microsoft.VisualStudio.Shell
Assembly: Microsoft.VisualStudio.Shell.11.0 (in Microsoft.VisualStudio.Shell.11.0.dll)

Sintassi

'Dichiarazione
<AttributeUsageAttribute(AttributeTargets.Class, AllowMultiple := True, Inherited := True)> _
Public NotInheritable Class ProvideOptionPageAttribute _
    Inherits ProvideOptionDialogPageAttribute

[AttributeUsageAttribute(AttributeTargets.Class, AllowMultiple = true, Inherited = true)]
public sealed class ProvideOptionPageAttribute : ProvideOptionDialogPageAttribute

Il tipo ProvideOptionPageAttribute espone i seguenti membri.

Costruttori

	Nome	Descrizione
	ProvideOptionPageAttribute(Type, String, String, Int16, Int16, Boolean)	Inizializza una nuova istanza di ProvideOptionPageAttribute che indica che una determinata classe implementa il supporto di configurazione dell'utente al package VS in base a una pagina di Opzioni degli strumenti .
	ProvideOptionPageAttribute(Type, String, String, Int16, Int16, Boolean, Int32)
	ProvideOptionPageAttribute(Type, String, String, Int16, Int16, Boolean, String)
	ProvideOptionPageAttribute(Type, String, String, Int16, Int16, Boolean, array<String[])

In alto

Proprietà

	Nome	Descrizione
	CategoryName	Ottiene il nome non localizzata canonico della categoria della pagina di Opzioni degli strumenti .
	CategoryResourceID	Ottiene l'ID di categoria per una pagina di Opzioni degli strumenti .
	Keywords
	NoShowAllView	Ottiene o imposta se le pagine aggregate di Opzioni degli strumenti sono visualizzate.
	PageName	Ottiene il nome non localizzata canonico della pagina di Opzioni degli strumenti .
	PageNameResourceId	Ottiene l'ID della risorsa del nome della pagina. (Ereditato da ProvideOptionDialogPageAttribute)
	PageType	Ottiene il tipo di pagina. (Ereditato da ProvideOptionDialogPageAttribute)
	ProfileMigrationType	imposta il tipo di migrazione di profilo.
	ProvidesLocalizedCategoryName
	SupportsAutomation	Indica se un'implementazione della pagina di Opzioni degli strumenti supporta l'automazione.
	SupportsProfiles	Ottiene o imposta se un'implementazione della pagina di Opzioni degli strumenti utilizza il meccanismo delle impostazioni di Visual Studio per mantenere lo stato.
	TypeId	ottiene l'istanza corrente di ProvideOptionPageAttribute. (Esegue l'override di RegistrationAttribute.TypeId).

In alto

Metodi

	Nome	Descrizione
	Equals	Infrastruttura. Restituisce un valore che indica se l'istanza è uguale a un oggetto specificato. (Ereditato da Attribute)
	GetHashCode	Restituisce il codice hash per l'istanza. (Ereditato da Attribute)
	GetType	Ottiene l'oggetto Type dell'istanza corrente. (Ereditato da Object)
	IsDefaultAttribute	Una volta sottoposto a override in una classe derivata, indica se il valore di questa istanza è il valore predefinito per la classe derivata. (Ereditato da Attribute)
	Match	Una volta sottoposto a override in una classe derivata, restituisce un valore che indica se questa istanza equivale a un oggetto specificato. (Ereditato da Attribute)
	Register	registra la pagina di Opzioni degli strumenti . (Esegue l'override di RegistrationAttribute.Register(RegistrationAttribute.RegistrationContext)).
	ToString	Restituisce una stringa che rappresenta l'oggetto corrente. (Ereditato da Object)
	Unregister	Rimuove la chiave della pagina di Opzioni degli strumenti dal Registro di sistema. (Esegue l'override di RegistrationAttribute.Unregister(RegistrationAttribute.RegistrationContext)).

In alto

Implementazioni esplicite dell'interfaccia

	Nome	Descrizione
	_Attribute.GetIDsOfNames	Esegue il mapping di un set di nomi a un set corrispondente di ID dispatch. (Ereditato da Attribute)
	_Attribute.GetTypeInfo	Recupera le informazioni sui tipi per un oggetto, che può essere utilizzato per ottenere informazioni sul tipo per un'interfaccia. (Ereditato da Attribute)
	_Attribute.GetTypeInfoCount	Recupera il numero di interfacce di informazioni sui tipi che un oggetto garantisce (0 o 1). (Ereditato da Attribute)
	_Attribute.Invoke	Fornisce l'accesso a proprietà e metodi esposti da un oggetto. (Ereditato da Attribute)

In alto

Note

Note per gli implementatori

Applicare ProvideOptionPageAttribute alle classi che implementano un VSPackage.Questo attributo consente di accedere a un oggetto indipendente specifico fornisce agli utenti del package VS con accesso di configurazione di una pagina personalizzata di Opzioni degli strumenti .

contesto di attributo

si applica a	Vspackage consente la configurazione dalle pagine personalizzate di Opzioni degli strumenti ha implementato con DialogPage gestito del Framework del pacchetto o tramite il codice di Visual Studio SDK.
ripetibile	sì
attributi obbligatori	DefaultRegistryRootAttribute
attributi non validi	nessuno

Note per i chiamanti

Questo attributo viene utilizzato solo per scopi di registrazione e non influisce sul comportamento di runtime del codice.

ProvideOptionPageAttribute registra una determinata classe che implementa IProfileManager o DialogPage come fornisce il supporto particolare di un VSPackage per mantenere una parte o tutto lo stato di un VSPackage tramite il meccanismo delle impostazioni di Visual Studio .Le informazioni sullo stato salvato in modo permanente dalla classe di implementazione sono definiti categoria di impostazioni di Visual Studio e la relativa voce di definizione nel Registro di sistema vengono definiti un punto di impostazioni personalizzato.

[!NOTA]

Quando una pagina personalizzata gestita a Opzioni degli strumenti basata Framework del pacchetto viene caricata, l'ide crea un'istanza dell'oggetto registrato da ProvideOptionPageAttribute come distribuirlo.Il supporto gestito della pagina del Framework Opzioni degli strumenti del pacchetto deve essere implementato nel relativo oggetto e non nel package VS stesso.

Per ulteriori informazioni sulla creazione e sull'applicazione le istanze di ProvideOptionPageAttribute, vedere l'esempio di seguito e l'entity_M:Microsoft.VisualStudio.Shell.ProvideOptionPageAttribute.#ctor(System.Type, System.String, System.String, .Int16, System.Int16, System.Boolean).

Esempi

Nell'esempio riportato di seguito, un'istanza di ProvideOptionPageAttribute si applica a un'implementazione di package VS per registrare la classe DesignerOptionsPage, derivata da DialogPage, come fornendo il package VS una pagina di Opzioni degli strumenti .

Le classi derivate da DialogPage sono fornite con un'implementazione predefinita di funzionalità delle impostazioni di Visual Studio , che può essere sottoposto a override.L'ide utilizza questo supporto delle impostazioni di Visual Studio se, ad esempio, ProvideProfileAttribute si applica all'implementazione di un VSPackage.Per ulteriori informazioni su Visual Studio le impostazioni supportano, vedere Impostazioni utente e opzioni.

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
}