What do I need Protected WithEvents for?

I've noticed "Protected WithEvents" in the declarations for my controls on an ASPX web form. What's this all about? What does it mean?
When working with web forms, you need to have Protected WithEvents preceding the controls. Well almost. Here's what each one means and does.

Protected: You have to have this. This is what establishes the link between the instance of the control that is declared in the HTML and the instance in the code-behind.

HTML Markup (mypage.aspx):
<asp:button id="cmdClickMe" runat="server" />
Code-behind (mypage.aspx.vb):
Protected WithEvents cmdClickMe As System.Web.UI.WebControls.Button

WithEvents: This is not always required. This is used to provide the linkup of the event handlers so that you can create a method and use Handles cmdClickMe.Click to wire in the event. If you have a control on a web form that does not require events (which is more likely than not for things like labels or text boxes) you can remove the WithEvents keyword. Usually, the things that need event wiring are buttons, radio buttons, checkboxes, selects (dropdownlist or listbox), etc. If you want to use a text box's OnChanged event, then you would need it.


If you have a lot of controls on a page, it would probably be a little faster if you don't have WithEvents on controls that don't need it. On a page by page basis, you probably wouldn't notice it but once the application is being used my many users at the same time, things will be faster.

Where to Next?

Wonder where to go next? You can post a comment on this article.

Doc ID 300
Full URL https://imar.spaanjaars.com/300/what-do-i-need-protected-withevents-for
Short cut https://imar.spaanjaars.com/300/
Written by Imar Spaanjaars
Date Posted 05/23/2004 15:18
Date Last Updated 05/23/2004 15:25
Date Last Reviewed 06/10/2006 15:41


Talk Back! Comment on Imar.Spaanjaars.Com

I am interested in what you have to say about this article. Feel free to post any comments, remarks or questions you may have about this article. The Talk Back feature is not meant for technical questions that are not directly related to this article. So, a post like "Hey, can you tell me how I can upload files to a MySQL database in PHP?" is likely to be removed. Also spam and unrealistic job offers will be deleted immediately.

When you post a comment, you have to provide your name and the comment. Your e-mail address is optional and you only need to provide it if you want me to contact you. It will not be displayed along with your comment. I got sick and tired of the comment spam I was receiving, so I have protected this page with a simple calculation exercise. This means that if you want to leave a comment, you'll need to complete the calculation before you hit the Post Comment button.

If you want to object to a comment made by another visitor, be sure to contact me and I'll look into it ASAP. Don't forget to mention the page link, or the Doc ID of the document.

(Plain text only; no HTML or code that looks like HTML or XML. In other words, don't use < and >. Also no links allowed.