views:

1702

answers:

3

I have a base class that contains the following events:

public event EventHandler Loading;
public event EventHandler Finished;

In a class that inherits from this base class I try to raise the event:

this.Loading(this, new EventHandler()); // All we care about is which object is loading.

I receive the following error:

The event 'BaseClass.Loading' can only appear on the left hand side of += or -= (BaseClass')

I am assuming I cannot access these events the same as other inherited members?

+2  A: 

I am assuming I cannot access these events the same as other inherited members?

Precisely. It's customary to provide a protected function OnXyz or RaiseXyz for each event in the base class to enable raising from inherited classes. For example:

public event EventHandler Loading;

protected virtual void OnLoading() {
    EventHandler handler = Loading;
    if (handler != null)
        handler(this, EventArgs.Empty);
}

Called in the inherited class:

OnLoading();
Konrad Rudolph
+12  A: 

What you have to do , is this:

In your base class (where you have declared the events), create protected methods which can be used to raise the events:

public class MyClass
{
   public event EventHandler Loading;
   public event EventHandler Finished;

   protected void OnLoading(EventArgs e)
   {
       EventHandler handler = Loading;
       if( handler != null )
       {
           handler(this, e);
       }
   }

   protected void OnFinished(EventArgs e)
   {
       EventHandler handler = Finished;
       if( handler != null )
       {
           handler(this, e);
       }
   }
}

(Note that you should probably change those methods, in order to check whether you have to Invoke the eventhandler or not).

Then, in classes that inherit from this base class, you can just call the OnFinished or OnLoading methods to raise the events:

public AnotherClass : MyClass
{
    public void DoSomeStuff()
    {
        ...
        OnLoading(EventArgs.Empty);
        ...
        OnFinished(EventArgs.Empty);
    }
}
Frederik Gheysels
Those methods should be protected virtual unless there's some reason to do otherwise.
Max Schmeling
Why should it be virtual ? I would declare it virtual if I wanted inheritors to change the way the event should be raised, but most of the time, I see no reason to do this ...
Frederik Gheysels
By guidelines Microsoft says it should be virtual so that inheritants can control the event.. additionally the On protected method should take event args, not create them itself. This answer is wrong compared to the correct one by Adam Robinson.
meandmycode
@Frederik: The convention for inheritors handling events is to override the raising event rather than attaching it themselves, as a) polymorphism is (slightly) more efficient than a multicast delegate, and b) it gives them control over when their code is executed (ie before or after subscriber code)
Adam Robinson
Official guidelines: http://msdn.microsoft.com/en-us/library/w369ty8x(VS.80).aspx
meandmycode
meandmycode: regarding the arguments: this is just some example code. Offcourse it is better to pass them as arguments ... I'll change it if it makes you happy. :o:
Frederik Gheysels
Regarding making the method virtual, so that inheritors can override the event invocation behaviour: How many times have you been in a situation where this was necessary ? Next to that; in the overriden method, you can't raise the event, since you'll get the same error as the one mentioned by TS.
Frederik Gheysels
Frederik, you can raise the error- you call base.On~
meandmycode
Yes, you can raise it by calling the base implementation. But what other additional functionality could you possibly think of ?
Frederik Gheysels
@Frederik: As stated earlier, controlling whether YOUR code executes before or after the code of the event subscribers. I do this on a regular basis.
Adam Robinson
+10  A: 

You can only access an event in the declaring class, as .NET creates private instance variables behind the scenes that actually hold the delegate. Doing this..

public event EventHandler MyPropertyChanged;

is actually doing this;

private EventHandler myPropertyChangedDelegate;

public event EventHandler MyPropertyChanged
{
    add { myPropertyChangedDelegate += value; }
    remove { myPropertyChangedDelegate -= value; }
}

and doing this...

MyPropertyChanged(this, EventArgs.Empty);

is actually this...

myPropertyChangedDelegate(this, EventArgs.Empty);

So you can (obviously) only access the private delegate instance variable from within the declaring class.

The convention is to provide something like this in the declaring class..

protected virtual void OnMyPropertyChanged(EventArgs e)
{
    EventHandler invoker = MyPropertyChanged;

    if(invoker != null) invoker(this, e);
}

You can then call OnMyPropertyChanged(EventArgs.Empty) from anywhere in that class or below the inheritance heirarchy to invoke the event.

Adam Robinson