IMessageFilter.PreFilterMessage(Message) Method

Reference

Definition

Namespace:: System.Windows.Forms

Assembly:: System.Windows.Forms.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Filters out a message before it is dispatched.

public:
 bool PreFilterMessage(System::Windows::Forms::Message % m);

public bool PreFilterMessage (ref System.Windows.Forms.Message m);

abstract member PreFilterMessage : Message -> bool

Public Function PreFilterMessage (ByRef m As Message) As Boolean

Parameters

m: Message

The message to be dispatched. You cannot modify this message.

Returns

Boolean

true to filter the message and stop it from being dispatched; false to allow the message to continue to the next filter or control.

Remarks

Use PreFilterMessage to filter out a message before it is dispatched to a control or form. For example, to stop the Click event of a Button control from being dispatched to the control, you implement the PreFilterMessage method and return a true value when the Click message occurs. You can also use this method to perform code work that you might need to do before the message is dispatched.

Applies to