CommandParameter is null when call CanExecute method at first time

.NET Core Version: (3.0.0-preview-27122-01)
Windows version: (windows 10)
Does the bug reproduce also in WPF for .NET Framework 4.6.1?: Yes

Problem description:

I have a TestCommand as below:

public class TestCommand : ICommand
{
    public event EventHandler CanExecuteChanged;

    public bool CanExecute(object parameter)
    {
        return true;
    }

    public void Execute(object parameter)
    {
    }
}

and then I use it in a xaml file:

<Button Content="Test" Command="{StaticResource testCommand}" CommandParameter="abcdef"/>

Actual behavior:
At first time the CanExecute method is called, the parameter's value is null。
If I change the XAML property's order as below, the parameter's value is abcdef (that's ok):

<Button Content="Test" CommandParameter="abcdef" Command="{StaticResource testCommand}"/>

Expected behavior:
The parameter's value is not null at each time, regardless of the XAML order

Minimal repro:

I'm having uncomfortable flashbacks to when I first learned of this ☹️

I'm not sure anything can be done about this. XAML properties are assigned sequentially, and I doubt that's negotiable. This would probably require some kind of hack in the XAML reader.

@brandonhood

@brandonhood, or the button could just defer the call between BeginInit and EndInit?

In my opinion, the XAML equals to the codes:

var button = new Button
{
    Content = "Test",
    Command = ...
    CommandParameter = ...
};

and the CanExecute method will be called by some methods such as Load ...

The .NET framework version of the xaml parser honours the ISupportInitialize interface (which is implemented by FrameworkElement), so its actually more like this:

var button = new Button();
((ISupportInitialize)button).BeginInit();
button.Content = "Test";
button.Command = ...
button.CommandParameter = ...
((ISupportInitialize)button).EndInit();

I agree that this behavior is incorrect. I think something like this should be pretty straightforward to do. FrameworkElement has an OnInitialized override that Button should be able to invoke the command from. However, we don't know who is currently depending on the current behavior, so this is something that we can look into fixing after the initial release of .NET Core 3.

This issue been around for a while. The easiest fix for now is to change the order so that CommandParameter appears before Command but order should not matter.

Related: https://stackoverflow.com/questions/335849/wpf-commandparameter-is-null-first-time-canexecute-is-called

I would like to propose a solution for the Button and MenuItem cases mentioned in the linked Stack Overflow question above.

Looking at stack trace that leads to the bug for the Button case

StackTrace leading to ICommand.CanExecute Bug.txt

we see that the error occurs in the
PresentationFramework.dll!MS.Internal.Commands.CommandHelpers.CanExecuteCommandSource(System.Windows.Input.ICommandSource commandSource)
method

The idea is to delay the execution of this method until the WPF elements are initialized. See the above linked commit 0c6b967 for the details.

The attached test project can be used to verify the proposed solution.

CommandCanExecuteProject.zip

Microsoft has shifted its focus to WinUI 3, give it up, rubbish WPF.

Microsoft has shifted its focus to WinUI 3, give it up, rubbish WPF.

Abandoned UI frameworks I am aware of since the introduction of WPF:

Silverlight
WinRT
WinPRT
Windows Universal Apps (for Windows 8)
UWP (WinUI 2)

If you believe that WinUI 3 will stay alive for more than 2-3 years, then you haven't been paying attention.

If WinUI 3 focus on Win32 App, that will be difference.

Got same issue today, .NET 6 WPF.

Got same issue today, .NET 6 WPF.

Stop expecting any functional updates, improvements, and fixes in WPF. The vast majority of updates are xaml-related, which is likely just incidental to Microsoft updating other UI frameworks that use xaml.

@heku

@heku - This has been fixed in RC1 release. You may try it out.

@DaveInCaz - We haven't yet. But we'll be publishing them soon.

@pchaurasia14

@pchaurasia14 it looks like this was the change you're referring to, is that right?

#4217

I could see that in the list of commits for the RC1 release.

@DaveInCaz - Yup, that's the one I think it is.

@pchaurasia14

@pchaurasia14 what does it mean that .NET 6.0 RC1 was released in 2021, but this commit was done only in July 2022?

@DaveInCaz - I meant, .NET 7 RC1.

Closing as the PR is already merged for this.

Navigation Menu

Repository navigation

CommandParameter is null when call CanExecute method at first time #316

9 remaining items

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

CommandParameter is null when call CanExecute method at first time #316

Description

Activity

bhood-zorus commented on Feb 4, 2019

brian-reichle commented on Feb 7, 2019

chenyj796 commented on Feb 7, 2019

brian-reichle commented on Feb 7, 2019

weltkante commented on Feb 7, 2019

stevenbrix commented on Apr 4, 2019

vflame commented on May 13, 2019

MichaelVach commented on Jul 5, 2019

MichaelVach commented on Jul 8, 2019

9 remaining items

GF-Huang commented on Nov 18, 2021

sungaila commented on Nov 22, 2021

GF-Huang commented on Nov 22, 2021

heku commented on Sep 9, 2022

GF-Huang commented on Sep 9, 2022

pchaurasia14 commented on Sep 9, 2022

pchaurasia14 commented on Sep 9, 2022

DavidHollman commented on Sep 9, 2022

pchaurasia14 commented on Sep 9, 2022

DavidHollman commented on Sep 9, 2022

pchaurasia14 commented on Sep 10, 2022

singhashish-wpf commented on Jan 6, 2023

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions