如何通过自定义MessageFilter的方式利用按键方式操作控件滚动条[附源代码]

很长一段时间内，一直在做一个SCSF（Smart Client Software Factory)的项目，已经进入UAT阶段。最近，用户提出了一个要求：需要通过按键方式来控制竖直滚动条。具体来讲就是说，如果一个容器内容过多，用户可以通过按键PageUp和PageDown来控制上下的滚动。刚开始，我试图采用注册事件的方式来实现，但是效果不理想，一来是没有一个单一的地方来对所有相关空间进行事件注册操作，二来如果容器被子控件完全遮挡，容器空间的事件将不会正常出发。有个同事提示采用自定义MessageFilter的方式，我觉得可行，于是进行了一番尝试。

一、实现原理简介

对于一个Windows Form应用来说，所有事件的触发都是采用消息（Message）的方式来实现的。比如，你点击了一个按钮，Windows会为这个操作之生成一个消息，并将这个消息分发（Dispatch）给按钮对象。如果能够在消息被分发给目标对象之前，能够对该消息进行了拦截，那么我们就可以按照我们希望的方式从新生成一个消息，并将其发送给我希望的目标对象，那么就能过随心所欲地控制目标对象的行为了。而自定义MessageFilter为我们提供了一个最好的消息拦截方式。

就拿我们上面给出控制滚动条的场景来说，当前容器由于内容过多而产生竖直滚动条（假设子控件的宽度和容器相同），用户键入PageDown按键试图向下滚动。Windows为本次键盘操作生成一个消息，并分发给目标对象（可能并不是我们需要控制的当前容器对象）。在此期间，我们通过MessageFilter对该消息实施拦截，从新产生一个基于“向下滚动”操作的消息，并分发给我们需要对其进行控制的容器，那么就实现了对于容器空间滚动条进行控制的目的。

二、实例应用场景简介

熟悉SCSF的朋友应该很清楚，SCSF的通过一个称为Shell的Form作为主界面，利用一个称为Workspace的容器最为整个应用的工作平台。应用动态运行过程中，各个Module的界面采用相同的方式添加到该Workspace之中。下图的就是我们将要演示的例子运行时的截图，为了简单起见，我直接通过一个System.Windows.Forms.TabControl作为Workspace。主菜单的两个菜单项分别代表两个模块，点击相应的菜单项后，会把相应的界面添加到Workspace中。在这里，我通过System.Windows.Forms.UserControl的方式定义Customer和Order模块的界面，当Customer和Order菜单被点击之后，会动态地在TabControl中添加相应的TabPage，并把相应的UserControl置于其中。由于整个TabControl的高度时固定的，而TabPage中显示的内容则依赖于具体的逻辑，所以对于内容过多的TabPage，将会有一个竖直滚动条。而我们需要通过按键的方式控制的就是当前TabPage的这个滚动条。

下面是该Form相关的代码，静态属性ActiveTabPage代表当前显示的TabPage。UserInfo和OrderInfo是两个UserControl，代表与具体模块相关的界面呈现。

using System;
using System.Collections.Generic;
using System.Windows.Forms;

namespace MessageFilterDemos
{
    public partial class MainForm : Form
    {
        public static TabPage ActiveTabPage
        { get;private set; }

        private IDictionary<string, UserControl> keyedViews
        { get; set; }

        public MainForm()
        {
            InitializeComponent();
            this.keyedViews = new Dictionary<string, UserControl>();
        }

        protected override void OnLoad(EventArgs e)
        {
            base.OnLoad(e);
            this.keyedViews.Add("CustomerInfo", new CustomerInfo());
            this.keyedViews.Add("OrderInfo", new OrderInfo());
        }

        private void Show(string key, string text, UserControl view)
        {
            if (!this.mainWorkspace.TabPages.ContainsKey(key))
            {
                this.mainWorkspace.TabPages.Add(key, text);
                this.mainWorkspace.TabPages[key].Controls.Add(view);
                this.mainWorkspace.TabPages[key].AutoScroll = true;
            }
            this.mainWorkspace.SelectedTab = this.mainWorkspace.TabPages[key];
            ActiveTabPage = this.mainWorkspace.TabPages[key];
        }

        private void ordeToolStripMenuItem_Click(object sender, EventArgs e)
        {
            this.Show("OrderInfo", "Order", keyedViews["OrderInfo"]);
        }

        private void customerToolStripMenuItem_Click(object sender, EventArgs e)
        {
            this.Show("CustomerInfo", "Customer", keyedViews["CustomerInfo"]);
        }

        private void mainWorkspace_SelectedIndexChanged(object sender, EventArgs e)
        {
            ActiveTabPage = this.mainWorkspace.SelectedTab;
        }
    }
}

 

三、自定义MessageFilter

现在我们进入重点话题，如何创建我们需要的自定义MessageFilter，由于我们这个MessageFilter旨在控制TabPag的滚动条，我们将其命名为ScrollbarControllerMessageFilter。ScrollbarControllerMessageFilter实现了接口System.Windows.Forms.IMessageFilter。下面是IMessageFilter的定义，它仅仅包含一个唯一的成员：PreFilterMessage，对消息的拦截、筛选操作就实现在这里。而Bool类新的返回值表示是否继续将消息分发的目标对象。

public interface IMessageFilter
{
    [SecurityPermission(SecurityAction.LinkDemand, Flags=SecurityPermissionFlag.UnmanagedCode)]
    bool PreFilterMessage(ref Message m);
}

下面是ScrollbarControllerMessageFilter的定义，代码不是很复杂，在这里只需简单的介绍一下流程：在PreFilterMessage方法中，先判断当前的TabPage是否存在，如果不存在，则不加干涉；然后通过System.Windows.Forms.Message的Msg属性确定当前事件是否是KeyDown，如果不是则直接返回；最后根据System.Windows.Forms.Message的WParam属性判断当前的按键是否是PageUp或者PageDown，并相应的向目标对象（当前的TabPage）发送一个关于向上或者向下滚动的消息。消息的发送通过调用Native方法SendMessage实现。

using System;
using System.Runtime.InteropServices;
using System.Windows.Forms;

namespace MessageFilterDemos
{
    public class ScrollbarControllerMessageFilter: IMessageFilter
    {

        private const int WM_KEYDOWN = 0x100;//Key down
        private const int WM_VSCROLL = 277; //Scroll
        private const int SB_PAGEUP = 2; // Scroll Up
        private const int SB_PAGEDOWN = 3; //Scroll Down

        #region IMessageFilter Members

        [DllImport("user32.dll")]
        static extern int SendMessage(IntPtr hWnd, int msg, int wParam, int lParam);

        public bool PreFilterMessage(ref Message m)
        {
            if (MainForm.ActiveTabPage == null)
            {
                return false;
            }

            if (WM_KEYDOWN != m.Msg)
            {
                return false;
            }

            if (m.WParam.ToInt32() == (int)(Keys.PageUp))
            {
                SendMessage(MainForm.ActiveTabPage.Handle, WM_VSCROLL, SB_PAGEUP, 0);
                return true;
            }

            if (m.WParam.ToInt32() == (int)(Keys.PageDown))
            {
                SendMessage(MainForm.ActiveTabPage.Handle, WM_VSCROLL, SB_PAGEDOWN, 0);
                return true;
            }

            return false;
        }

        #endregion
    }
}

四、注册ScrollbarControllerMessageFilter

对MessageFilter的注册很简单，仅仅需要的是调用System.Windows.Forms.Application的AddMessageFilter方法即可。实例代码下载地址：https://files.cnblogs.com/artech/MessageFilterDemos.zip。

using System;
using System.Windows.Forms;

namespace MessageFilterDemos
{
    static class Program
    {
        [STAThread]
        static void Main()
        {
            Application.AddMessageFilter(new ScrollbarControllerMessageFilter());
            Application.EnableVisualStyles();
            Application.SetCompatibleTextRenderingDefault(false);
            Application.Run(new MainForm());
        }
    }
}

作者：Artech
出处：http://artech.cnblogs.com
本文版权归作者和博客园共有，欢迎转载，但未经作者同意必须保留此段声明，且在文章页面明显位置给出原文连接，否则保留追究法律责任的权利。