DialogPage, classe

Article
08/01/2012

Fournit une fonctionnalité standarde de boîte de dialogue pour implémenter des feuilles de propriétés de boîte à outils, des pages d'OutilsOptions, ou des boîtes de dialogue personnalisées d'interface utilisateur, avec une prise en charge du modèle Automation de Visual Studio, de Windows Forms, et de la persistance d'état en utilisant du mécanisme de paramètres de Visual Studio.

Hiérarchie d'héritage

System.Object
  System.MarshalByRefObject
    System.ComponentModel.Component
      Microsoft.VisualStudio.Shell.DialogPage
        Microsoft.VisualStudio.Shell.UIElementDialogPage

Espace de noms : Microsoft.VisualStudio.Shell
Assembly : Microsoft.VisualStudio.Shell.11.0 (dans Microsoft.VisualStudio.Shell.11.0.dll)

Syntaxe

'Déclaration
<ComVisibleAttribute(True)> _
Public Class DialogPage _
    Inherits Component _
    Implements IWin32Window, IProfileManager

[ComVisibleAttribute(true)]
public class DialogPage : Component, IWin32Window, 
    IProfileManager

Le type DialogPage expose les membres suivants.

Constructeurs

	Nom	Description
	DialogPage	Initialise une nouvelle instance d'DialogPage.

Début

Propriétés

	Nom	Description
	AutomationObject	Obtient l'objet de modèle Automation de DTE pour une instance donnée d'une classe de page de dialogue.
	CanRaiseEvents	Obtient une valeur qui indique si le composant peut déclencher un événement. (Hérité de Component.)
	Container	Obtient le IContainer qui contient Component. (Hérité de Component.)
	DesignMode	Obtient une valeur qui indique si Component est actuellement en mode design. (Hérité de Component.)
	Events	Obtient la liste des gestionnaires d'événements attachés à ce Component. (Hérité de Component.)
	SettingsRegistryPath	Obtient ou définit la sous-clé sous la racine spécifique à la version de Visual Studio pour enregistrer des données de paramètres pour une page de dialogue.
	Site	Obtient ou définit le site de la page de dialogue.Substitue l'implémentation héritée d'Component. (Substitue Component.Site.)
	Window	Obtient la fenêtre qui est utilisée comme interface utilisateur de la page de dialogue.

Début

Méthodes

	Nom	Description
	CreateObjRef	Crée un objet contenant toutes les informations appropriées requises pour générer un proxy permettant de communiquer avec un objet distant. (Hérité de MarshalByRefObject.)
	Dispose()	Libère toutes les ressources utilisées par Component. (Hérité de Component.)
	Dispose(Boolean)	Libère les ressources non managées qui sont utilisées par une classe de page de dialogue et libère éventuellement les ressources managées ; la classe parente, Component prend en charge les ressources non managées. (Substitue Component.Dispose(Boolean).)
	Equals	Détermine si l'objet Object spécifié est égal à l'objet Object actuel. (Hérité de Object.)
	Finalize	Libère les ressources non managées et exécute d'autres opérations de nettoyage avant la récupération de Component par le garbage collection. (Hérité de Component.)
	GetHashCode	Sert de fonction de hachage pour un type particulier. (Hérité de Object.)
	GetLifetimeService	Récupère l'objet de service de durée de vie en cours qui contrôle la stratégie de durée de vie de cette instance. (Hérité de MarshalByRefObject.)
	GetService	Retourne un objet qui représente un service fourni par Component ou par son Container. (Hérité de Component.)
	GetType	Obtient le Type de l'instance actuelle. (Hérité de Object.)
	InitializeLifetimeService	Obtient un objet de service de durée de vie pour contrôler la stratégie de durée de vie de cette instance. (Hérité de MarshalByRefObject.)
	LoadSettingsFromStorage	Appelé par Visual Studio pour charger les paramètres d'une page de dialogue du stockage local, en général le Registre.
	LoadSettingsFromXml	Appelé par Visual Studio pour charger les paramètres d'une page de dialogue du stockage de paramètres de Visual Studio sur le disque.
	MemberwiseClone()	Crée une copie superficielle de l'objet Object actuel. (Hérité de Object.)
	MemberwiseClone(Boolean)	Crée une copie superficielle de l'objet MarshalByRefObject actuel. (Hérité de MarshalByRefObject.)
	OnActivate	Messages d'Activate de fenêtres de handles de l'environnement de Visual Studio.
	OnApply	Traite des messages d'Apply de l'environnement de Visual Studio.
	OnClosed	Traite des messages d'Close de l'environnement de Visual Studio.
	OnDeactivate	Traite des messages d'Deactive de l'environnement de Visual Studio.
	ResetSettings	Doit être substitué pour réinitialiser des paramètres à leurs valeurs par défaut.
	SaveSettingsToStorage	Appelé par Visual Studio pour enregistrer les paramètres d'une page de dialogue dans le stockage local, en général le Registre.
	SaveSettingsToXml	Appelé par Visual Studio pour enregistrer les paramètres d'une page de dialogue au stockage de paramètres de Visual Studio sur le disque.
	ToString	Retourne String contenant le nom du Component, s'il existe.Cette méthode ne doit pas être substituée. (Hérité de Component.)

Début

Événements

	Nom	Description
	Disposed	Se produit lorsque le composant est supprimé par un appel à la méthode Dispose. (Hérité de Component.)

Début

Implémentations d'interface explicite

	Nom	Description
	IWin32Window.Handle	Obtient le handle de la fenêtre de la page de dialogue.

Début

Remarques

Remarques à l'intention des implémenteurs

Implémentez les classes dérivées d'DialogPage lorsque vous créez une boîte de dialogue d'utilisateur, notamment une page de Outils Options ou une page de propriétés de boîte à outils.

Remarques pour des appelants

L'implémentation la plus simple d'DialogPage requiert uniquement la définition des propriétés publiques sur la classe implémentante.Les types de propriété doivent prendre en charge la conversion vers et depuis des chaînes via TypeConverter.

L'implémentation de base d'DialogPage fournit les gestionnaires par défaut pour des événements standards de fenêtres, et implémente Component, IWin32Window, et IProfileManager.

Les classes dérivées d'DialogPage ont les éléments suivants :

Prise en charge automatique du partage composant via le modèle d'objet Automation de Visual Studio DTE.
- Toute instance d'DialogPage est un objet Automation, car la classe hérite l'implémentation d'interface d'Component.
- Applications qui doivent accéder à l'objet Automation de l'utilisation de classe la propriété d'AutomationObject.
  
  La propriété d'AutomationObject retourne this (Me dans Visual Basic), car l'implémentation d'DialogPage est déjà un objet Automation par défaut.
- Une implémentation d'DialogPage peut offrir un objet Automation autre que elle-même en substituant l'implémentation de base d'AutomationObject.Par exemple, cette opération peut être effectuée pour fournir l'interface utilisateur séparée et les modèles objet.
Le prenez en charge pour le mécanisme de paramètres de Visual Studio, selon les propriétés publiques de l'objet Automation de la classe dérivée.
- Pour un objet dérivé d'DialogPage pour fournir la persistance, il doit être enregistré à l'aide de ProvideProfileAttribute.
- Les types dérivés d'DialogPage héritent une implémentation par défaut de persistance d'IProfileManager.
- L'implémentation par défaut persiste toutes les propriétés publiques de l'objet Automation de la classe dervied, qui est l'objet qui est retourné par AutomationObject et qui prend en charge la conversion vers et depuis des chaînes via TypeConverter.
- Ce comportement peut être modifié en substituant l'LoadSettingsFromXml, l'SaveSettingsToXml, l'LoadSettingsFromStorage, et l'SaveSettingsToStorage.
Une interface utilisateur par défaut qui est selon les propriétés publiques de l'objet Automation de la classe dérivée.
- Pour qu'une implémentation de page de dialogue fournisse une page de Outils Options, elle doit être enregistrée à l'aide de ProvideOptionPageAttribute.
- Pour qu'une implémentation de page de dialogue fournisse une page de dialogue de boîte à outils, elle doit être enregistrée à l'aide de ProvideToolboxPageAttribute.
- Les pages de dialogue utilisent Window pour retourner IWin32Window, qui fournit un handle vers la fenêtre qui fournit l'interface utilisateur de la classe.
- Par défaut, la fenêtre qui est référencée par Window est une grille des propriétés, qui est implémentée par une instance d'PropertyGrid en sélectionnant l'objet Automation.
- La classe de base d'DialogPage utilise son implémentation d'AutomationObject pour obtenir l'objet Automation de la classe et les propriétés publiques de cet objet Automation.
- Des modifications aux propriétés publiques faites via l'interface utilisateur d'une page de dialogue sont automatiquement enregistrées au stockage local (en général le Registre) par un appel à la méthode d'SaveSettingsToStorage.
- Une implémentation de page de dialogue peut modifier son interface utilisateur en substituant Window.

[!REMARQUE]

En général, une instance d'une classe de page de dialogue est son propre objet Automation.Par conséquent, les propriétés qui sont persistées ou affichées sont ceux de la classe qui est dérivée d'DialogPage.Toutefois, si AutomationObject retourne un autre objet, c'est que les propriétés de l'objet, pas la classe, qui sont persistées ou affichées.

Sécurité des threads

Tous les membres static (Shared en Visual Basic) publics de ce type sont thread-safe. Il n'est pas garanti que les membres d'instance soient thread-safe.