wpf控件设计时支持

Posted 2021-01-18 lonelyxmas

原文:wpf控件设计时支持(2)

这篇介绍在wpf设计时集合项属性添加项的定义和自定义控件右键菜单的方法

集合项属性设计时支持

 

1.为集合属性设计器识别具体项类型

wpf设计器允许定义集合项的类型,如新发布的WPF的DataGrid控件,其中的Columns包括一下几种类型,Columns集合属性是以下几个类型的抽象类集合.要在设计器识别以下类型，就必须用到wpf设计时的扩展功能

 

实现这个功能很简单，只需要给该集合属性附上NewItemTypesAttribute元数据就好了.如下代码

NewItemTypesAttribute attr = new NewItemTypesAttribute(
                                    typeof(DataGridTextColumn),
                                    typeof(DataGridCheckBoxColumn),
                                    typeof(DataGridHyperlinkColumn),
                                    typeof(DataGridComboBoxColumn),
                                    typeof(DataGridTemplateColumn));
builder.AddCustomAttributes("Columns", attr);

这里通过把元数据添加到元数据存储区的方式来实现,当然你也可以直接在属性上挂元数据，两种方法都可以，具体可以看第一篇的介绍.

2.格式化集合项属性

如上图,每个类型都配有不同的图标,这一功能需要NewItemFactory 来完成,称之为创建项的工厂,我理解为是格式化项.

NewItemFactory是一个抽象类,有三个虚方法

CreateInstance方法会在创建新实例时对该对象做一些业务逻辑的变更

GetDisplayName方法则获取显示的名称,如下图的DataGridTextColumn

GetImage方法则是获取显示的对象图标了，如下图左侧图标.

可以根据需要重写这三个方法.我们来看下DataGridColumnFactory是如何实现的.

internal class DataGridColumnFactory : NewItemFactory 
{
    public override object CreateInstance(Type type) 
    {
        DataGridColumn gridColumn = null;

        if (type.IsAssignableFrom(typeof(DataGridTemplateColumn)))
        { 
            gridColumn = CreateTemplateColumn();
        } 
        else 
        {
            gridColumn = Activator.CreateInstance(type) as DataGridColumn;
        }

        if (gridColumn != null) 
        {
            gridColumn.Header = "Header";
        }

        return gridColumn;
    }

    /// <summary>
    ///     Create a Template column with a default cell and editing template 
    /// </summary>
    private static DataGridTemplateColumn CreateTemplateColumn() 
    {
        DataGridTemplateColumn gridColumn = new DataGridTemplateColumn();
        gridColumn.CellTemplate = new DataTemplate();
        gridColumn.CellEditingTemplate = new DataTemplate();

        return gridColumn;
    }

    public override object GetImage(Type type, Size desiredSize) 
    {
        object image = base.GetImage(type, desiredSize);
        if (typeof(DataGridTextColumn).IsAssignableFrom(type)) 
        { 
            image = Util.GetImage("DataGridTextColumn.png", desiredSize);
        } 
        else if (typeof(DataGridHyperlinkColumn).IsAssignableFrom(type)) 
        {
            image = Util.GetImage("DataGridHyperlinkColumn.png", desiredSize);
        } 
        else if (typeof(DataGridComboBoxColumn).IsAssignableFrom(type)) 
        {
            image = Util.GetImage("DataGridComboBoxColumn.png", desiredSize);
        } 
        else if (typeof(DataGridCheckBoxColumn).IsAssignableFrom(type)) 
        {
            image = Util.GetImage("DataGridCheckBoxColumn.png", desiredSize);
        } 
        else if (typeof(DataGridTemplateColumn).IsAssignableFrom(type)) 
        {
            image = Util.GetImage("DataGridTemplateColumn.png", desiredSize);
        }

        return image;
    }
}

以上代码应该很容易理解.定义好这个工厂类以后则需要用NewItemTypesAttribute中的FactoryType属性指定这个类型.现在刚开始的代码变更如下

NewItemTypesAttribute attr = new NewItemTypesAttribute(
                                    typeof(DataGridTextColumn),
                                    typeof(DataGridCheckBoxColumn),
                                    typeof(DataGridHyperlinkColumn),
                                    typeof(DataGridComboBoxColumn),
                                    typeof(DataGridTemplateColumn));
attr.FactoryType = typeof(DataGridColumnFactory);
builder.AddCustomAttributes("Columns", attr);

上下文菜单项

 

在我们使用wpf的datagird时候，在选中DataGrid控件时,点击右键的话,会有一个自定义的DataGrid菜单,如下图

 

wpf设计器允许对控件提供自定义菜单项,这是通过继承一个名为PrimarySelectionContextMenuProvider的类实现的,上图的右键菜单由DataGridMenuProvider来实现,我们来看一下具体实现方法.如下

1.声明一个MenuGroup类,表明一个菜单项组,一个菜单则是一个MenuAction类.

通过MenuGroup的Items集合添加MenuAction.

2.更新菜单项状态UpdateItemStatus ,该事件会都目前的菜单进行判断,做出状态变更,如初始化并未显示Remove Columns这个菜单.

 

public DataGridMenuProvider()
{
    // Set up the MenuGroup which holds the MenuAction items.
    MenuGroup dataOperationsGroup = new MenuGroup("DataGroup", "DataGrid");

    isDatasourceSetMenuAction = new MenuAction("You need to set ItemsSource to enable some column operations.");

    generateStockColumnsMenuAction = new MenuAction("Generate Columns");
    generateStockColumnsMenuAction.Execute += new EventHandler<MenuActionEventArgs>(GenerateStockColumnsMenuAction_Execute);

    addColumnsMenuAction = new MenuAction("Add/Edit Columns...");
    addColumnsMenuAction.Execute += new EventHandler<MenuActionEventArgs>(AddColumnsMenuAction_Execute);

    removeColumnsMenuAction = new MenuAction("Remove Columns");
    removeColumnsMenuAction.Execute += new EventHandler<MenuActionEventArgs>(RemoveColumnsMenuAction_Execute);

    dataOperationsGroup.HasDropDown = true;
    dataOperationsGroup.Items.Add(isDatasourceSetMenuAction);
    dataOperationsGroup.Items.Add(generateStockColumnsMenuAction);
    dataOperationsGroup.Items.Add(addColumnsMenuAction);
    dataOperationsGroup.Items.Add(removeColumnsMenuAction);

    this.Items.Add(dataOperationsGroup);        // Can have groups - show up as sub menus
    
    // The UpdateItemStatus event is raised immediately before 
    // the menu show, which provides the opportunity to set states.
    UpdateItemStatus += new EventHandler<MenuActionEventArgs>(DataGridMenuProvider_UpdateItemStatus);
}

 

MenuAction可以通过Execute事件触发点击事件.这就可以使得运行时控件与设计器之间进行交互,这里涉及到一个wpf设计时的编辑模型放到下篇细讲.这篇就介绍集合项属性和自定义控件右键菜单的方法.下篇将会整理一个源码一起放上.