Skip to main content
.NET Framework Class Library
Application..::.AddMessageFilter Method

Adds a message filter to monitor Windows messages as they are routed to their destinations.

Namespace: System.Windows.Forms
Assembly: System.Windows.Forms (in System.Windows.Forms.dll)
Syntax
Public Shared Sub AddMessageFilter ( _
	value As IMessageFilter _
)
public static void AddMessageFilter(
	IMessageFilter value
)
public:
static void AddMessageFilter(
	IMessageFilter^ value
)
static member AddMessageFilter : 
        value:IMessageFilter -> unit 

Parameters

value
Type: System.Windows.Forms..::.IMessageFilter
The implementation of the IMessageFilter interface you want to install.
Remarks

Use a message filter to prevent specific events from being raised or to perform special operations for an event before it is passed to an event handler. Message filters are unique to a specific thread.

To prevent a message from being dispatched, the value parameter instance that you pass to this method must override the PreFilterMessage method with the code to handle the message. The method must return false.

Caution noteCaution

Adding message filters to the message pump for an application can degrade performance.

Examples

The following code example creates a message filter called TestMessageFilter. This filter blocks all messages relating to the left mouse button. Before you can use a message filter, you must provide an implementation for the IMessageFilter interface.


' Creates a message filter.
<SecurityPermission(SecurityAction.LinkDemand, Flags := SecurityPermissionFlag.UnmanagedCode)> _
Public Class TestMessageFilter
    Implements IMessageFilter

    <SecurityPermission(SecurityAction.Demand)> _
    Public Function PreFilterMessage(ByRef m As System.Windows.Forms.Message) _
    As Boolean Implements IMessageFilter.PreFilterMessage
        ' Blocks all the messages relating to the left mouse button.
        If ((m.Msg >= 513) And (m.Msg <= 515)) Then
            Console.WriteLine("Processing the messages : " & m.Msg)
            Return True
        End If
        Return False
    End Function
End Class



// Creates a  message filter.
[SecurityPermission(SecurityAction.LinkDemand, Flags = SecurityPermissionFlag.UnmanagedCode)]
public class TestMessageFilter : IMessageFilter
{
    public bool PreFilterMessage(ref Message m)
    {
        // Blocks all the messages relating to the left mouse button.
        if (m.Msg >= 513 && m.Msg <= 515)
        {
            Console.WriteLine("Processing the messages : " + m.Msg);
            return true;
        }
        return false;
    }
}



   // Creates a  message filter.
   ref class TestMessageFilter: public IMessageFilter
   {
   public:
      [SecurityPermission(SecurityAction::LinkDemand, Flags = SecurityPermissionFlag::UnmanagedCode)]
      virtual bool PreFilterMessage( Message % m )
      {

         // Blocks all the messages relating to the left mouse button.
         if ( m.Msg >= 513 && m.Msg <= 515 )
         {
            Console::WriteLine( "Processing the messages : {0}", m.Msg );
            return true;
         }

         return false;
      }

   };


Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
.NET Framework Security
Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.