WPF -- Xceed PropertyGrid应用详解

已于 2022-07-02 14:10:10 修改
阅读量3.9k 收藏 17
点赞数 6
分类专栏： WPF 文章标签： wpf .net PropertyGrid 自定义List显示 动态设置特性的值
于 2022-07-02 14:04:10 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/a549742320/article/details/125526194
版权

目录

1. Nuget安装

2. 调用

3. 常用属性

4. Model层设置

4.1 测试类

4.2  为对象添加相关特性

     4.2.1 添加描述特性

     4.2.2 添加分组

     4.2.3 添加属性是否显示标识

     4.2.4 添加类属性可展开特性

     4.2.5 添加类属性显示顺序

     4.2.6 对分组[Category]再进行排序

4.3 自定义List集合的显示

5. 代码动态获取/设置相关特性的值   

5.1  设置Browsable特性的值

5.2  设置Category特性的值

5.3  获取类的属性成员的Category特性的值

5.4  设置类的CategoryOrderAttribute特性的值

5.5  嵌套属性赋值

 6. 自定义Category样式

7. 自定义属性编辑模块

8. 最终效果图

1. Nuget安装

2. 调用

//xaml里 添加命名空间
xmlns:xctk="http://schemas.xceed.com/wpf/xaml/toolkit"



<Grid>
     <xctk:PropertyGrid  SelectedObject="{Binding PropeObject}" Name="PropertyGrid" 
SelectedPropertyItemChanged="PropertyGrid_SelectedPropertyItemChanged" Margin="10" ShowAdvancedOptions="True" ShowDescriptionByTooltip="True"  NameColumnWidth="270" 
FontSize="14"  ShowTitle="False" ShowSortOptions="False" ShowSearchBox="False" CategoryGroupHeaderTemplate="{StaticResource Category}">
    </xctk:PropertyGrid>
</Grid>

 SelectedPropertyItemChanged事件

private string _propname;

        public string PropName
        {
            get { return _propname; }
            set { _propname = value; }
        }

        private void PropertyGrid_SelectedPropertyItemChanged(object sender, RoutedPropertyChangedEventArgs<Xceed.Wpf.Toolkit.PropertyGrid.PropertyItemBase> e)
        {
            PropertyGrid propertyGrid = sender as PropertyGrid;
            //获取当前选择项的父类类型
            //需要做一次类型转换 否则获取不到相应属性
            PropertyItem item = propertyGrid.SelectedPropertyItem?.ParentElement as PropertyItem;
            PropName = item?.PropertyType.Name;
        }

3. 常用属性

IdPropertyDescription
1SelectedObjectGets or sets the current object the PropertyGrid is inspecting.
2IsReadOnlyGets or sets a value indicating whether the property grid is read-only.
3NameColumnWidthGets or sets the width of the property name column.
4ShowSearchBoxGets or sets a value indicating whether the search box is displayed. By default, true.
5ShowSortOptionsGets or sets a value indicating whether the show sort options are displayed (Categorized and Alphabetical). By default, true.
6ShowTitleGets or sets a value indicating whether the PropertyGrid's title is displayed.
7ShowDescriptionByTooltipGets or sets if the Description of the PropertyItem will be displayed as a tooltip on the PART_Name of the PropertyItem. When ShowDescriptionByTooltip is True and the DescriptionAttribute on the PropertyItem is not null and not empty, it will be displayed as a tooltip.

4. Model层设置

4.1 测试类

private TestPropertyGrid _pro;
        public TestPropertyGrid PropeObject
        {
            get => _pro;
            set => SetProperty(ref _pro, value);
        }



public class TestPropertyGrid
    {
        public int PropertyA { get; set; }
        public string PropertyB { get; set; }
        public TestA TestA { get; set; }
        public List<TestB> TestBList { get; set; }

    }

    public class TestA
    {
        public int Id { get; set; }
        public string Name { get; set; }
    }

    public class TestB
    {
        public int Id { get; set; }
        public string Address { get; set; }
    }

4.2  为对象添加相关特性

添加引用

using System.ComponentModel;
using Xceed.Wpf.Toolkit.PropertyGrid.Attributes;  

     4.2.1 添加描述特性

[Description("属性A")]
public int PropertyA { get; set; }

     4.2.2 添加分组

[Category("分组1")]
public int PropertyA { get; set; }

     4.2.3 添加属性是否显示标识


[Browsable(true)]
public int PropertyA { get; set; }

     4.2.4 添加类属性可展开特性

[ExpandableObject]
public class TestA
{
        
}

     4.2.5 添加类属性显示顺序

[PropertyOrder(2)]
public int Id { get; set; }
[PropertyOrder(1)]
public string Name { get; set; }

    4.2.6 对分组[Category]再进行排序

    说明：分组的优先级高于PropertyOrder，而分组是根据组名按拼音进行排序，部分情况需对其进行再排序

[CategoryOrder("分组1",2), CategoryOrder("分组2", 1)]
    public class TestPropertyGrid
    {
        [Category("分组1")]
        public int PropertyA { get; set; }
        [Category("分组2")]
        public string PropertyB { get; set; }
    }

4.3 自定义List集合的显示

  可展开的集合类

public class ExpandableObservableCollection<T> : ObservableCollection<T>,
                                                   ICustomTypeDescriptor
    {
        PropertyDescriptorCollection ICustomTypeDescriptor.GetProperties()
        {
            // Create a collection object to hold property descriptors
            PropertyDescriptorCollection pds = new PropertyDescriptorCollection(null);

            for (int i = 0; i < Count; i++)
            {
                pds.Add(new ItemPropertyDescriptor<T>(this, i));
            }

            return pds;
        }

        #region Use default TypeDescriptor stuff

        AttributeCollection ICustomTypeDescriptor.GetAttributes()
        {
            return TypeDescriptor.GetAttributes(this, noCustomTypeDesc: true);
        }

        string ICustomTypeDescriptor.GetClassName()
        {
            return TypeDescriptor.GetClassName(this, noCustomTypeDesc: true);
        }

        string ICustomTypeDescriptor.GetComponentName()
        {
            return TypeDescriptor.GetComponentName(this, noCustomTypeDesc: true);
        }

        TypeConverter ICustomTypeDescriptor.GetConverter()
        {
            return TypeDescriptor.GetConverter(this, noCustomTypeDesc: true);
        }

        EventDescriptor ICustomTypeDescriptor.GetDefaultEvent()
        {
            return TypeDescriptor.GetDefaultEvent(this, noCustomTypeDesc: true);
        }

        PropertyDescriptor ICustomTypeDescriptor.GetDefaultProperty()
        {
            return TypeDescriptor.GetDefaultProperty(this, noCustomTypeDesc: true);
        }

        object ICustomTypeDescriptor.GetEditor(Type editorBaseType)
        {
            return TypeDescriptor.GetEditor(this, editorBaseType, noCustomTypeDesc: true);
        }

        EventDescriptorCollection ICustomTypeDescriptor.GetEvents()
        {
            return TypeDescriptor.GetEvents(this, noCustomTypeDesc: true);
        }

        EventDescriptorCollection ICustomTypeDescriptor.GetEvents(Attribute[] attributes)
        {
            return TypeDescriptor.GetEvents(this, attributes, noCustomTypeDesc: true);
        }

        PropertyDescriptorCollection ICustomTypeDescriptor.GetProperties(Attribute[] attributes)
        {
            return TypeDescriptor.GetProperties(this, attributes, noCustomTypeDesc: true);
        }

        object ICustomTypeDescriptor.GetPropertyOwner(PropertyDescriptor pd)
        {
            return this;
        }

        #endregion
    }

    public class ItemPropertyDescriptor<T> : PropertyDescriptor
    {
        private readonly ObservableCollection<T> _owner;
        private readonly int _index;

        public ItemPropertyDescriptor(ObservableCollection<T> owner, int index)
          : base($"[{index}]" , null)
        {
            _owner = owner;
            _index = index;
        }

        public override AttributeCollection Attributes
        {
            get
            {
                var attributes = TypeDescriptor.GetAttributes(GetValue(null), false);


                if (!attributes.OfType<ExpandableObjectAttribute>().Any())
                {
                    // copy all the attributes plus an extra one (the
                    // ExpandableObjectAttribute)
                    // this ensures that even if the type of the object itself doesn't have the
                    // ExpandableObjectAttribute, it will still be expandable. 
                    var newAttributes = new Attribute[attributes.Count + 1];
                    attributes.CopyTo(newAttributes, 0);
                    newAttributes[newAttributes.Length - 1] = new ExpandableObjectAttribute();

                    // overwrite the original
                    attributes = new AttributeCollection(newAttributes);

                }

                return attributes;
            }
        }

        public override bool CanResetValue(object component)
        {
            return false;
        }

        public override object GetValue(object component)
        {
            return Value;
        }

        private T Value
          => _owner[_index];

        public override void ResetValue(object component)
        {
            throw new NotImplementedException();
        }

        public override void SetValue(object component, object value)
        {
            _owner[_index] = (T)value;
        }

        public override bool ShouldSerializeValue(object component)
        {
            return false;
        }

        public override Type ComponentType
          => _owner.GetType();

        public override bool IsReadOnly
          => false;

        public override Type PropertyType
          => Value?.GetType();
    }

 调用：List类型改为ExpandableObservableCollection，再添加可展开特性

[ExpandableObject]
public ExpandableObservableCollection<TestB> TestBList { get; set; }

效果：

5. 代码动态获取/设置相关特性的值   

5.1 设置Browsable特性的值

public void SetPropertyVisibility(object obj, string propertyName, bool visible)
        {
            Type type = typeof(BrowsableAttribute);
            PropertyDescriptorCollection props = TypeDescriptor.GetProperties(obj);
            AttributeCollection attrs = props[propertyName].Attributes;
            FieldInfo fld = type.GetField("browsable", BindingFlags.Instance | BindingFlags.NonPublic);
            fld?.SetValue(attrs[type], visible);
        }

5.2 设置Category特性的值

public void SetCategoryValue(object obj, string propertyName，string str)
        {
            Type type = typeof(CategoryAttribute);
            PropertyDescriptorCollection props = TypeDescriptor.GetProperties(obj);
            AttributeCollection attrs = props[propertyName].Attributes;
            FieldInfo fld = type.GetField("categoryValue", BindingFlags.Instance | BindingFlags.NonPublic);
            fld?.SetValue(attrs[type], str);
        }

5.3  获取类的属性成员的Category特性的值

public string GetCategoryValue(object obj, string propertyName)
        {
            Type type = typeof(CategoryAttribute);
            PropertyDescriptorCollection props = TypeDescriptor.GetProperties(obj); 
            AttributeCollection attrs = props[propertyName].Attributes;
            FieldInfo fld = type.GetField("categoryValue", BindingFlags.Instance | BindingFlags.NonPublic);
            var str = fld.GetValue(attrs[type])?.ToString();
            return str;

        }

5.4 设置类的CategoryOrderAttribute特性的值

public void SetCategoryOrderValue(object obj,CategoryOrderAttribute[] categoryOrders)
        {
            TypeDescriptor.AddAttributes(obj.GetType(), categoryOrders);

        }

5.5  嵌套属性赋值

/// <summary>
        /// 使用反射设置嵌套属性的值
        /// </summary>
        /// <param name="obj">对象 </param>
        /// <param name="propename">第一层属性</param>
        /// <param name="targetname">目标属性（是第一层属性的成员）</param>
        /// <param name="val">赋的值</param>
        private void NestPropeSetValue(object obj, string propename, string targetname, object val)
        {
            PropertyInfo[] propertyInfos = obj.GetType().GetProperties();
            var prope = propertyInfos.Single(x => propename == x.PropertyType.Name);
            var value = prope.GetValue(obj, null);
            var pr = value.GetType().GetProperties().Single(x => x.Name == targetname);
            pr?.SetValue(value, val);

        }

 6. 自定义Category样式

<UserControl.Resources>
        <DataTemplate x:Key="Category">
            <TextBlock Text="{Binding}" FontSize="20" Foreground="#4EB9E4" />
        </DataTemplate>
</UserControl.Resources>

<!--调用：-->
CategoryGroupHeaderTemplate="{StaticResource Category}"

7. 自定义属性编辑模块

<xctk:PropertyGrid  SelectedObject="{Binding PropeObject}" >
            <xctk:PropertyGrid.EditorDefinitions>
               <!--EditorTemplateDefinition可添加多个-->                                     
                                                       <!--要修改编辑模板的属性的名称-->
                <xctk:EditorTemplateDefinition TargetProperties="PropertyA,PropertyB">
                    <xctk:EditorTemplateDefinition.EditingTemplate>
                        <DataTemplate>
                            <!--此处可自由发挥-->
                            <Grid>
                                <!-- Command生效：  DataTemplate的DataContext指代不明确，需要改为父类的DataContext。   参数Value表示原对象-->
                                <ToggleButton Command="{Binding Path=DataContext.PropeSetCommand ,RelativeSource={RelativeSource Mode=FindAncestor,AncestorType=xctk:PropertyGrid}}"
                                              CommandParameter="{Binding Value,Mode=TwoWay,UpdateSourceTrigger=PropertyChanged}" Height="25"  Content="点击"  Width="300" HorizontalAlignment="Left"></ToggleButton>
                            </Grid>
                        </DataTemplate>
                    </xctk:EditorTemplateDefinition.EditingTemplate>
                </xctk:EditorTemplateDefinition>
            </xctk:PropertyGrid.EditorDefinitions>
        </xctk:PropertyGrid>

 ToggleButton样式

<UserControl.Resources>
        <Style TargetType="{x:Type ToggleButton}" >
            <Setter Property="Foreground" Value="White"/>
            <Setter Property="FontFamily" Value="Microsoft YaHei"/>
            <Setter Property="FontSize" Value="12"/>
            <Setter Property="FontWeight" Value="Bold"/>
            <Setter Property="Template">
                <Setter.Value>
                    <ControlTemplate TargetType="ToggleButton">
                        <Border BorderBrush="{TemplateBinding Control.BorderBrush}" BorderThickness="0" CornerRadius="2">
                            <Border.Background>
                                <LinearGradientBrush EndPoint="0,1" StartPoint="0,0">
                                    <GradientStop Color="#FF71E0C6" Offset="0.0" />
                                    <GradientStop Color="#FF43A88D" Offset="0.2" />
                                    <GradientStop Color="#FF5BB07D" Offset="0.0" />
                                </LinearGradientBrush>
                            </Border.Background>
                            <ContentPresenter Content="{TemplateBinding ContentControl.Content}" HorizontalAlignment="Center" VerticalAlignment="Center" ></ContentPresenter>
                        </Border>
                        <ControlTemplate.Triggers>

                            <Trigger Property="ButtonBase.IsPressed" Value="True">
                                <Setter Property="UIElement.Effect">
                                    <Setter.Value>
                                        <DropShadowEffect BlurRadius="10" Color="#276AB0" Direction="0" Opacity="0.9" RenderingBias="Performance" ShadowDepth="0" />
                                    </Setter.Value>
                                </Setter>
                                <Setter Property="RenderTransform">
                                    <Setter.Value>
                                        <ScaleTransform ScaleX="0.9" ScaleY="0.9" />
                                    </Setter.Value>
                                </Setter>
                                <Setter Property="RenderTransformOrigin" Value=".5,.5" />
                            </Trigger>
                        </ControlTemplate.Triggers>
                    </ControlTemplate>

                </Setter.Value>
            </Setter>
        </Style>
    </UserControl.Resources>

8. 最终效果图

参考：

【1】 PropertyGrid · xceedsoftware/wpftoolkit Wiki · GitHub

【2】 c# - Category Ordering In Xceed PropertyGrid - Stack Overflow

【3】 Xceed WPF PropertyGrid Show项目用于扩展收集 - IT宝库 (itbaoku.cn)

哈丨吅
关注
  • 6
    点赞
  • 踩
  • 17
    收藏
    觉得还不错? 一键收藏
  • 4
    评论
专栏目录
wpf devexpress Property Grid创建属性定义
赫的BLOG
11-17 809
打开工具箱在vs，定位到DX.23.1: Data 面板，选择PropertyGridControl工具箱选项，拖动到窗口。使用property grid PropertyGridControl.SelectedObject 属性绑定数据。本教程示范如何绑定WP Property Grid控件到数据和创建属性定义。WPF Property Grid控件使用属性定义定义如何做和显示。第三步-绑定Property Grid到Data Object。第一步-创建属性定义。步骤四-创建属性定义。
wpf-propertygrid:重新打包Workflow Foundation的属性网格以供WPF应用程序通用
05-09
"wpf-propertygrid:重新打包Workflow Foundation的属性网格以供WPF应用程序通用"这个项目，就是将WF中的属性网格控件进行了适配和改造，使其能在WPF环境中无缝使用。 属性网格（PropertyGrid）是一个强大的UI组件，...
PropertyGrid显示嵌套对象
路过
05-19 336
在C#中，使用来显示多重变量，通常意味着你想要展示一个对象的属性，该对象包含子对象或者集合。以下是一个简单的例子，展示如何使用来显示包含嵌套属性的对象。
WPF PropertyGrid
11-01
国外的一个WPF环境下开源PropertyGrid,效果不错
WPF hc:PropertyGrid 嵌套显示
最新发布
qq_59062726的博客
05-22 314
PropertyGrid嵌套显示，模仿Winform。
wpf的低调自定义属性面板PropertyGrid
u014090257的博客
08-25 3451
wpf的低调自定义属性面板PropertyGrid 引用：https://www.cnblogs.com/lsgsanxiao/p/11776421.html 当没有轮子的时候，就自己制作轮子。 前言 项目上的需求，我想需要用到这样一个跟vs属性编辑一样的东西,专业叫法，属性面板 怎么弄呢？ 百度一下，wpf的PropertyGrid，如下： WPF中实现PropertyGrid的三种方式 群上问wpf跟vs属性编辑类似的东西有人弄过吗 开始 为了要体现我的卑微，这里要做一下说明
界面控件DevExpress WPF属性网格 - 让应用轻松显示编辑各种属性事件
需要界面开发、IDE工具研发中文教程资料的小伙伴，记得私信我~
01-15 704
本文主要为大家介绍界面控件DevExpress WPF的Property Grid（属性网格）组件，欢迎下载最新版体验~
通用WPF主题控件包rubyer-wpf-master
12-20
通用WPF主题控件包rubyer-wpf-master是一款专为Windows Presentation Foundation (WPF) 应用程序设计的开源UI框架。它提供了丰富的主题和控件，旨在帮助开发者快速构建美观且用户友好的应用程序界面。在2.0.0版本中...
WPF-Blockly-master.zip
12-14
**WPF-Blockly** 是一个基于Windows Presentation Foundation (WPF) 的图形化编程工具，它为用户提供了构建和设计程序的直观界面。WPF作为Microsoft .NET Framework的一部分，主要用于构建桌面应用程序，它提供了...
bootstrap-wpf-style-master 样式
08-14
Bootstrap-WPF 样式是一种将流行的前端框架 Bootstrap 的设计风格应用于 WPF（Windows Presentation Foundation）应用程序的方法。Bootstrap 是一个广泛使用的开源工具包，主要用于构建响应式、移动设备优先的网页...
WPF-UI
03-05
**WPF现代UI技术详解** Windows Presentation Foundation (WPF) 是微软.NET Framework的一部分，它为开发者提供...在WPF-UI项目中，你可能找到了关于WPF UI设计的实例和代码示例，这对于学习和实践WPF技术非常有帮助。
wpf PropertyGrid 显示List＜string,class＞
qq_35320456的博客
12-23 536
在这个示例中，我们定义了两个自定义的PropertyDescriptor分别用于表示List<string>和List<MyClass>类型的属性。PropertyGrid默认情况下可以显示和修改List<string>类型的属性，但不支持List<class>类型。不过你可以通过自定义TypeConverter来扩展PropertyGrid的功能，使其支持显示和修改List<class>类型的属性。方法，以便能够获取MyClass类型的属性。
WPF中实现PropertyGrid(用于展示对象的详细信息)的三种方式
wushang923的专栏
03-14 6223
由于WPF中没有提供PropertyGrid控件，有些业务需要此类的控件。这篇文章介绍在WPF中实现PropertyGrid的三种方式，三种方式都是俺平时使用时总结出来的。 第一种方式：使用WindowsForm的PropertyGrid控件。 用过WPF的童鞋都晓得，可以通过WindowsFormsHost将WindowsForm的控件宿主到WPF中使用。很简单，分为简单的3步。 第一步：引用
Xceed Toolkit Plus for WPF
q2315702359的博客
05-19 1016
Xceed Toolkit Plus for WPF 　　Xceed Toolkit Plus for WPF 提供了每个 WPF 开发人员在构建应用程序 UI 过程中所需的基本控件、面板和主题。这些主题不仅适用于工具包的控件，还适用于所有基本 WPF 控件。 　　Xceed Toolkit Plus for WPF 功能 　　主要包含的控件 　　AutoSelectTextBox：控件接收到焦点时选择谁的内容;当插入符号到达文本范围的末端时，还会执行自动焦点导航。 　　BusyIndi​​cat
c# PropertyGrid 自定义属性排序
chulijun3107的博客
11-25 4310
PropertyGrid属性如果不自定义顺序的话，属性会按照字母顺序排序。实际中这并不是想要的结果。可以通过增加一个PropertyOrder的方法，自定义属性的属性。这样就可以根据自己的意愿进行排序了。我先上一个Winform版本的PropertyGrid。过几天再上一个WPF版本的PropertyGrid排序。Wpf版本的排序将采用开源控件库HandyControl作为基础。它可以带来更好的展示。话不多说，先看下排序前后的效果： 还是排序后的效果看着舒服。 工程如下： 源码非常的...
wpf -- xceed propertygrid demo 源码
09-29
Xceed PropertyGrid控件是一个用于展示和编辑属性的WPF控件。Demo源码是提供给开发人员学习和使用该控件的示例代码。 Demo源码中包含了一些基本的用法和示例，帮助开发人员理解如何在自己的应用程序中使用Property...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 4
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值