Procédure pas à pas : débogage des contrôles personnalisés WPF au moment du design
Cette procédure pas à pas indique comment déboguer un ornement au moment du design pour un contrôle personnalisé WPF (Windows Presentation Foundation). L'ornement est une case à cocher qui fournit une simple fonctionnalité de redimensionnement automatique.
Dans cette procédure pas à pas, vous allez effectuer les tâches suivantes :
créer un projet de bibliothèque de contrôles personnalisés WPF ;
créer un assembly distinct pour les métadonnées au moment du design ;
implémenter le fournisseur d'ornements ;
tester le contrôle au moment du design ;
configurer le projet pour le débogage au moment du design ;
déboguer le contrôle au moment du design.
Lorsque vous aurez terminé, vous saurez comment déboguer un ornement pour un contrôle personnalisé.
Notes
Les boîtes de dialogue et les commandes de menu qui s'affichent peuvent être différentes de celles qui sont décrites dans l'aide, en fonction de vos paramètres actifs ou de l'édition utilisée. Pour modifier vos paramètres, choisissez Importation et exportation de paramètres dans le menu Outils. Pour plus d'informations, consultez Utilisation des paramètres.
Composants requis
Pour exécuter cette procédure pas à pas, vous devez disposer des composants suivants :
- Visual Studio 2010.
Création du contrôle personnalisé
La première étape consiste à créer le projet pour le contrôle personnalisé. Le contrôle est un bouton avec une petite portion de code au moment du design, qui utilise la méthode GetIsInDesignMode pour implémenter un comportement au moment du design.
Pour créer le contrôle personnalisé
Créez un projet de bibliothèque de contrôles personnalisés WPF en Visual Basic ou Visual C# nommé AutoSizeButtonLibrary.
Le code pour CustomControl1 s'ouvre dans l'éditeur de code.
Dans l'Explorateur de solutions, remplacez le nom du fichier de code par AutoSizeButton.cs ou AutoSizeButton.vb. Si une boîte de message s'affiche pour demander si vous souhaitez renommer toutes les références dans ce projet, cliquez sur Oui.
Ouvrez AutoSizeButton.cs ou AutoSizeButton.vb dans l'éditeur de code.
Remplacez le code généré automatiquement par le code suivant. Ce code hérite de Button et affiche le texte « Actif en mode Design » lorsque le bouton apparaît dans le concepteur.
Imports System Imports System.Collections.Generic Imports System.Text Imports System.Windows.Controls Imports System.Windows.Media Imports System.ComponentModel ' The AutoSizeButton control implements a button ' with a custom design-time experience. Public Class AutoSizeButton Inherits Button Public Sub New() ' The following code enables custom design-mode logic. ' The GetIsInDesignMode check and the following design-time ' code are optional and shown only for demonstration. If DesignerProperties.GetIsInDesignMode(Me) Then Content = "Design mode active" End If End Sub End Class
using System; using System.Collections.Generic; using System.Text; using System.Windows.Controls; using System.Windows.Media; using System.ComponentModel; namespace AutoSizeButtonLibrary { // The AutoSizeButton control implements a button // with a custom design-time experience. public class AutoSizeButton : Button { public AutoSizeButton() { // The following code enables custom design-mode logic. // The GetIsInDesignMode check and the following design-time // code are optional and shown only for demonstration. if (DesignerProperties.GetIsInDesignMode(this)) { Content = "Design mode active"; } } } }
Le chemin de sortie du projet doit être « bin\ ».
Générez la solution.
Création de l'assembly de métadonnées au moment du design
Le code au moment du design est déployé dans des assemblys de métadonnées spéciaux. Pour cette procédure pas à pas, l'ornement personnalisé est déployé dans un assembly nommé AutoSizeButtonLibrary.VisualStudio.Design. Pour plus d'informations, consultez Mise à disposition de métadonnées au moment du design.
Pour créer l'assembly de métadonnées au moment du design
Ajoutez à la solution un nouveau projet de bibliothèque de classes en Visual Basic ou Visual C# nommé AutoSizeButtonLibrary.VisualStudio.Design.
Affectez au chemin de sortie du projet la valeur \AutoSizeButtonLibrary\bin\". Cela permet de garder l'assembly du contrôle et l'assembly de métadonnées dans le même dossier, ce qui active la découverte de métadonnées pour les concepteurs.
Ajoutez des références aux assemblys WPF suivants.
PresentationCore
PresentationFramework
System.Xaml
WindowsBase
Ajoutez des références aux assemblys du Concepteur WPF suivants.
Microsoft.Windows.Design.Extensibility
Microsoft.Windows.Design.Interaction
Ajoutez une référence au projet AutoSizeButtonLibrary.
Dans l'Explorateur de solutions, remplacez le nom du fichier de code Class1 par Metadata.cs ou Metadata.vb. Si une boîte de message s'affiche pour demander si vous souhaitez renommer toutes les références dans ce projet, cliquez sur Oui.
Remplacez le code généré automatiquement par le code suivant. Ce code crée un AttributeTable qui attache l'implémentation au moment du design personnalisée à la classe AutoSizeButton.
Imports System Imports System.Collections.Generic Imports System.Text Imports System.ComponentModel Imports System.Windows.Media Imports System.Windows.Controls Imports System.Windows Imports AutoSizeButtonLibrary Imports Microsoft.Windows.Design.Features Imports Microsoft.Windows.Design.Metadata Imports AutoSizeButtonLibrary.VisualStudio.Design ' The ProvideMetadata assembly-level attribute indicates to designers ' that this assembly contains a class that provides an attribute table. <Assembly: ProvideMetadata(GetType(AutoSizeButtonLibrary.VisualStudio.Design.Metadata))> ' Container for any general design-time metadata to initialize. ' Designers look for a type in the design-time assembly that ' implements IProvideAttributeTable. If found, designers instantiate ' this class and access its AttributeTable property automatically. Friend Class Metadata Implements IProvideAttributeTable ' Accessed by the designer to register any design-time metadata. Public ReadOnly Property AttributeTable() As AttributeTable _ Implements IProvideAttributeTable.AttributeTable Get Dim builder As New AttributeTableBuilder() builder.AddCustomAttributes( _ GetType(AutoSizeButton), _ New FeatureAttribute(GetType(AutoSizeAdornerProvider))) Return builder.CreateTable() End Get End Property End Class
using System; using System.Collections.Generic; using System.Text; using System.ComponentModel; using System.Windows.Media; using System.Windows.Controls; using System.Windows; using AutoSizeButtonLibrary; using Microsoft.Windows.Design.Features; using Microsoft.Windows.Design.Metadata; using AutoSizeButtonLibrary.VisualStudio.Design; // The ProvideMetadata assembly-level attribute indicates to designers // that this assembly contains a class that provides an attribute table. [assembly: ProvideMetadata(typeof(AutoSizeButtonLibrary.VisualStudio.Design.Metadata))] namespace AutoSizeButtonLibrary.VisualStudio.Design { // Container for any general design-time metadata to initialize. // Designers look for a type in the design-time assembly that // implements IProvideAttributeTable. If found, designers instantiate // this class and access its AttributeTable property automatically. internal class Metadata : IProvideAttributeTable { // Accessed by the designer to register any design-time metadata. public AttributeTable AttributeTable { get { AttributeTableBuilder builder = new AttributeTableBuilder(); builder.AddCustomAttributes( typeof(AutoSizeButton), new FeatureAttribute(typeof(AutoSizeAdornerProvider))); return builder.CreateTable(); } } } }
Enregistrez la solution.
Implémentation du fournisseur d'ornements
Le fournisseur d'ornements est implémenté dans un type nommé AutoSizeAdornerProvider. Cet ornement FeatureProvider permet de définir les propriétés Height et Width du contrôle au moment du design.
Pour implémenter le fournisseur d'ornements
Ajoutez une nouvelle classe nommée AutoSizeAdornerProvider au projet AutoSizeButtonLibrary.VisualStudio.Design.
Dans l'éditeur de code pour AutoSizeAdornerProvider, remplacez le code généré automatiquement par le code suivant. Ce code implémente un PrimarySelectionAdornerProvider qui fournit un ornement basé sur un contrôle CheckBox.
Imports System Imports System.Collections.Generic Imports System.Text Imports System.Windows.Input Imports System.Windows Imports System.Windows.Automation Imports System.Windows.Controls Imports System.Windows.Media Imports System.Windows.Shapes Imports Microsoft.Windows.Design.Interaction Imports Microsoft.Windows.Design.Model ' The following class implements an adorner provider for the ' AutoSizeButton control. The adorner is a CheckBox control, which ' changes the Height and Width of the AutoSizeButton to "Auto", ' which is represented by Double.NaN. Public Class AutoSizeAdornerProvider Inherits PrimarySelectionAdornerProvider Private settingProperties As Boolean Private adornedControlModel As ModelItem Private autoSizeCheckBox As CheckBox Private autoSizeAdornerPanel As AdornerPanel ' The constructor sets up the adorner control. Public Sub New() autoSizeCheckBox = New CheckBox() autoSizeCheckBox.Content = "AutoSize" autoSizeCheckBox.IsChecked = True autoSizeCheckBox.FontFamily = AdornerFonts.FontFamily autoSizeCheckBox.FontSize = AdornerFonts.FontSize autoSizeCheckBox.Background = CType( _ AdornerResources.FindResource(AdornerColors.RailFillBrushKey), _ Brush) End Sub ' The following method is called when the adorner is activated. ' It creates the adorner control, sets up the adorner panel, ' and attaches a ModelItem to the AutoSizeButton. Protected Overrides Sub Activate(ByVal item As ModelItem) ' Save the ModelItem and hook into when it changes. ' This enables updating the slider position when ' a new background value is set. adornedControlModel = item AddHandler adornedControlModel.PropertyChanged, AddressOf AdornedControlModel_PropertyChanged ' All adorners are placed in an AdornerPanel ' for sizing and layout support. Dim panel As AdornerPanel = Me.Panel ' Set up the adorner's placement. AdornerPanel.SetAdornerHorizontalAlignment(autoSizeCheckBox, AdornerHorizontalAlignment.OutsideLeft) AdornerPanel.SetAdornerVerticalAlignment(autoSizeCheckBox, AdornerVerticalAlignment.OutsideTop) ' Listen for changes to the checked state. AddHandler autoSizeCheckBox.Checked, AddressOf autoSizeCheckBox_Checked AddHandler autoSizeCheckBox.Unchecked, AddressOf autoSizeCheckBox_Unchecked ' Run the base implementation. MyBase.Activate(item) End Sub ' The Panel utility property demand-creates the ' adorner panel and adds it to the provider's ' Adorners collection. Public ReadOnly Property Panel() As AdornerPanel Get If Me.autoSizeAdornerPanel Is Nothing Then Me.autoSizeAdornerPanel = New AdornerPanel() ' Add the adorner to the adorner panel. Me.autoSizeAdornerPanel.Children.Add(autoSizeCheckBox) ' Add the panel to the Adorners collection. Adorners.Add(autoSizeAdornerPanel) End If Return Me.autoSizeAdornerPanel End Get End Property ' The following code handles the Checked event. ' It autosizes the adorned control's Height and Width. Sub autoSizeCheckBox_Checked(ByVal sender As Object, ByVal e As RoutedEventArgs) Me.SetHeightAndWidth(True) End Sub ' The following code handles the Unchecked event. ' It sets the adorned control's Height and Width to a hard-coded value. Sub autoSizeCheckBox_Unchecked(ByVal sender As Object, ByVal e As RoutedEventArgs) Me.SetHeightAndWidth(False) End Sub ' The SetHeightAndWidth utility method sets the Height and Width ' properties through the model and commits the change. Private Sub SetHeightAndWidth(ByVal [auto] As Boolean) settingProperties = True Dim batchedChange As ModelEditingScope = adornedControlModel.BeginEdit() Try Dim widthProperty As ModelProperty = adornedControlModel.Properties("Width") Dim heightProperty As ModelProperty = adornedControlModel.Properties("Height") If [auto] Then widthProperty.ClearValue() heightProperty.ClearValue() Else widthProperty.SetValue(20.0) heightProperty.SetValue(20.0) End If batchedChange.Complete() Finally batchedChange.Dispose() settingProperties = False End Try End Sub ' The following method deactivates the adorner. Protected Overrides Sub Deactivate() RemoveHandler adornedControlModel.PropertyChanged, _ AddressOf AdornedControlModel_PropertyChanged MyBase.Deactivate() End Sub ' The following method handles the PropertyChanged event. Sub AdornedControlModel_PropertyChanged( _ ByVal sender As Object, _ ByVal e As System.ComponentModel.PropertyChangedEventArgs) If settingProperties Then Return If e.PropertyName = "Height" Or e.PropertyName = "Width" Then Dim h As Double = CType(adornedControlModel.Properties("Height").ComputedValue, Double) Dim w As Double = CType(adornedControlModel.Properties("Width").ComputedValue, Double) If Double.IsNaN(h) And Double.IsNaN(w) Then autoSizeCheckBox.IsChecked = True Else autoSizeCheckBox.IsChecked = False End If End If End Sub End Class
using System; using System.Collections.Generic; using System.Text; using System.Windows.Input; using System.Windows; using System.Windows.Automation; using System.Windows.Controls; using System.Windows.Media; using System.Windows.Shapes; using Microsoft.Windows.Design.Interaction; using Microsoft.Windows.Design.Model; namespace AutoSizeButtonLibrary.VisualStudio.Design { // The following class implements an adorner provider for the // AutoSizeButton control. The adorner is a CheckBox control, which // changes the Height and Width of the AutoSizeButton to "Auto", // which is represented by double.NaN. public class AutoSizeAdornerProvider : PrimarySelectionAdornerProvider { bool settingProperties; private ModelItem adornedControlModel; CheckBox autoSizeCheckBox; AdornerPanel autoSizeAdornerPanel; // The constructor sets up the adorner control. public AutoSizeAdornerProvider() { autoSizeCheckBox = new CheckBox(); autoSizeCheckBox.Content = "AutoSize"; autoSizeCheckBox.IsChecked = true; autoSizeCheckBox.FontFamily = AdornerFonts.FontFamily; autoSizeCheckBox.FontSize = AdornerFonts.FontSize; autoSizeCheckBox.Background = AdornerResources.FindResource( AdornerColors.RailFillBrushKey) as Brush; } // The following method is called when the adorner is activated. // It creates the adorner control, sets up the adorner panel, // and attaches a ModelItem to the AutoSizeButton. protected override void Activate(ModelItem item) { // Save the ModelItem and hook into when it changes. // This enables updating the slider position when // a new background value is set. adornedControlModel = item; adornedControlModel.PropertyChanged += new System.ComponentModel.PropertyChangedEventHandler( AdornedControlModel_PropertyChanged); // All adorners are placed in an AdornerPanel // for sizing and layout support. AdornerPanel panel = this.Panel; // Set up the adorner's placement. AdornerPanel.SetAdornerHorizontalAlignment(autoSizeCheckBox, AdornerHorizontalAlignment.OutsideLeft); AdornerPanel.SetAdornerVerticalAlignment(autoSizeCheckBox, AdornerVerticalAlignment.OutsideTop); // Listen for changes to the checked state. autoSizeCheckBox.Checked += new RoutedEventHandler(autoSizeCheckBox_Checked); autoSizeCheckBox.Unchecked += new RoutedEventHandler(autoSizeCheckBox_Unchecked); // Run the base implementation. base.Activate(item); } // The Panel utility property demand-creates the // adorner panel and adds it to the provider's // Adorners collection. private AdornerPanel Panel { get { if (this.autoSizeAdornerPanel == null) { autoSizeAdornerPanel = new AdornerPanel(); // Add the adorner to the adorner panel. autoSizeAdornerPanel.Children.Add(autoSizeCheckBox); // Add the panel to the Adorners collection. Adorners.Add(autoSizeAdornerPanel); } return this.autoSizeAdornerPanel; } } // The following code handles the Checked event. // It autosizes the adorned control's Height and Width. void autoSizeCheckBox_Checked(object sender, RoutedEventArgs e) { this.SetHeightAndWidth(true); } // The following code handles the Unchecked event. // It sets the adorned control's Height and Width to a hard-coded value. void autoSizeCheckBox_Unchecked(object sender, RoutedEventArgs e) { this.SetHeightAndWidth(false); } // The SetHeightAndWidth utility method sets the Height and Width // properties through the model and commits the change. private void SetHeightAndWidth(bool autoSize) { settingProperties = true; try { using (ModelEditingScope batchedChange = adornedControlModel.BeginEdit()) { ModelProperty widthProperty = adornedControlModel.Properties["Width"]; ModelProperty heightProperty = adornedControlModel.Properties["Height"]; if (autoSize) { widthProperty.ClearValue(); heightProperty.ClearValue(); } else { widthProperty.SetValue(20d); heightProperty.SetValue(20d); } batchedChange.Complete(); } } finally { settingProperties = false; } } // The following method deactivates the adorner. protected override void Deactivate() { adornedControlModel.PropertyChanged -= new System.ComponentModel.PropertyChangedEventHandler( AdornedControlModel_PropertyChanged); base.Deactivate(); } // The following method handles the PropertyChanged event. void AdornedControlModel_PropertyChanged( object sender, System.ComponentModel.PropertyChangedEventArgs e) { if (settingProperties) { return; } if (e.PropertyName == "Height" || e.PropertyName == "Width") { double h = (double)adornedControlModel.Properties["Height"].ComputedValue; double w = (double)adornedControlModel.Properties["Width"].ComputedValue; autoSizeCheckBox.IsChecked = (h == double.NaN && w == double.NaN) ? true : false; } } } }
Générez la solution.
Test de l'implémentation au moment du design
Vous pouvez utiliser le contrôle AutoSizeButton comme vous utiliseriez tout autre contrôle WPF. Le Concepteur WPF gère la création de tous les objets au moment du design.
Pour tester l'implémentation au moment du design
Ajoutez à la solution un nouveau projet d'application WPF nommé DemoApplication.
MainWindow.xaml s'ouvre dans le Concepteur WPF.
Ajoutez une référence au projet AutoSizeButtonLibrary.
En mode XAML, remplacez le code généré automatiquement par le code suivant. Ce code XAML ajoute une référence à l'espace de noms AutoSizeButtonLibrary ainsi que le contrôle personnalisé AutoSizeButton. Le bouton apparaît en mode Design avec le texte « Actif en mode Design », indiquant que ce mode est activé. Si le bouton ne s'affiche pas, il peut s'avérer nécessaire de cliquer sur la barre d'informations, située dans la partie supérieure du concepteur, pour recharger la vue.
<Window x:Class="DemoApplication.MainWindow" xmlns="https://schemas.microsoft.com/winfx/2006/xaml/presentation" xmlns:x="https://schemas.microsoft.com/winfx/2006/xaml" xmlns:ab="clr-namespace:AutoSizeButtonLibrary;assembly=AutoSizeButtonLibrary" Title="Window1" Height="300" Width="300"> <Grid> <ab:AutoSizeButton Height="Auto" Width="Auto" /> </Grid> </Window>
En mode Design, cliquez sur le contrôle AutoSizeButton pour le sélectionner.
Un contrôle CheckBox apparaît au-dessus du contrôle AutoSizeButton.
Désactivez l'ornement case à cocher.
La taille du contrôle diminue. L'ornement case à cocher se déplace pour conserver sa position par rapport au contrôle orné.
Configuration du projet pour le débogage au moment du design
À ce stade, vous avez terminé l'implémentation au moment du design. Vous pouvez à présent utiliser Visual Studio pour définir des points d'arrêt et effectuer un pas à pas détaillé dans votre code au moment du design. Pour déboguer votre implémentation au moment du design, vous attachez une autre instance de Visual Studio à la session Visual Studio active.
Pour configurer le projet pour le débogage au moment du design
Dans l'Explorateur de solutions, cliquez avec le bouton droit sur le projet DemoApplication, puis sélectionnez Définir comme projet de démarrage.
Dans l'Explorateur de solutions, cliquez avec le bouton droit sur le projet DemoApplication, puis cliquez sur Propriétés.
Dans le Concepteur de projets DemoApplication, cliquez sur l'onglet Déboguer.
Dans la section Action de démarrage, sélectionnez Démarrer le programme externe. Vous allez déboguer une instance distincte de Visual Studio.
Cliquez sur le bouton de sélection () pour ouvrir la boîte de dialogue Sélectionner le fichier.
Recherchez Visual Studio. Le nom du fichier exécutable est devenv.exe et, si vous avez installé Visual Studio à l'emplacement par défaut, son chemin d'accès est « %programfiles%\Microsoft Visual Studio 9.0\Common7\IDE\devenv.exe ».
Cliquez sur Ouvrir pour sélectionner devenv.exe.
Débogage de votre contrôle personnalisé au moment du design
Maintenant vous êtes prêt à déboguer votre contrôle personnalisé pendant il s'exécute en mode Design. Lorsque vous démarrez la session de débogage, une nouvelle instance de Visual Studio est créée et vous devez l'utiliser pour charger la solution AutoSizeButtonLibrary. Lorsque vous ouvrez MainWindow.xaml dans le Concepteur WPF, une instance de votre contrôle personnalisé est créée et commence à s'exécuter.
Pour déboguer votre contrôle personnalisé au moment du design
Ouvrez le fichier de code AutoSizeButton dans l'éditeur de code et ajoutez un point d'arrêt dans le constructeur.
Ouvrez Metadata.cs ou Metadata.vb dans l'éditeur de code et ajoutez un point d'arrêt dans la propriété AttributeTable.
Ouvrez AutoSizeAdornerProvider.cs ou AutoSizeAdornerProvider.vb dans l'éditeur de code et ajoutez un point d'arrêt dans le constructeur.
Ajoutez des points d'arrêt dans les autres méthodes de la classe AutoSizeAdornerProvider.
Appuyez sur F5 pour démarrer la session de débogage.
Une seconde instance de Visual Studio est créée. Vous pouvez effectuer la distinction entre l'instance de débogage et la seconde instance de deux manières différentes :
La barre de titre de l'instance de débogage contient le mot En cours d'exécution.
Pour l'instance de débogage, le bouton Démarrer est désactivé sur sa barre d'outils Déboguer.
Votre point d'arrêt est défini dans l'instance de débogage.
Dans la seconde instance de Visual Studio, ouvrez la solution AutoSizeButtonLibrary.
Ouvrez MainWindow.xaml dans le Concepteur WPF.
L'instance de débogage de Visual Studio acquiert le focus et l'exécution s'arrête au point d'arrêt dans la propriété AttributeTable.
Appuyez sur F5 pour continuer le débogage.
L'exécution s'arrête au point d'arrêt dans le constructeur AutoSizeButton.
Appuyez sur F5 pour continuer le débogage.
La seconde instance de Visual Studio obtient le focus et le Concepteur WPF s'affiche.
En mode Design, cliquez sur le contrôle AutoSizeButton pour le sélectionner.
L'instance de débogage de Visual Studio obtient le focus et l'exécution s'arrête au point d'arrêt dans le constructeur AutoSizeAdornerProvider.
Appuyez sur F5 pour continuer le débogage.
L'exécution s'arrête au point d'arrêt dans la méthode Activate.
Appuyez sur F5 pour continuer le débogage.
La seconde instance de Visual Studio obtient le focus et le Concepteur WPF s'affiche. L'ornement case à cocher s'affiche au-dessus et à gauche de AutoSizeButton.
Lorsque vous avez terminé, vous pouvez arrêter la session de débogage en fermant la seconde instance de Visual Studio ou en cliquant sur le bouton Arrêter le débogage dans l'instance de débogage.
Étapes suivantes
Vous pouvez ajouter d'autres fonctionnalités personnalisées au moment du design à vos contrôles personnalisés.
Ajoutez un ornement personnalisé au moment du design de votre contrôle. Pour plus d'informations, consultez Procédure pas à pas : création d'un ornement au moment du design.
Créez un éditeur pour un type personnalisé, éditeur que vous pouvez utiliser dans la fenêtre Propriétés. Pour plus d'informations, consultez Comment : créer un éditeur de valeurs.
Créez un éditeur de couleurs, que vous pouvez utiliser dans la fenêtre Propriétés. Pour plus d'informations, consultez Procédure pas à pas : implémentation d'un éditeur de couleurs.
Voir aussi
Tâches
Procédure pas à pas : débogage d'une application WPF
Référence
PrimarySelectionAdornerProvider
Concepts
Dépannage des erreurs de chargement des concepteurs WPF et Silverlight
Autres ressources
Comment : déboguer une erreur de chargement de concepteur