.NET Tip: Creating and Using Your Own Events Chapel Hill NC

provided by: 
Originally published at Internet.com

When I'm writing code for user controls that need to signal the host page when they're done with some task, I define and use an event. I simply register for a custom event and run my code when the event occurs. This makes a clean interface between the user control and the page and makes managing the sequence of events within a page easier.

An application I have uses a custom Login control that handles user registration and login functions. This control has an event called UserAuthenticated that passes back the user's unique ID number, as well as a flag indicating whether the information should be saved permanently using a cookie or other mechanism.

I start by defining the event and its handler in the LoginControl: public delegate void UserAuthHandler(int userID, bool saveInfo); public event UserAuthHandler UserAuthenticated;

Each event I define has both delegate and event definitions. The first declaration indicates which data can be sent with the event. The second declaration is the actual event. Next, I cause the event to occur: UserAuthenticated(userID, chkSavePassword.Checked);

I call the event just as I would any other function. In this case, I pass the data required by the event. This code will work only if the hosting page or control has registered for the event-otherwise, I'll get an error when I "raise" the event.

The code to register for the event is done in the same way as any other event handler. I can either add the attribute to the server control tag, or add the event handler in the OnInit event. My preference is to do all the event handler linkages within the OnInit event so they are all in one place and easy to find. Here's the code for this particular event: protected override void OnInit(EventArgs e) { base.OnInit(e); ctlLogin.UserAuthenticated += new LoginControl.UserAuthHandler(ctlLogin_UserAuthenticated); }

As with other events, typing this line creates the following function in the Web page: protected void ctlLogin_UserAuthenticated(int userID, bool saveInfo) { }

In my page, the login control is hidden and the next panel is displayed when the login is complete. I also store the user ID for later use in a cookie that persists based on the value of the saveInfo parameter.

About the Author

Eric Smith is the owner of Northstar Computer Systems, a Web-hosting company based in Indianapolis, Indiana. He is also a MCT and MCSD who has been developing with .NET since 2001. In addition, he has written or contributed to 12 books covering .NET, ASP, and Visual Basic. Send him your questions and feedback via e-mail at questions@techniquescentral.com.