Since there's no button.PerformClick()
method in WPF, is there a way to click a WPF button programmatically?
10 Answers
Like JaredPar said you can refer to Josh Smith's article towards Automation. However if you look through comments to his article you will find more elegant way of raising events against WPF controls
someButton.RaiseEvent(new RoutedEventArgs(ButtonBase.ClickEvent));
I personally prefer the one above instead of automation peers.
-
33The RaiseEvent solution only raises the event. It does not execute the Command associated with the Button (as Skanaar say) Commented Jan 18, 2010 at 10:30
-
4If you use XAML eg <Button Name="X" Click="X_Click" />, the event will be caught by the on click handler as per normal. +1 from me!– metaoCommented Jun 3, 2010 at 3:59
-
6I'm using VB...not sure if the code is different for VB verses C#, but
new RoutedEventArgs(Button.ClickEvent)
didn't work for me. I had to usenew RoutedEventArgs(Primitives.ButtonBase.ClickEvent)
. Otherwise, works great! Commented Mar 8, 2012 at 17:25 -
4To elaborate on @EduardoMolteni and Skanaar, you lose the IsEnabled functionality given by Commands this way, so unless you want all of your events to check if they are enabled, the AutomationPeer works better. Commented Jul 17, 2012 at 17:19
WPF takes a slightly different approach than WinForms here. Instead of having the automation of a object built into the API, they have a separate class for each object that is responsible for automating it. In this case you need the ButtonAutomationPeer
to accomplish this task.
ButtonAutomationPeer peer = new ButtonAutomationPeer(someButton);
IInvokeProvider invokeProv = peer.GetPattern(PatternInterface.Invoke) as IInvokeProvider;
invokeProv.Invoke();
Here is a blog post on the subject.
Note: IInvokeProvider
interface is defined in the UIAutomationProvider
assembly.
-
2Slick, I wasn't aware of this. Could be very useful for automated testing. Note that there's a comment on that link which suggests using a provided factory to get the automation peer instead of creating one yourself.– Greg DCommented Apr 8, 2009 at 11:46
-
7Thanks for this. I struggled to find the correct namespaces in my app, until I added a reference to
UIAutomationProvider
. Then had to addusing System.Windows.Automation.Peers; using System.Windows.Automation.Provider;
Commented Nov 28, 2014 at 9:37 -
5A one-liner for the inclined:
((IInvokeProvider) (new ButtonAutomationPeer(someButton).GetPattern(PatternInterface.Invoke)).Invoke();
Commented Jan 7, 2015 at 15:24 -
3One thing to note is that the Invoke call is asynchronous. That means if you are using it in a unit test and your next line is to check the expected result of clicking the button, you might have to wait.– denverCommented Apr 22, 2015 at 18:32
-
4Just for reference, the
IInvokeProvider
interface is defined in theUIAutomationProvider
assembly. Commented Jan 31, 2017 at 15:09
if you want to call click event:
SomeButton.RaiseEvent(new RoutedEventArgs(Button.ClickEvent));
And if you want the button looks like it is pressed:
typeof(Button).GetMethod("set_IsPressed", BindingFlags.Instance | BindingFlags.NonPublic).Invoke(SomeButton, new object[] { true });
and unpressed after that:
typeof(Button).GetMethod("set_IsPressed", BindingFlags.Instance | BindingFlags.NonPublic).Invoke(SomeButton, new object[] { false });
or use the ToggleButton
-
This is awesome answer I was looking for three hours. Great! btw, are you still alive, @Sonorx ? Commented Oct 23, 2024 at 14:02
One way to programmatically "click" the button, if you have access to the source, is to simply call the button's OnClick event handler (or Execute the ICommand associated with the button, if you're doing things in the more WPF-y manner).
Why are you doing this? Are you doing some sort of automated testing, for example, or trying to perform the same action that the button performs from a different section of code?
-
It's not the only solution to my problem, but when I tried to do this, I found that it's not as easy as button.PerformClick(), so just a bit curious... :)– tghoangCommented Apr 8, 2009 at 4:09
-
I had to click on the menu of another window in the same project, and MyOtherWindow.mnuEntry_Click(Me, New Windows.RoutedEventArgs) did it. Really simple. Commented Jun 23, 2017 at 16:39
As Greg D said, I think that an alternative to Automation
to click a button using the MVVM pattern (click event raised and command executed) is to call the OnClick
method using reflection:
typeof(System.Windows.Controls.Primitives.ButtonBase).GetMethod("OnClick", BindingFlags.Instance | BindingFlags.NonPublic).Invoke(button, new object[0]);
-
This is a good way to use an event from a child element to fire a command on a parent. Commented Jan 28, 2017 at 7:09
When using the MVVM Command pattern for Button function (recommended practice), a simple way to trigger the effect of the Button is as follows:
someButton.Command.Execute(someButton.CommandParameter);
This will use the Command object which the button triggers and pass the CommandParameter defined by the XAML.
-
One note, this only triggers the effect the button will have if clicked. It does not generate any click events in the message dispatching queue. For all practical cases this is what you will desire and will avoid unnecessary dispatcher events (e.g. more performant) but if your actually somehow requiring the dispatcher events other solutions above are more appropriate Commented Jan 13, 2019 at 22:00
-
1
You can also call the method for the button getting clicked
Button_Click(new object(), new RoutedEventArgs(ButtonBase.ClickEvent));
Anther way is ButtonName.RaiseEvent(new RoutedEventArgs(ButtonBase.ClickEvent));
Both ways need using System.Windows.Controls.Primitives;
Button_Click(new object(), new RoutedEventArgs(ButtonBase.ClickEvent));
ButtonName.RaiseEvent(new RoutedEventArgs(ButtonBase.ClickEvent));
The problem with the Automation API solution is, that it required a reference to the Framework assembly UIAutomationProvider
as project/package dependency.
An alternative is to emulate the behaviour. In the following there is my extended solution which also condiders the MVVM-pattern with its bound commands - implemented as extension method:
public static class ButtonExtensions
{
/// <summary>
/// Performs a click on the button.<br/>
/// This is the WPF-equivalent of the Windows Forms method "<see cref="M:System.Windows.Forms.Button.PerformClick" />".
/// <para>This simulates the same behaviours as the button was clicked by the user by keyboard or mouse:<br />
/// 1. The raising the ClickEvent.<br />
/// 2.1. Checking that the bound command can be executed, calling <see cref="ICommand.CanExecute" />, if a command is bound.<br />
/// 2.2. If command can be executed, then the <see cref="ICommand.Execute(object)" /> will be called and the optional bound parameter is p
/// </para>
/// </summary>
/// <param name="sourceButton">The source button.</param>
/// <exception cref="ArgumentNullException">sourceButton</exception>
public static void PerformClick(this Button sourceButton)
{
// Check parameters
if (sourceButton == null)
throw new ArgumentNullException(nameof(sourceButton));
// 1.) Raise the Click-event
sourceButton.RaiseEvent(new RoutedEventArgs(System.Windows.Controls.Primitives.ButtonBase.ClickEvent));
// 2.) Execute the command, if bound and can be executed
ICommand boundCommand = sourceButton.Command;
if (boundCommand != null)
{
object parameter = sourceButton.CommandParameter;
if (boundCommand.CanExecute(parameter) == true)
boundCommand.Execute(parameter);
}
}
}
# Create extension method and use always button #
public static class UIExtension
{
public static void PerformClick(this Button button)
{
button.RaiseEvent(new RoutedEventArgs(ButtonBase.ClickEvent));
}
}
public partial class MyForm : Window
{
InitializeComponent();
myButton.PerformClick();
}