快捷導(dǎo)航

WPF實現(xiàn)PropertyGrid功能

更新時間：2024年11月25日 09:08:09 作者：老碼識途呀

這篇文章主要為大家詳細介紹了在WPF中如何借助WinForm的PropertyGrid實現(xiàn)屬性列表功能,文中的示例代碼講解詳細,感興趣的小伙伴可以了解下

使用C#開發(fā)過Windows Forms的都知道，在Windows Forms程序中，有一個PropertyGrid控件，可以用于顯示對象的屬性，在WPF中并沒有默認提供此功能的控件，今天以一個簡單的小例子，簡述在WPF中借助WinForm的PropertyGrid實現(xiàn)屬性列表功能，僅供學(xué)習(xí)分享使用，如有不足之處，還請指正。

涉及知識點

PropertyGrid 是.NET中屬性瀏覽器的核心，PropertyGrid控件顯示任何對象或類型的屬性，并檢索項的屬性。PropertyGrid一般用在Windows Forms程序中，在WPF程序中，可以通過自定義控件實現(xiàn)，也可以借助WindowsFormsHost控件，將Windows Forms中的控件，宿主到WPF程序中。
WindowsFormsHost，一個WPF控件，允許允許在 WPF 程序上托管 Windows Forms控件。反過來，若要在 Windows 窗體控件或窗體中承載 WPF 元素，請使用控件 ElementHost 。

PropertyGrid簡介

PropertyGrid最常用屬性，如下所示：

SelectedObject，設(shè)置PropertyGrid控件選擇的對象，賦值后，控件將顯示對象所有public修飾的屬性。
SelectedObjects，設(shè)置PropertyGrid控件顯示的對象列表，為數(shù)組類型。賦值后，將顯示所有對象公共的public修飾的屬性。

除了上述兩個最常用屬性，PropertyGrid還有其他屬性，如下所示：

BackColor 更改其背景色。
HelpBackColor 更改助窗口背景色。
HelpForeColor 更改助窗口字體顏色。
HelpVisible 顯示隱藏幫助窗口。
ToolbarVisible 顯示隱藏工具欄。
LargeButtons 顯示大型工具欄按鈕。
PropertySort 按字母順序?qū)傩赃M行排序。
BackColor 更改拆分器顏色。
LineColor 更改網(wǎng)格線和邊框。

PropertyGrid支持的對象屬性注解，如下所示：

DescriptionAttribute - 設(shè)置屬性在屬性下方的說明幫助窗格中顯示的屬性的文本。這是為具有焦點的活動屬性提供幫助文本的有用方法。將此屬性應(yīng)用于 MaxRepeatRate 該屬性。
CategoryAttribute 設(shè)置屬性在網(wǎng)格中所屬的類別。當需要按類別名稱分組的屬性時，這非常有用。如果屬性未指定類別，則會將其分配給 Misc 類別。將此屬性應(yīng)用于所有屬性。
BrowsableAttribute – 指示屬性是否顯示在網(wǎng)格中。如果要從網(wǎng)格中隱藏屬性，這非常有用。默認情況下，公共屬性始終顯示在網(wǎng)格中。將此屬性應(yīng)用于 SettingsChanged 該屬性。
ReadOnlyAttribute – 指示屬性是否為只讀。如果要使屬性在網(wǎng)格中不可編輯，這非常有用。默認情況下，具有 get 和 set 訪問器函數(shù)的公共屬性在網(wǎng)格中可編輯。將此屬性應(yīng)用于 AppVersion 該屬性。
DefaultValueAttribute – 標識屬性的默認值。如果想要為屬性提供默認值，然后確定該屬性的值是否不同于默認值，則這非常有用。將此屬性應(yīng)用于所有屬性。
DefaultPropertyAttribute – 標識類的默認屬性。類的默認屬性在網(wǎng)格中選擇類時首先獲取焦點。將此屬性應(yīng)用于 AppSettings 類。
DisplayNameAttribute - 實際顯示的名稱

通過上述注解，可以顯示屬性在PropertyGrid中的說明或者其他內(nèi)容。

PropertyGrid控件目前支持.NET Framework和Windows Desktop版本，如下所示：

開發(fā)步驟

1. 檢查類庫

首先檢查項目中是否引用【Microsoft.WindowsDesktop.App】框架，在此框架中，會包含【System.Windows.Forms】,若沒有，需要手動添加，如下圖所示：

2. 引用命名空間

在項目中需要添加PropertyGrid的頁面，添加System.Windows.Forms命名空間，如下所示：

<Window x:Class="HelloWorld.MainWindow"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
        xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
        xmlns:local="clr-namespace:HelloWorld"
        xmlns:winfm="clr-namespace:System.Windows.Forms;assembly=System.Windows.Forms"
        mc:Ignorable="d"
        Title="MainWindow" Height="450" Width="800">
</Window>

3. 添加PropertyGrid控件

由于PropertyGrid是Winodws Forms中的控件，并不能在WPF中直接使用，需要托管到WindowsFormsHost中才能正確顯示，如下所示：

<Grid>
    <Grid.ColumnDefinitions>
        <ColumnDefinition></ColumnDefinition>
        <ColumnDefinition></ColumnDefinition>
    </Grid.ColumnDefinitions>
    <Button x:Name="btnHelloWorld" Content="Click Say Hello World"
            Width="150" Height="30" Click="btnHelloWorld_Click"></Button>
    <WindowsFormsHost Grid.Column="1" Margin="18,12,0,0" Name="windowsFormsHost1" VerticalAlignment="Top">
        <winfm:PropertyGrid x:Name="propertyGrid"></winfm:PropertyGrid>
    </WindowsFormsHost>
</Grid>

4. 設(shè)置對象

通過SelectedObject屬性為PropertyGrid賦值，由于PropertyGrid屬性并不是WPF中的依賴對象，所以不能進行綁定，但可以通過后臺C#代碼進行賦值。如下所示：

定義測試類Person

public class Person
{
    [Category("Person")]
    [DisplayName("標識")]
    [Description("唯一標識")]
    public int Id { get; set; }
 
    [Category("Person")]
    [DisplayName("名稱")]
    [Description("名稱")]
    public string Name { get; set; }
 
    [Category("Person")]
    public string Title { get; set; }
 
    [Category("Person")]
    public string Description { get; set; }
 
    [Category("Person")]
    public int Age { get; set; }
}

聲明Person對象并賦值給PropertyGrid，如下所示：

public MainWindow()
{
    InitializeComponent();
    var p = new Person
    {
        Id = 1,
        Name = "老碼識途",
        Age = 20,
        Description = "這是一個人",
        Title = "老碼識途作者"
        };
    this.propertyGrid.SelectedObject = p;
}