Demonstra Passo a passo: Depuração de controles do WPF personalizados em time de design
Essa explicação passo a passo mostra como criar um adorno em tempo de design de um controle personalizado Windows Presentation Foundation (WPF).O adorner é um caixa de seleção, que fornece um recurso dimensionamento automático simples.
Nesta explicação passo a passo, você executa as seguintes tarefas:
Criar um projeto de biblioteca de controle personalizado WPF .
Criar um conjunto de módulos (assembly) separado de metadados em tempo de design.
Implementar o provedor de adorno.
Testar o controle em tempo de design.
Configurar o projeto para a depuração em tempo de design.
Testar o controle em tempo de design.
Quando você terminar, você saberá como criar um provedor de adorno para um controle personalizado.
Observação: |
---|
As caixas de diálogo e comandos de menu demonstradas podem ser diferentes daqueles descritas na Ajuda, dependendo das configurações ativas ou configurações de edição.Para alterar as configurações, escolher Importar e exportar configurações on the Ferramentas menu.Para obter mais informações, consulte Configurações do Visual Studio. |
Pré-requisitos
Para completar este passo a passo, são necessários os seguintes componentes:
- Visual Studio 2008.
Criando o Controle Personalizado
A primeira etapa é criar o projeto para o controle personalizado.O controle é um botão simples com pequena quantidade de código em tempo de design, que usa o método GetIsInDesignMode para implementar um comportamento de tempo de design.
Para criar o controle personalizado
Criar um novo projeto Biblioteca de controle personalizado WPF em Visual Basic ou Visual C# chamado SkewButtonLibrary .
O código de CustomControl1 abre no Editor de Códigos.
In O gerenciador de soluções, altere o nome do arquivo de código para AutoSizeButton.cs ou AutoSizeButton.vb.Se um caixa de mensagem aparecer que pergunta se você deseja executar uma renomeação para todas as referências no projeto atual, clique em Sim .
Em Gerenciador de Soluções, expanda a pasta Temas.
Clique duas vezes em Generic.xaml.
Generic.xaml é aberto no WPF Designer.
No modo de exibição XAML, substitua todas as ocorrências de "CustomControl1" com "ButtonWithDesignTime".
Abra AutoSizeButton.cs ou AutoSizeButton.vb no Editor de Códigos.
Substitua o código gerado automaticamente pelo código a seguir.O controle personalizado Button herda de e exibe o texto "modo de design ativo" quando o botão aparece no designer.
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"; } } } }
Defina o caminho de saída do projeto para "bin\".
Crie a solução.
Criando o Conjunto de Módulos (Assembly) de Metadados em Tempo de Design
Código em tempo de design é implantado em conjuntos de módulos (assemblies) de metadados especiais.Para esta explicação passo a passo, adorno personalizado é implantado em um assembly chamado AutoSizeButtonLibrary.VisualStudio.Design.Para obter mais informações, consulte Armazenamento de metadados.
Para criando o conjunto de módulos (assembly) de metadados em tempo de design
Adicione um novo projeto de biblioteca de classes no Visual Basic ou Visual C# denominado CustomControlLibrary.VisualStudio.Design à solução.
conjunto caminho de saída do projeto para "..\AutoSizeButtonLibrary\bin\ ".Isso mantém o conjunto de módulos (assembly) do controle e o conjunto de módulos (assembly) de metadados na mesma pasta, o que permite a descoberta de metadados para os designers.
Adicione referências para os seguintes conjuntos de módulos (assemblies) WPF.
PresentationCore
PresentationFramework
WindowsBase
Adicione referências para os seguintes conjuntos de módulos (assemblies) WPF Designer:
Microsoft.Windows.Design
Microsoft.Windows.Design.Extensibility
Microsoft.Windows.Design.Interaction
Adicione uma referência ao projeto AutoSizeButtonLibrary.
Em Gerenciador de Soluções, altere o nome do arquivo de código Class1 para Metadata.cs ou Metadata.vb.Se um caixa de mensagem aparecer que pergunta se você deseja executar uma renomeação para todas as referências no projeto atual, clique em Sim .
Substitua o código gerado automaticamente pelo código a seguir.Esse código cria um AttributeTable que anexa a implementação personalizada em tempo de design à 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 ' Container for any general design-time metadata to initialize. ' Designers look for a type in the design-time assembly that ' implements IRegisterMetadata. If found, designers instantiate ' this class and call its Register() method automatically. Friend Class Metadata Implements IRegisterMetadata ' Called by the designer to register any design-time metadata. Public Sub Register() Implements IRegisterMetadata.Register Dim builder As New AttributeTableBuilder() builder.AddCustomAttributes(GetType(AutoSizeButton), New FeatureAttribute(GetType(AutoSizeAdornerProvider))) MetadataStore.AddAttributeTable(builder.CreateTable()) End Sub 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; 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 IRegisterMetadata. If found, designers instantiate // this class and call its Register() method automatically. internal class Metadata : IRegisterMetadata { // Called by the designer to register any design-time metadata. public void Register() { AttributeTableBuilder builder = new AttributeTableBuilder(); builder.AddCustomAttributes( typeof(AutoSizeButton), new FeatureAttribute(typeof(AutoSizeAdornerProvider))); MetadataStore.AddAttributeTable(builder.CreateTable()); } } }
Salve a solução.
Implementando o Provedor de Adorno.
O provedor de adorno é implementado em um tipo denominado AutoSizeAdornerProvider.Esta adorner FeatureProvider Permite definindo o controle do Height e Width propriedades em tempo de design.
Para implementar o provedor de adorno.
Adicione uma nova classe denominada AutoSizeAdornerProvider ao projeto CustomControlLibrary.Design.
No Editor de Códigos de AutoSizeAdornerProvider, substitua o código gerado automaticamente pelo código a seguir.Esse código implementa um PrimarySelectionAdornerProvider que fornece uma adorno baseado em um controle 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, ByVal view As DependencyObject) ' 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. Dim placement As New AdornerPlacementCollection() AdornerPanel.SetHorizontalStretch(autoSizeCheckBox, AdornerStretch.None) AdornerPanel.SetVerticalStretch(autoSizeCheckBox, AdornerStretch.None) panel.CoordinateSpace = AdornerCoordinateSpaces.Layout placement.SizeRelativeToAdornerDesiredWidth(1.0, 0) placement.SizeRelativeToAdornerDesiredHeight(1.0, 0) placement.PositionRelativeToAdornerHeight(-1.0, -23) placement.PositionRelativeToAdornerWidth(0, -23) AdornerPanel.SetPlacements(autoSizeCheckBox, placement) ' 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, view) 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(Control.WidthProperty) Dim heightProperty As ModelProperty = adornedControlModel.Properties(Control.HeightProperty) 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(Control.HeightProperty).ComputedValue, Double) Dim w As Double = CType(adornedControlModel.Properties(Control.WidthProperty).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, DependencyObject view) { // 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. AdornerPlacementCollection placement = new AdornerPlacementCollection(); AdornerPanel.SetHorizontalStretch(autoSizeCheckBox, AdornerStretch.None); AdornerPanel.SetVerticalStretch(autoSizeCheckBox, AdornerStretch.None); panel.CoordinateSpace = AdornerCoordinateSpaces.Layout; placement.SizeRelativeToAdornerDesiredWidth(1.0, 0); placement.SizeRelativeToAdornerDesiredHeight(1.0, 0); placement.PositionRelativeToAdornerHeight(-1.0, -23); placement.PositionRelativeToAdornerWidth(0, -23); AdornerPanel.SetPlacements(autoSizeCheckBox, placement); // 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, view); } // 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[Control.WidthProperty]; ModelProperty heightProperty = adornedControlModel.Properties[Control.HeightProperty]; 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[Control.HeightProperty].ComputedValue; double w = (double)adornedControlModel.Properties[Control.WidthProperty].ComputedValue; autoSizeCheckBox.IsChecked = (h == double.NaN && w == double.NaN) ? true : false; } } } }
Crie a solução.
Testando a Implementação em Tempo de Design
Você pode usar o controle AutoSizeButton do modo como você usaria qualquer outro controle WPF.O WPF Designer trata a criação de todos os objetos em tempo de design.
Para testar a implementação em tempo de design
Adicione um projeto de aplicativos do Windows chamado WpfUserControlHost à solução.
Window1.xaml é aberto no WPF Designer.
Adicione uma referência ao projeto AutoSizeButtonLibrary.
No modo de exibição XAML, substitua o XAML gerado automaticamente pelo seguinte XAML.Este XAML adiciona uma referência ao namespace AutoSizeButtonLibrary e adiciona o controle personalizado AutoSizeButton.O botão aparece no modo Design com um plano de fundo vermelho, indicando que o controle está no modo de design.Se o botão não for exibido, talvez você precise clicar na Barra de Informações na parte superior do designer para recarregar o modo de exibição.
<Window x:Class="DemoApplication.Window1" 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 /> </Grid> </Window>
<Window x:Class="DemoApplication.Window1" 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>
No modo Design, clique no controle AutoSizeButton para selecioná-lo.
Um controle CheckBox aparece acima do controle AutoSizeButton.
Desmarque o adorner caixa de seleção.
O controle reduz de tamanho.O adorner caixa de seleção move para manter sua posição relativa ao controle adorned.
Configurar o projeto para a depuração em tempo de design.
Neste ponto, você concluiu a implementação de tempo de design.Agora você pode usar Visual Studio Para conjunto pontos de interrupção e Avançar em seu código de time de design. Para depurar a implementação de time de design, você associar outra instância do Visual Studio sua corrente Visual Studio sessão.
Configurar o projeto para a depuração em tempo de design.
Em Solution Explorer, clique com o botão direito do mouse o projeto Client e selecione Project Set As Startup .
Em Gerenciador de Soluções ,clique com o botão direito do mouse no projeto DemoApplication e selecione Propriedades .
Na DemoApplication designer do projeto, clique na guia Debug.
Na caixa Início da ação seção, selecione Iniciar programa externo.Você vai ser depuração uma instância separada do Visual Studio.
Clique no botão reticências () para abrir o Selecionar arquivo caixa de diálogo.
Procure por Visual Studio.O nome do arquivo executável é Devenv.exe, e se você instalou Visual Studio no local padrão, seu caminho será "%arquivosdeprogramas%\Microsoft Visual Studio 9.0\Common7\IDE\devenv.exe".
clicar em aberto selecionar devenv.exe.
Depurando O controle personalizado em tempo de design
Agora você está pronto para depurar o controle personalizado à medida que ele é executado no modo de design.Quando você inicia o sessão de depuração, uma nova instância de Visual Studio será criada, e você usará-lo para carregar a solução AutoSizeButtonLibrary.Quando você abre Window1.XAML na caixa WPF Designer, uma instância do seu controle personalizado será criada e começará a executar.
Depurando O controle personalizado em tempo de design
Abra o arquivo AutoSizeButton de código no Editor de códigos e adicione um ponto de interrupção no construtor.
Abra METADATA.cs ou METADATA.vb no Editor de códigos e adicione um ponto de interrupção no método Register.
Abrir AutoSizeAdornerProvider.cs ou AutoSizeAdornerProvider.vb no Editor de códigos e adicione um ponto de interrupção do construtor.
Adicione os métodos restantes para a classe AutoSizeAdornerProvider pontos de interrupção.
Pressione F5 para iniciar a depuração da solução.
Uma segunda instância de Visual Studio é criada.Você pode distinguir entre a instância de depuração e a segunda instância de duas maneiras:
A instância de depuração tem a palavra Running no seu barra de título.
A instância de depuração tem botão Start no seu Debug da barra de ferramentas desativado.
O ponto de interrupção é definido na instância de depuração.
Na segunda instância de Visual Studio, abra a solução AutoSizeButtonLibrary.
Abra Window1.xaml no WPF Designer.
A instância de depuração do Visual Studio obtém o foco e a execução para no ponto de interrupção no Register.
Pressione F5 para continuar a depuração.
A execução para no ponto de interrupção no construtor de AutoSizeButton.
Pressione F5 para continuar a depuração.
A segunda instância de Visual Studio obtém o foco e o WPF Designer aparece.
No modo Design, clique no controle AutoSizeButton para selecioná-lo.
A instância de depuração do Visual Studio obtém o foco e a execução para no ponto de interrupção no AutoSizeAdornerProvider.
Pressione F5 para continuar a depuração.
A execução para no ponto de interrupção no método Activate.
Pressione F5 para continuar a depuração.
A segunda instância de Visual Studio obtém o foco e o WPF Designer aparece.O adorner caixa de seleção aparece acima e à esquerda da AutoSizeButton.
Quando você terminar, você pode parar o sessão de depuração, fechando a segunda instância de Visual Studio ou, clicando em Parar Depuração Botão a instância de depuração.
Próximas etapas
Você pode adicionar mais recursos em tempo de design personalizados para os controles personalizados.
Adicione um adorner personalizado a tempo de design do seu controle.Para obter mais informações, consulte Demonstra Passo a passo: Criar um adorno de time de design.
Criar um editor de cores personalizado, que pode ser usado na Janela de Propriedades.Para obter mais informações, consulte Como: Criar um editor de valores.
Criar um editor de cores personalizado, que pode ser usado na Janela de Propriedades.Para obter mais informações, consulte Demonstra Passo a passo: Implementando um editor de cor.
Consulte também
Referência
PrimarySelectionAdornerProvider