Пошаговое руководство. Сопоставление свойств с помощью элемента WindowsFormsHost

Статья
2025-05-07

В этом пошаговом руководстве показано, как использовать PropertyMap свойство для сопоставления свойств WPF с соответствующими свойствами в размещенном элементе управления Windows Forms.

Задачи, показанные в этом пошаговом руководстве, включают:

Создание проекта.
Определение макета приложения.
Определение нового сопоставления свойств.
Удаление сопоставления свойств по умолчанию.
Замена сопоставления свойств по умолчанию.
Расширение сопоставления свойств по умолчанию.

По завершении вы сможете сопоставить свойства WPF с соответствующими свойствами в размещенном элементе управления Windows Forms.

Предпосылки

Для выполнения этого пошагового руководства требуются следующие компоненты:

Visual Studio 2017

Создание и настройка проекта

Создайте проект приложения WPF с именем PropertyMappingWithWfhSample.
В обозревателе решений добавьте ссылку на сборку WindowsFormsIntegration, которая называется WindowsFormsIntegration.dll.
В обозревателе решений добавьте ссылки на сборки System.Drawing и System.Windows.Forms.

Определение макета приложения

Приложение на основе WPF использует WindowsFormsHost элемент для размещения элемента управления Windows Forms.

Определение макета приложения

Откройте Файл Window1.xaml в конструкторе WPF.

Замените существующий код следующим кодом.

<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>

Откройте Window1.xaml.cs в редакторе кода.

В верхней части файла импортируйте следующие пространства имен.

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

Определение нового сопоставления свойств

Элемент WindowsFormsHost предоставляет несколько сопоставлений свойств по умолчанию. Добавьте новое сопоставление свойства, вызвав метод Add у элемента WindowsFormsHost с PropertyMap.

Определение нового сопоставления свойств

Скопируйте следующий код в определение для класса 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

Метод AddClipMapping добавляет новое сопоставление для свойства Clip.

Метод OnClipChange переводит Clip свойство в свойство Windows FormsRegion.

Метод Window1_SizeChanged обрабатывает событие окна SizeChanged, корректируя размер области вырезки для соответствия окну приложения.

Удаление сопоставления свойств по умолчанию

Удалите сопоставление свойств по умолчанию, вызвав метод Remove для элемента WindowsFormsHost PropertyMap.

Удаление сопоставления свойств по умолчанию

Скопируйте следующий код в определение для класса 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

Метод RemoveCursorMapping удаляет сопоставление по умолчанию для свойства Cursor.

Замена сопоставления свойств по умолчанию

Замените сопоставление свойств по умолчанию, удалив сопоставление по умолчанию и вызвав метод Add на элементе WindowsFormsHost PropertyMap.

Замена сопоставления свойств по умолчанию

Скопируйте следующий код в определение для класса 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

Метод ReplaceFlowDirectionMapping заменяет сопоставление по умолчанию для FlowDirection свойства.

Метод OnFlowDirectionChange преобразует свойство FlowDirection в свойство Windows FormsRightToLeft.

Метод cb_CheckedChanged обрабатывает событие CheckedChanged на элементе управления CheckBox. Он назначает FlowDirection свойство на основе значения CheckState свойства.

Расширение сопоставления свойств по умолчанию

Вы можете использовать сопоставление свойств по умолчанию, а также расширить его с помощью собственного сопоставления.

Для расширения сопоставления свойств по умолчанию

Скопируйте следующий код в определение для класса 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

Метод ExtendBackgroundMapping добавляет переводчик настраиваемых свойств в существующее сопоставление свойств Background.

Метод OnBackgroundChange назначает определенное изображение свойству BackgroundImage размещенного элемента управления. Метод OnBackgroundChange вызывается после применения сопоставления свойств по умолчанию.

Инициализация сопоставлений свойств

Настройте сопоставления свойств, вызвав ранее описанные методы в обработчике Loaded событий.

Чтобы инициализировать сопоставления свойств

Скопируйте следующий код в определение для класса 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

Метод WindowLoaded обрабатывает событие Loaded и выполняет следующую инициализацию.

Создает элемент управления Windows FormsCheckBox .
Вызывает методы, определенные ранее в пошаговом руководстве, чтобы настроить сопоставления свойств.
Назначает начальные значения сопоставленным свойствам.

Нажмите клавишу F5, чтобы создать и запустить приложение. Установите флажок, чтобы увидеть эффект FlowDirection сопоставления. При нажатии флажка макет меняет ориентацию с лево-направо на право-налево.

Поделиться через

Пошаговое руководство. Сопоставление свойств с помощью элемента WindowsFormsHost

Предпосылки

Создание и настройка проекта

Определение макета приложения

Определение макета приложения

Определение нового сопоставления свойств

Определение нового сопоставления свойств

Удаление сопоставления свойств по умолчанию

Удаление сопоставления свойств по умолчанию

Замена сопоставления свойств по умолчанию

Замена сопоставления свойств по умолчанию

Расширение сопоставления свойств по умолчанию

Для расширения сопоставления свойств по умолчанию

Инициализация сопоставлений свойств

Чтобы инициализировать сопоставления свойств

См. также

Дополнительные ресурсы