Instruções passo a passo: mapeando propriedades usando o elemento WindowsFormsHost

Artigo
10/18/2023

Este passo a passo mostra como usar a PropertyMap propriedade para mapear propriedades WPF para propriedades correspondentes em um controle Windows Forms hospedado.

As tarefas ilustradas neste passo a passo incluem:

Criação do projeto.
Definir o layout do aplicativo.
Definir um novo mapeamento de propriedade.
Remover um mapeamento de propriedade padrão.
Substituir um mapeamento de propriedade padrão.
Estender um mapeamento de propriedade padrão.

Quando terminar, você poderá mapear propriedades WPF para propriedades correspondentes em um controle hospedado do Windows Forms.

Pré-requisitos

Você precisará dos seguintes componentes para concluir este passo a passo:

Visual Studio 2017

Criar e configurar o projeto

Crie um projeto de aplicativo WPF chamado PropertyMappingWithWfhSample.
No Gerenciador de Soluções, adicione uma referência ao assembly WindowsFormsIntegration, chamado WindowsFormsIntegration.dll.
No Gerenciador de Soluções, adicione referências aos assemblies System.Drawing e System.Windows.Forms.

Definindo o layout do aplicativo

O aplicativo baseado em WPF usa o WindowsFormsHost elemento para hospedar um controle do Windows Forms.

Definir o layout do aplicativo

Abra Window1.xaml no WPF Designer.

Substitua o código existente pelo código a seguir.

<Window x:Class="PropertyMappingWithWfh.Window1"
    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
    Title="PropertyMappingWithWfh" Height="300" Width="300"
    Loaded="WindowLoaded">
  <DockPanel Name="panel1" LastChildFill="True">
    <WindowsFormsHost Name="wfHost" DockPanel.Dock="Left" SizeChanged="Window1_SizeChanged" FontSize="20" />
  </DockPanel>
</Window>

Abra Window1.xaml.cs no Editor de Código.

Na parte superior do arquivo, importe os seguintes namespaces.

using System.Drawing;
using System.Drawing.Drawing2D;
using System.Windows.Forms;
using System.Windows.Forms.Integration;

Imports System.Drawing
Imports System.Drawing.Drawing2D
Imports System.Windows.Forms
Imports System.Windows.Forms.Integration

Definindo um novo mapeamento de propriedade

O WindowsFormsHost elemento fornece vários mapeamentos de propriedade padrão. Você adiciona um novo mapeamento de propriedade chamando o Add método no WindowsFormsHost elemento PropertyMap.

Definir um novo mapeamento de propriedade

Copie o código a seguir para a definição da classe Window1.

// The AddClipMapping method adds a custom
// mapping for the Clip property.
private void AddClipMapping()
{
    wfHost.PropertyMap.Add(
        "Clip",
        new PropertyTranslator(OnClipChange));
}

// The OnClipChange method assigns an elliptical clipping
// region to the hosted control's Region property.
private void OnClipChange(object h, String propertyName, object value)
{
    WindowsFormsHost host = h as WindowsFormsHost;
    System.Windows.Forms.CheckBox cb = host.Child as System.Windows.Forms.CheckBox;

    if (cb != null)
    {
        cb.Region = this.CreateClipRegion();
    }
}

// The Window1_SizeChanged method handles the window's
// SizeChanged event. It calls the OnClipChange method explicitly
// to assign a new clipping region to the hosted control.
private void Window1_SizeChanged(object sender, SizeChangedEventArgs e)
{
    this.OnClipChange(wfHost, "Clip", null);
}

// The CreateClipRegion method creates a Region from an
// elliptical GraphicsPath.
private Region CreateClipRegion()
{
    GraphicsPath path = new GraphicsPath();

    path.StartFigure();

    path.AddEllipse(new System.Drawing.Rectangle(
        0,
        0,
        (int)wfHost.ActualWidth,
        (int)wfHost.ActualHeight ) );

    path.CloseFigure();

    return( new Region(path) );
}

' The AddClipMapping method adds a custom mapping 
' for the Clip property.
Private Sub AddClipMapping()

    wfHost.PropertyMap.Add( _
        "Clip", _
        New PropertyTranslator(AddressOf OnClipChange))

End Sub

' The OnClipChange method assigns an elliptical clipping 
' region to the hosted control's Region property.
Private Sub OnClipChange( _
ByVal h As Object, _
ByVal propertyName As String, _
ByVal value As Object)

    Dim host As WindowsFormsHost = h

    Dim cb As System.Windows.Forms.CheckBox = host.Child

    If cb IsNot Nothing Then
        cb.Region = Me.CreateClipRegion()
    End If

End Sub

' The Window1_SizeChanged method handles the window's 
' SizeChanged event. It calls the OnClipChange method explicitly 
' to assign a new clipping region to the hosted control.
Private Sub Window1_SizeChanged( _
ByVal sender As Object, _
ByVal e As SizeChangedEventArgs)

    Me.OnClipChange(wfHost, "Clip", Nothing)

End Sub

' The CreateClipRegion method creates a Region from an
' elliptical GraphicsPath.
Private Function CreateClipRegion() As [Region] 
    Dim path As New GraphicsPath()
    
    path.StartFigure()
    
    path.AddEllipse(New System.Drawing.Rectangle( _
        0, _
        0, _
        wfHost.ActualWidth, _
        wfHost.ActualHeight))
    
    path.CloseFigure()
    
    Return New [Region](path)

End Function

O AddClipMapping método adiciona um novo mapeamento para a Clip propriedade.

O OnClipChange método converte a propriedade para a Clip propriedade Windows FormsRegion .

O Window1_SizeChanged método manipula o evento da SizeChanged janela e dimensiona a região de recorte para se ajustar à janela do aplicativo.

Removendo um mapeamento de propriedade padrão

Remova um mapeamento de propriedade padrão chamando o Remove método no WindowsFormsHost .PropertyMap

Remover um mapeamento de propriedade padrão

Copie o código a seguir para a definição da classe Window1.

// The RemoveCursorMapping method deletes the default
// mapping for the Cursor property.
private void RemoveCursorMapping()
{
    wfHost.PropertyMap.Remove("Cursor");
}

' The RemoveCursorMapping method deletes the default
' mapping for the Cursor property.
Private Sub RemoveCursorMapping()
    wfHost.PropertyMap.Remove("Cursor")
End Sub

O RemoveCursorMapping método exclui o mapeamento padrão para a Cursor propriedade.

Substituindo um mapeamento de propriedade padrão

Substitua um mapeamento de propriedade padrão removendo o mapeamento padrão e chamando o Add método no WindowsFormsHost .PropertyMap

Substituir um mapeamento de propriedade padrão

Copie o código a seguir para a definição da classe Window1.

// The ReplaceFlowDirectionMapping method replaces the
// default mapping for the FlowDirection property.
private void ReplaceFlowDirectionMapping()
{
    wfHost.PropertyMap.Remove("FlowDirection");

    wfHost.PropertyMap.Add(
        "FlowDirection",
        new PropertyTranslator(OnFlowDirectionChange));
}

// The OnFlowDirectionChange method translates a
// Windows Presentation Foundation FlowDirection value
// to a Windows Forms RightToLeft value and assigns
// the result to the hosted control's RightToLeft property.
private void OnFlowDirectionChange(object h, String propertyName, object value)
{
    WindowsFormsHost host = h as WindowsFormsHost;
    System.Windows.FlowDirection fd = (System.Windows.FlowDirection)value;
    System.Windows.Forms.CheckBox cb = host.Child as System.Windows.Forms.CheckBox;

    cb.RightToLeft = (fd == System.Windows.FlowDirection.RightToLeft ) ?
        RightToLeft.Yes : RightToLeft.No;
}

// The cb_CheckedChanged method handles the hosted control's
// CheckedChanged event. If the Checked property is true,
// the flow direction is set to RightToLeft, otherwise it is
// set to LeftToRight.
private void cb_CheckedChanged(object sender, EventArgs e)
{
    System.Windows.Forms.CheckBox cb = sender as System.Windows.Forms.CheckBox;

    wfHost.FlowDirection = ( cb.CheckState == CheckState.Checked ) ?
            System.Windows.FlowDirection.RightToLeft :
            System.Windows.FlowDirection.LeftToRight;
}

' The ReplaceFlowDirectionMapping method replaces the
' default mapping for the FlowDirection property.
Private Sub ReplaceFlowDirectionMapping()

    wfHost.PropertyMap.Remove("FlowDirection")

    wfHost.PropertyMap.Add( _
        "FlowDirection", _
        New PropertyTranslator(AddressOf OnFlowDirectionChange))
End Sub


' The OnFlowDirectionChange method translates a 
' Windows Presentation Foundation FlowDirection value 
' to a Windows Forms RightToLeft value and assigns
' the result to the hosted control's RightToLeft property.
Private Sub OnFlowDirectionChange( _
ByVal h As Object, _
ByVal propertyName As String, _
ByVal value As Object)

    Dim host As WindowsFormsHost = h

    Dim fd As System.Windows.FlowDirection = _
        CType(value, System.Windows.FlowDirection)

    Dim cb As System.Windows.Forms.CheckBox = host.Child

    cb.RightToLeft = IIf(fd = System.Windows.FlowDirection.RightToLeft, _
        RightToLeft.Yes, _
        RightToLeft.No)

End Sub


' The cb_CheckedChanged method handles the hosted control's
' CheckedChanged event. If the Checked property is true,
' the flow direction is set to RightToLeft, otherwise it is
' set to LeftToRight.
Private Sub cb_CheckedChanged( _
ByVal sender As Object, _
ByVal e As EventArgs)

    Dim cb As System.Windows.Forms.CheckBox = sender

    wfHost.FlowDirection = IIf(cb.CheckState = CheckState.Checked, _
    System.Windows.FlowDirection.RightToLeft, _
    System.Windows.FlowDirection.LeftToRight)

End Sub

O ReplaceFlowDirectionMapping método substitui o mapeamento padrão para a FlowDirection propriedade.

O OnFlowDirectionChange método converte a propriedade para a FlowDirection propriedade Windows FormsRightToLeft .

O cb_CheckedChanged método manipula o CheckedChanged evento no CheckBox controle. Ele atribui a FlowDirection propriedade com base no valor da CheckState propriedade

Estendendo um mapeamento de propriedade padrão

Você pode usar um mapeamento de propriedade padrão e também estendê-lo com seu próprio mapeamento.

Estender um mapeamento de propriedade padrão

Copie o código a seguir para a definição da classe Window1.

// The ExtendBackgroundMapping method adds a property
// translator if a mapping already exists.
private void ExtendBackgroundMapping()
{
    if (wfHost.PropertyMap["Background"] != null)
    {
        wfHost.PropertyMap["Background"] += new PropertyTranslator(OnBackgroundChange);
    }
}

// The OnBackgroundChange method assigns a specific image
// to the hosted control's BackgroundImage property.
private void OnBackgroundChange(object h, String propertyName, object value)
{
    WindowsFormsHost host = h as WindowsFormsHost;
    System.Windows.Forms.CheckBox cb = host.Child as System.Windows.Forms.CheckBox;
    ImageBrush b = value as ImageBrush;

    if (b != null)
    {
        cb.BackgroundImage = new System.Drawing.Bitmap(@"C:\WINDOWS\Santa Fe Stucco.bmp");
    }
}

' The ExtendBackgroundMapping method adds a property
' translator if a mapping already exists.
Private Sub ExtendBackgroundMapping() 
    If wfHost.PropertyMap("Background") IsNot Nothing Then

        wfHost.PropertyMap("Background") = PropertyTranslator.Combine( _
        wfHost.PropertyMap("Background"), _
        PropertyTranslator.CreateDelegate( _
            GetType(PropertyTranslator), _
            Me, _
            "OnBackgroundChange"))
    End If

End Sub


' The OnBackgroundChange method assigns a specific image 
' to the hosted control's BackgroundImage property.
Private Sub OnBackgroundChange(ByVal h As Object, ByVal propertyName As String, ByVal value As Object) 
    Dim host As WindowsFormsHost = h 
    Dim cb As System.Windows.Forms.CheckBox = host.Child 
    Dim b As ImageBrush = value 
    
    If Not (b Is Nothing) Then
        cb.BackgroundImage = New System.Drawing.Bitmap("C:\WINDOWS\Santa Fe Stucco.bmp")
    End If

End Sub

O ExtendBackgroundMapping método adiciona um conversor de propriedade personalizada ao mapeamento de propriedade existente Background .

O OnBackgroundChange método atribui uma imagem específica à propriedade do BackgroundImage controle hospedado. O método OnBackgroundChange é chamado depois que o mapeamento de propriedade padrão é aplicado.

Inicializando seus mapeamentos de propriedades

Configure seus mapeamentos de propriedade chamando os métodos descritos anteriormente no Loaded manipulador de eventos.

Inicializar seus mapeamentos de propriedades

Copie o código a seguir para a definição da classe Window1.

// The WindowLoaded method handles the Loaded event.
// It enables Windows Forms visual styles, creates
// a Windows Forms checkbox control, and assigns the
// control as the child of the WindowsFormsHost element.
// This method also modifies property mappings on the
// WindowsFormsHost element.
private void WindowLoaded(object sender, RoutedEventArgs e)
{
    System.Windows.Forms.Application.EnableVisualStyles();

    // Create a Windows Forms checkbox control and assign
    // it as the WindowsFormsHost element's child.
    System.Windows.Forms.CheckBox cb = new System.Windows.Forms.CheckBox();
    cb.Text = "Windows Forms checkbox";
    cb.Dock = DockStyle.Fill;
    cb.TextAlign = ContentAlignment.MiddleCenter;
    cb.CheckedChanged += new EventHandler(cb_CheckedChanged);
    wfHost.Child = cb;

    // Replace the default mapping for the FlowDirection property.
    this.ReplaceFlowDirectionMapping();

    // Remove the mapping for the Cursor property.
    this.RemoveCursorMapping();

    // Add the mapping for the Clip property.
    this.AddClipMapping();

    // Add another mapping for the Background property.
    this.ExtendBackgroundMapping();

    // Cause the OnFlowDirectionChange delegate to be called.
    wfHost.FlowDirection = System.Windows.FlowDirection.LeftToRight;

    // Cause the OnClipChange delegate to be called.
    wfHost.Clip = new RectangleGeometry();

    // Cause the OnBackgroundChange delegate to be called.
    wfHost.Background = new ImageBrush();
}

' The WindowLoaded method handles the Loaded event.
' It enables Windows Forms visual styles, creates 
' a Windows Forms checkbox control, and assigns the
' control as the child of the WindowsFormsHost element. 
' This method also modifies property mappings on the 
' WindowsFormsHost element.
Private Sub WindowLoaded( _
ByVal sender As Object, _
ByVal e As RoutedEventArgs)

    System.Windows.Forms.Application.EnableVisualStyles()

    ' Create a Windows Forms checkbox control and assign 
    ' it as the WindowsFormsHost element's child.
    Dim cb As New System.Windows.Forms.CheckBox()
    cb.Text = "Windows Forms checkbox"
    cb.Dock = DockStyle.Fill
    cb.TextAlign = ContentAlignment.MiddleCenter
    AddHandler cb.CheckedChanged, AddressOf cb_CheckedChanged
    wfHost.Child = cb

    ' Replace the default mapping for the FlowDirection property.
    Me.ReplaceFlowDirectionMapping()

    ' Remove the mapping for the Cursor property.
    Me.RemoveCursorMapping()

    ' Add the mapping for the Clip property.
    Me.AddClipMapping()

    ' Add another mapping for the Background property.
    Me.ExtendBackgroundMapping()

    ' Cause the OnFlowDirectionChange delegate to be called.
    wfHost.FlowDirection = System.Windows.FlowDirection.LeftToRight

    ' Cause the OnClipChange delegate to be called.
    wfHost.Clip = New RectangleGeometry()

    ' Cause the OnBackgroundChange delegate to be called.
    wfHost.Background = New ImageBrush()

End Sub

O WindowLoaded método manipula o Loaded evento e executa a inicialização a seguir.

Cria um controle Windows FormsCheckBox .
Chama os métodos definidos anteriormente no passo a passo para configurar os mapeamentos de propriedade.
Atribui valores iniciais para as propriedades mapeadas.

Pressione F5 para compilar e executar o aplicativo. Clique na caixa de seleção para ver o FlowDirection efeito do mapeamento. Ao clicar na caixa de seleção, o layout inverte sua orientação esquerda-direita.

Compartilhar via

Instruções passo a passo: mapeando propriedades usando o elemento WindowsFormsHost

Pré-requisitos

Criar e configurar o projeto

Definindo o layout do aplicativo

Definir o layout do aplicativo

Definindo um novo mapeamento de propriedade

Definir um novo mapeamento de propriedade

Removendo um mapeamento de propriedade padrão

Remover um mapeamento de propriedade padrão

Substituindo um mapeamento de propriedade padrão

Substituir um mapeamento de propriedade padrão

Estendendo um mapeamento de propriedade padrão

Estender um mapeamento de propriedade padrão

Inicializando seus mapeamentos de propriedades

Inicializar seus mapeamentos de propriedades

Confira também

Recursos adicionais