Skip to main content

CallerMemberName not that great for INotifyPropertyChanged

I've blogged before about the perf improvements of using the CallerMemberName attribute over an expression tree to avoid using hard-coded property strings names when firing the PropertyChanged event on INotifyPropertyChanged.

This works great for the majority simple cases.

Setting the property & notifying:
 or just notifying:
The problem is when it's not the simple case - when setting a property on a view model and wanting to force the updating of another property (on the view model) it doesn't work obviously.
At this point I'm thinking I'll go back to the expression tree approach.

Comments

  1. A solution I'm trying out at the moment uses two parameters for the RaisePropertyChanged method:

    protected void RaisePropertyChanged(string property = null, [CallerMemberName]string caller = "")
    {
    var handler = PropertyChanged;
    if (handler != null)
    handler(this, new PropertyChangedEventArgs(property ?? caller));
    }

    With this implementation a call to "RaisePropertyChanged()" will raise the event with the caller name, while "RaisePropertyChanged("Message")" will raise it with "Message" as the property name, regardless of where it's called from.

    ReplyDelete
  2. Huh? A single parameter is enough. [CallerMemberName] only changes the default value when you don't pass anything.

    protected void RaisePropertyChanged([CallerMemberName] string propertyName = "")

    RaisePropertyChanged(); in a setter will pass the current property name.
    RaisePropertyChanged("RelatedProperty"); anywhere will always pass "RelatedProperty".

    Your code looks wrong. It isn't sufficient to simply call the PropertyChanged(...) event. There are additional checks.

    ReplyDelete
  3. Consider a different approach altogether...
    (as detailed here http://northhorizon.net/2011/the-right-way-to-do-inotifypropertychanged/)

    Instead of having your SubCategories property be a simple getter that needs notified to "refresh", have all your properties be a simple get/set using the SetProperty method, but with a slight change.

    Add two additional parameters, onChanged, and onChanging (or just onChanged if you don't need the onChanging handler)

    ie.
    SetProperty( ref T currentValue, T newValue, [CallerMemberName]string propertyName = "", Action onChanged = null, Action onChanging = null)

    ( In the SetProperty code you will need to call onChanged if it is not null and the property is changing )

    Now your SubCategories property becomes this:

    public IEnumerable SubCategories
    {
    get { return _subCategories; }
    set { SetProperty(ref _subCategories, value);
    }

    your SelectedCategory property this:

    public string SelectedCategory
    {
    get{ return _selectedCategory; }
    set { SetProperty(ref _selectedCategory, value, onChanged:OnSelectedCategoryChanged);}
    }

    And you have an OnChanged handler that does all the work.
    When SelectedCategory is set, this will be called and it will in turn update your SubCategories property.

    private void OnSelectedCategoryChanged()
    {
    if(_selectedCategory == _categories.Keys.First() || string.IsNullOrWhiteSpace(_selectedCategory))
    {
    SubCategories = _categories.SelectMany(c=>c.Value);
    return;
    }

    SubCategories = _categories[_selectedCategory];
    }

    Now you don't need to worry about manually raising the property changed notification for the SubCategories property, you set the SubCategories property from the OnChanged handler, which will in turn do the notify for you.

    If you follow this approach everywhere, you'll find that your property declarations become exactly what they are, boilerplate code. You can just create templates/snippets to create them and then wrap them in a region and never look at them again. You will never really need to manually call OnPropertyChanged again.

    ReplyDelete

Post a Comment

Popular posts from this blog

Showing a message box from a ViewModel in MVVM

I was doing a code review with a client last week for a WPF app using MVVM and they asked ' How can I show a message from the ViewModel? '. What follows is how I would (and have) solved the problem in the past. When I hear the words ' show a message... ' I instantly think you mean show a transient modal message box that requires the user input before continuing ' with something else ' - once the user has interacted with the message box it will disappear. The following solution only applies to this scenario. The first solution is the easiest but is very wrong from a separation perspective. It violates the ideas behind the Model-View-Controller pattern because it places View concerns inside the ViewModel - the ViewModel now knows about the type of the View and specifically it knows how to show a message box window: The second approach addresses this concern by introducing the idea of messaging\events between the ViewModel and the View. In the example below

Implementing a busy indicator using a visual overlay in MVVM

This is a technique we use at work to lock the UI whilst some long running process is happening - preventing the user clicking on stuff whilst it's retrieving or rendering data. Now we could have done this by launching a child dialog window but that feels rather out of date and clumsy, we wanted a more modern pattern similar to the way <div> overlays are done on the web. Imagine we have the following simple WPF app and when 'Click' is pressed a busy waiting overlay is shown for the duration entered into the text box. What I'm interested in here is not the actual UI element of the busy indicator but how I go about getting this to show & hide from when using MVVM. The actual UI elements are the standard Busy Indicator coming from the WPF Toolkit : The XAML behind this window is very simple, the important part is the ViewHost. As you can see the ViewHost uses a ContentPresenter element which is bound to the view model, IMainViewModel, it contains 3 child v

Custom AuthorizationHandler for SignalR Hubs

How to implement IAuthorizationRequirement for SignalR in Asp.Net Core v5.0 Been battling this for a couple of days, and eventually ended up raising an issue on Asp.Net Core gitHub  to find the answer. Wanting to do some custom authorization on a SignalR Hub when the client makes a connection (Hub is created) and when an endpoint (Hub method) is called:  I was assuming I could use the same Policy for both class & method attributes, but it ain't so - not because you can't, because you need the signatures to be different. Method implementation has a resource type of HubInnovationContext: I assumed class implementation would have a resource type of HubConnectionContext - client connects etc... This isn't the case, it's infact of type DefaultHttpContext . For me I don't even need that, it can be removed completely  from the inheritence signature and override implementation. Only other thing to note, and this could be a biggy, is the ordering of the statements in th