How to add an event to a UserControl in C#?

by

First, you need to declare the event within your class (alongside your methods and constructors):

public event EventHandler LabelsTextChanged;

Then you need to create a method to handle the individual labels’ TextChanged events.

private void HandleLabelTextChanged(object sender, EventArgs e)
{
    // we'll explain this in a minute
    this.OnLabelsTextChanged(EventArgs.Empty);
}

Somewhere, probably in your control’s constructor, you need to subscribe to the label’s TextChanged events.

myLabel1.TextChanged += this.HandleLabelTextChanged;
myLabel2.TextChanged += this.HandleLabelTextChanged;
myLabel3.TextChanged += this.HandleLabelTextChanged;

Now for the HandleLabelsTextChanged method. We could raise LabelsTextChanged directly; however, the .NET framework design guidelines say that is it a best practice to create an OnEventName protected virtual method to raise the event for us. That way, inheriting classes can “handle” the event by overriding the OnEventName method, which turns out to have a little better performance than subscribing to the event. Even if you think you will never override the OnEventName method, it is a good idea to get in the habit of doing it anyway, as it simplifies the event raising process.

Here’s our OnLabelsTextChanged:

protected virtual void OnLabelsTextChanged(EventArgs e)
{
    EventHandler handler = this.LabelsTextChanged;
    if (handler != null)
    {
        handler(this, e);
    }
}

We have to check for null because an event without subscribers is null. If we attempted to raise a null event, we would get a NullReferenceException. Note that we copy the event’s EventHandler to a local variable before checking it for null and raising the event. If we had instead done it like this:

if (this.LabelsTextChanged != null)
{
    this.LabelsTextChanged(this, e);
}

We would have a race condition between the nullity check and the event raising. If it just so happened that the subscribers to the event unsubscribed themselves just before we raised the event but after we checked for null, an exception would be thrown. You won’t normally encounter this issue, but it is best to get in the habit of writing it the safe way.

Edit: Here is how the public event EventHandler LabelsTextChanged; line should be placed:

namespace YourNamespace
{
    class MyUserControl : UserControl
    {
        // it needs to be here:
        public event EventHandler LabelsTextChanged;

        ...
    }
}

Here are the framework design guidelines on event design for further reading.

More Related Contents:

  1. How to remove all event handlers from an event
  2. How to fix the flickering in User controls
  3. How do I make an Event in the Usercontrol and have it handled in the Main Form?
  4. How to render a formula in WPF or WinForms
  5. ‘UserControl’ constructor with parameters in C#
  6. How do I execute code AFTER a form has loaded?
  7. In C# Winforms is there a way to put dotted border around all controls and show grip points upon selection of specific controls at runtime?
  8. expose and raise event of a child control in a usercontrol in c#
  9. Passing data between WinForms forms [duplicate]
  10. How do I add my new User Control to the Toolbox or a new Winform?
  11. Text property in a UserControl in C#
  12. Get access to parent control from user control – C#
  13. Displaying a collection of controls in Windows Forms
  14. How is this possible: OnPaint processed while in WaitOne
  15. How to create a C# Winforms Control that hovers
  16. Remove Row inside TableLayoutPanel makes a layout problem
  17. UserControl with header and content – Allow dropping controls in content panel and Prevent dropping controls in header at design time
  18. Parent Control Mouse Enter/Leave Events With Child Controls
  19. How do I create 5 buttons and assign individual click events dynamically? [closed]
  20. How to make Form1 label.text change when checkbox on form2 is checked?
  21. Making an indexed control array?
  22. Order of events ‘Form.Load’, ‘Form.Shown’ and ‘Form.Activated’ in Windows Forms
  23. Abstract UserControl inheritance in Visual Studio designer
  24. Catch Textbox Scroll Event?
  25. Passing Data Between 3 Separate WinForms [duplicate]
  26. How do I raise an event in a usercontrol and catch it in mainpage?
  27. Avoiding the woes of Invoke/BeginInvoke in cross-thread WinForm event handling?
  28. Detect when a form has been closed c#
  29. Fire Form KeyPress event
  30. Triggering a checkbox value changed event in DataGridView

Leave a Comment