KEMBAR78
Fix for TapGestureRecognizer ButtonMask always return 0 by HarishwaranVijayakumar · Pull Request #30372 · dotnet/maui · GitHub
Skip to content

Conversation

HarishwaranVijayakumar
Copy link
Contributor

Note

Are you waiting for the changes in this PR to be merged?
It would be very helpful if you could test the resulting artifacts from this PR and let us know in a comment if this change resolves your issue. Thank you!

Issue Details

  • TapGestureRecognizer.Buttons always returns 0, regardless of whether the primary or secondary mouse button is used.

Root Cause of the issue

  • In the TappedEventArgs class, the Buttons property has a private setter, meaning it can only be set internally. However, since the class does not assign a value to it—either in its constructor or through any internal method—the property always remains zero.

Description of Change

  • Added internal constructor that accepts ButtonsMask and modified event invocation to pass the button information

Issues Fixed

Fixes #24734

Tested the behaviour in the follwing platforms

  • - Windows
  • - Android
  • - iOS
  • - Mac

Output

Before Fix After Fix

@dotnet-policy-service
Copy link
Contributor

Hey there @@HarishwaranVijayakumar! Thank you so much for your PR! Someone from the team will get assigned to your PR shortly and we'll get it reviewed.

@dotnet-policy-service dotnet-policy-service bot added community ✨ Community Contribution partner/syncfusion Issues / PR's with Syncfusion collaboration labels Jul 2, 2025
@jsuarezruiz jsuarezruiz added the area-gestures Gesture types label Jul 2, 2025
@HarishwaranVijayakumar HarishwaranVijayakumar marked this pull request as ready for review July 2, 2025 12:16
@Copilot Copilot AI review requested due to automatic review settings July 2, 2025 12:16
@HarishwaranVijayakumar HarishwaranVijayakumar requested a review from a team as a code owner July 2, 2025 12:16
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR fixes the issue where TapGestureRecognizer.Buttons was not being passed through to TappedEventArgs, so the event args always returned 0. It also adds visibility into the change with new UI tests.

  • Added an internal constructor in TappedEventArgs to accept and set a ButtonsMask value
  • Updated TapGestureRecognizer.SendTapped to pass the current Buttons value into the new constructor
  • Introduced both Shared.Tests and HostApp UI tests to verify that the correct button mask is returned

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.

File Description
src/Controls/src/Core/TappedEventArgs.cs Added new internal ctor parameter for ButtonsMask and set property
src/Controls/src/Core/TapGestureRecognizer.cs Passed Buttons into TappedEventArgs when raising the event
src/Controls/tests/TestCases.Shared.Tests/Tests/Issues/Issue24734.cs New UI test to tap the label and verify the button mask is non-zero
src/Controls/tests/TestCases.HostApp/Issues/Issue24734.cs Host sample page for manual testing of the ButtonsMask behavior
Comments suppressed due to low confidence (1)

src/Controls/tests/TestCases.Shared.Tests/Tests/Issues/Issue24734.cs:5

  • [nitpick] The namespace Microsoft.Maui.TestCases.Tests.Issues doesn’t reflect the TestCases.Shared.Tests project structure. Consider renaming it to something like Microsoft.Maui.TestCases.Shared.Tests.Issues for consistency.
namespace Microsoft.Maui.TestCases.Tests.Issues;

@jsuarezruiz
Copy link
Contributor

/azp run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 3 pipeline(s).

@PureWeen PureWeen changed the base branch from main to inflight/current July 3, 2025 17:18
@PureWeen PureWeen merged commit e5d066f into dotnet:inflight/current Jul 3, 2025
129 checks passed
github-actions bot pushed a commit that referenced this pull request Jul 8, 2025
* Fix for TapGesture ButtonMask

* Added TestCase

* Update Testcase

* Modified Testcase
github-actions bot pushed a commit that referenced this pull request Jul 9, 2025
* Fix for TapGesture ButtonMask

* Added TestCase

* Update Testcase

* Modified Testcase
PureWeen pushed a commit that referenced this pull request Jul 10, 2025
* Fix for TapGesture ButtonMask

* Added TestCase

* Update Testcase

* Modified Testcase
PureWeen pushed a commit that referenced this pull request Jul 15, 2025
* Fix for TapGesture ButtonMask

* Added TestCase

* Update Testcase

* Modified Testcase
PureWeen pushed a commit that referenced this pull request Jul 17, 2025
* Fix for TapGesture ButtonMask

* Added TestCase

* Update Testcase

* Modified Testcase
github-actions bot pushed a commit that referenced this pull request Jul 25, 2025
* Fix for TapGesture ButtonMask

* Added TestCase

* Update Testcase

* Modified Testcase
github-actions bot pushed a commit that referenced this pull request Jul 31, 2025
* Fix for TapGesture ButtonMask

* Added TestCase

* Update Testcase

* Modified Testcase
rmarinho pushed a commit that referenced this pull request Aug 1, 2025
* Added sample for GraphicsView

* Added the feature matrix code

* Added the test cases for the GraphicsView

* Updated the GraphicsViewFeaturetests

* Updated the GraphicsViewViewModel

* Addressed the feedbacks

* Added the snapshots for Mac and Windows

* Remove .NET 8 specific code for templates (#30342)

* [Catalyst] Fix Scrollbar does not align with FlowDirection change in ScrollView (#30241)

* fix added

* Revert "fix added"

This reverts commit 138797f.

* fix added

* fix updated

* [Android] Fix for OnSizeAllocated is not reported for Android AppShell Flyout content. (#30069)

* fix-22045 - Made changes on Android ShellFlyout sizing by adding OnDrawerOpened event and updating Content so OnSizeAllocated is called with correct values when drawer opens.

* fix-22045- Set the contentview frame value when the FlyoutView layout change.

* fix-22045- Changes committed.

* Permissions (BT & WiFi): don't add AccessFineLocation to required permissions if NeverForLocation flag is present (#20874)

* otherwise the permission-status will be 'denied' if AccessFineLocation is in the manifest, but denied at runtime
  (even if it is not strictly required)

* Fixed the RealParent Warning shown issue (#30156)

* Safe Get of RealParent to avoid warnings

* Optimized the fix

* Make it as default private

* Optimized the fix

* Modified the fix and added test

* Modified the fix based on concern and added test

* unwanted spacing

* Replaced the Parent property directly

* [iOS/MacCatalyst] Fix: Setting SelectedItem Programmatically and Then Immediately Setting ItemsSource to Null Causes a Crash (#29940)

* Re-evaluate indexpaths in PerformBatchUpdates

* Add UI test

* update test

* bring back null check

* add a check to see if ItemsSource is disposed

* [Windows] Fixed StackLayout crashes on Windows with HeightRequest as 0 (#29926)

* Fixed StackLayout crashes on Windows with HeightRequest 0, padding, and opposing alignment.

* Included test case for Vertical StackLayout

* Updated label content

* [Windows] Fixed CanvasDrawingSession Exception on Clipping Image (#30028)

* [Windows] Fixed CanvasDrawingSession Exception

* Update in description label

* Updated Suggested Changes

* [Testing] Feature matrix UITest Cases for ScrollView Control (#30188)

* Added Feature Matrix for ScrollView

* Updated changes

* Changes updated

* Modified the test cases

* Modified UI

* Added snapshots

* Added images

* Modified Test Case

* Added images

* Resaved images

* [Testing] Feature Matrix UITest Cases for TimePicker Control  (#30271)

* modified UI and test cases

* updated test cases

* added new test cases

* updated test cases

* added android and iOS snapshots

* updated format

* updated flow direction code

* added mac and windows snapshots

* updated iOS snapshots

* [Catalyst] Adding and Removing ContextMenus currently does not work - fix (#30307)

* Disconnect context flyout handler

* Update MenuFlyoutHandler.iOS.cs

* Fix for TapGestureRecognizer ButtonMask always return 0 (#30372)

* Fix for TapGesture ButtonMask

* Added TestCase

* Update Testcase

* Modified Testcase

* fix extention typo (#30461)

* fix some incorrect casting using `as` (#30459)

if the type is known then a direct cast should be used instead of an as.
since, in the case where the assumption is wrong, then it is better to
get a cast exception instead of a null ref exception.

basically if code uses `as` and does not check for null when that
variable is used, then it is likely problematic code.

* [Testing] Feature Matrix UITest Cases for SearchBar Control  (#30398)

* added test cases

* added snapshots

* comment added

* snapshot added

* changed method name

* [Testing] Feature Matrix UITest Cases for DatePicker Control (#30159)

* added test cases

* added new test cases

* removed test cases

* updated test cases

* updated test cases

* changes in test case

* added new event

* updated test cases

* added culture test cases

* added snapshots

* added the failing condition

* modified test case

* added new test case code

* added mac and windows snapshots

* [create-pull-request] automated change (#30591)

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
# Conflicts:
#	src/Compatibility/Core/src/Tizen/Forms.cs

* [Testing] Add UITest for Issue30147 on iOS (#30506)

* fix added

* Revert "fix added"

This reverts commit 138797f.

* test case added

* test sample modified

* test sample updated

* affected platform changed

* sample changes added

* [Android] Fix for Search Handler visual and functional bug in subtabs (#30467)

* fix-21119-Made changes to ShellToolbarTracker.cs to prevent search handler stacking on Android Shell tab navigation by removing existing menu items before adding new ones.

* fix-21119-Testcase and test snapshot added.

* fix-21119-Updated code changes. Also added Mac and Windows snapshots.

* [Windows] Fixed the Pasted Password Becomes Visible When IsPassword Is Enabled (#30353)

* Fixed the masked text issue of same value pasted into the textbox field

* Added the test for verifying the masked text

* [create-pull-request] automated change (#30700)

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* Fixed GraphicsView event handlers are triggered even when IsEnabled is set to False  (#30755)

* Fixed GraphicsView event handlers are triggered even when IsEnabled is set to False

* Updated PlatformTouchGraphicsView

* Updated test sample

* Fix duplicate app icon resizing (#30920)

Possibly helps with #30900

* Addressed the feedbacks

* Added sample for GraphicsView

* Added the feature matrix code

* Added the test cases for the GraphicsView

* Updated the GraphicsViewFeaturetests

* Updated the GraphicsViewViewModel

* Addressed the feedbacks

* Added the snapshots for Mac and Windows

* Addressed the feedbacks

---------

Co-authored-by: Gerald Versluis <gerald.versluis@microsoft.com>
Co-authored-by: devanathan-vaithiyanathan <114395405+devanathan-vaithiyanathan@users.noreply.github.com>
Co-authored-by: BagavathiPerumal <93652794+BagavathiPerumal@users.noreply.github.com>
Co-authored-by: Janus Weil <janus@gcc.gnu.org>
Co-authored-by: Ahamed-Ali <102580874+Ahamed-Ali@users.noreply.github.com>
Co-authored-by: Bhavanesh N <bhavanesh001@gmail.com>
Co-authored-by: Dhivya-SF4094 <127717131+Dhivya-SF4094@users.noreply.github.com>
Co-authored-by: Subhiksha Chandrasekaran <subhiksha.c@syncfusion.com>
Co-authored-by: NafeelaNazhir <nafeela.nazhirhussain@syncfusion.com>
Co-authored-by: TamilarasanSF4853 <tamilarasan.velu@syncfusion.com>
Co-authored-by: Jakub Florkowski <42434498+kubaflo@users.noreply.github.com>
Co-authored-by: HarishwaranVijayakumar <harishwaran.vijayakumar@syncfusion.com>
Co-authored-by: Simon Cropp <simon.cropp@gmail.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Shane Neuville <shneuvil@microsoft.com>
Co-authored-by: Jeremy Powell <47993233+jeremy-visionaid@users.noreply.github.com>
PureWeen pushed a commit that referenced this pull request Aug 1, 2025
* Fix for TapGesture ButtonMask

* Added TestCase

* Update Testcase

* Modified Testcase
PureWeen pushed a commit that referenced this pull request Aug 1, 2025
* Fix for TapGesture ButtonMask

* Added TestCase

* Update Testcase

* Modified Testcase
PureWeen added a commit that referenced this pull request Aug 1, 2025
* Added sample for GraphicsView

* Added the feature matrix code

* Added the test cases for the GraphicsView

* Updated the GraphicsViewFeaturetests

* Updated the GraphicsViewViewModel

* Addressed the feedbacks

* Added the snapshots for Mac and Windows

* Remove .NET 8 specific code for templates (#30342)

* [Catalyst] Fix Scrollbar does not align with FlowDirection change in ScrollView (#30241)

* fix added

* Revert "fix added"

This reverts commit 138797f.

* fix added

* fix updated

* [Android] Fix for OnSizeAllocated is not reported for Android AppShell Flyout content. (#30069)

* fix-22045 - Made changes on Android ShellFlyout sizing by adding OnDrawerOpened event and updating Content so OnSizeAllocated is called with correct values when drawer opens.

* fix-22045- Set the contentview frame value when the FlyoutView layout change.

* fix-22045- Changes committed.

* Permissions (BT & WiFi): don't add AccessFineLocation to required permissions if NeverForLocation flag is present (#20874)

* otherwise the permission-status will be 'denied' if AccessFineLocation is in the manifest, but denied at runtime
  (even if it is not strictly required)

* Fixed the RealParent Warning shown issue (#30156)

* Safe Get of RealParent to avoid warnings

* Optimized the fix

* Make it as default private

* Optimized the fix

* Modified the fix and added test

* Modified the fix based on concern and added test

* unwanted spacing

* Replaced the Parent property directly

* [iOS/MacCatalyst] Fix: Setting SelectedItem Programmatically and Then Immediately Setting ItemsSource to Null Causes a Crash (#29940)

* Re-evaluate indexpaths in PerformBatchUpdates

* Add UI test

* update test

* bring back null check

* add a check to see if ItemsSource is disposed

* [Windows] Fixed StackLayout crashes on Windows with HeightRequest as 0 (#29926)

* Fixed StackLayout crashes on Windows with HeightRequest 0, padding, and opposing alignment.

* Included test case for Vertical StackLayout

* Updated label content

* [Windows] Fixed CanvasDrawingSession Exception on Clipping Image (#30028)

* [Windows] Fixed CanvasDrawingSession Exception

* Update in description label

* Updated Suggested Changes

* [Testing] Feature matrix UITest Cases for ScrollView Control (#30188)

* Added Feature Matrix for ScrollView

* Updated changes

* Changes updated

* Modified the test cases

* Modified UI

* Added snapshots

* Added images

* Modified Test Case

* Added images

* Resaved images

* [Testing] Feature Matrix UITest Cases for TimePicker Control  (#30271)

* modified UI and test cases

* updated test cases

* added new test cases

* updated test cases

* added android and iOS snapshots

* updated format

* updated flow direction code

* added mac and windows snapshots

* updated iOS snapshots

* [Catalyst] Adding and Removing ContextMenus currently does not work - fix (#30307)

* Disconnect context flyout handler

* Update MenuFlyoutHandler.iOS.cs

* Fix for TapGestureRecognizer ButtonMask always return 0 (#30372)

* Fix for TapGesture ButtonMask

* Added TestCase

* Update Testcase

* Modified Testcase

* fix extention typo (#30461)

* fix some incorrect casting using `as` (#30459)

if the type is known then a direct cast should be used instead of an as.
since, in the case where the assumption is wrong, then it is better to
get a cast exception instead of a null ref exception.

basically if code uses `as` and does not check for null when that
variable is used, then it is likely problematic code.

* [Testing] Feature Matrix UITest Cases for SearchBar Control  (#30398)

* added test cases

* added snapshots

* comment added

* snapshot added

* changed method name

* [Testing] Feature Matrix UITest Cases for DatePicker Control (#30159)

* added test cases

* added new test cases

* removed test cases

* updated test cases

* updated test cases

* changes in test case

* added new event

* updated test cases

* added culture test cases

* added snapshots

* added the failing condition

* modified test case

* added new test case code

* added mac and windows snapshots

* [create-pull-request] automated change (#30591)

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
# Conflicts:
#	src/Compatibility/Core/src/Tizen/Forms.cs

* [Testing] Add UITest for Issue30147 on iOS (#30506)

* fix added

* Revert "fix added"

This reverts commit 138797f.

* test case added

* test sample modified

* test sample updated

* affected platform changed

* sample changes added

* [Android] Fix for Search Handler visual and functional bug in subtabs (#30467)

* fix-21119-Made changes to ShellToolbarTracker.cs to prevent search handler stacking on Android Shell tab navigation by removing existing menu items before adding new ones.

* fix-21119-Testcase and test snapshot added.

* fix-21119-Updated code changes. Also added Mac and Windows snapshots.

* [Windows] Fixed the Pasted Password Becomes Visible When IsPassword Is Enabled (#30353)

* Fixed the masked text issue of same value pasted into the textbox field

* Added the test for verifying the masked text

* [create-pull-request] automated change (#30700)

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* Fixed GraphicsView event handlers are triggered even when IsEnabled is set to False  (#30755)

* Fixed GraphicsView event handlers are triggered even when IsEnabled is set to False

* Updated PlatformTouchGraphicsView

* Updated test sample

* Fix duplicate app icon resizing (#30920)

Possibly helps with #30900

* Addressed the feedbacks

* Added sample for GraphicsView

* Added the feature matrix code

* Added the test cases for the GraphicsView

* Updated the GraphicsViewFeaturetests

* Updated the GraphicsViewViewModel

* Addressed the feedbacks

* Added the snapshots for Mac and Windows

* Addressed the feedbacks

---------

Co-authored-by: Gerald Versluis <gerald.versluis@microsoft.com>
Co-authored-by: devanathan-vaithiyanathan <114395405+devanathan-vaithiyanathan@users.noreply.github.com>
Co-authored-by: BagavathiPerumal <93652794+BagavathiPerumal@users.noreply.github.com>
Co-authored-by: Janus Weil <janus@gcc.gnu.org>
Co-authored-by: Ahamed-Ali <102580874+Ahamed-Ali@users.noreply.github.com>
Co-authored-by: Bhavanesh N <bhavanesh001@gmail.com>
Co-authored-by: Dhivya-SF4094 <127717131+Dhivya-SF4094@users.noreply.github.com>
Co-authored-by: Subhiksha Chandrasekaran <subhiksha.c@syncfusion.com>
Co-authored-by: NafeelaNazhir <nafeela.nazhirhussain@syncfusion.com>
Co-authored-by: TamilarasanSF4853 <tamilarasan.velu@syncfusion.com>
Co-authored-by: Jakub Florkowski <42434498+kubaflo@users.noreply.github.com>
Co-authored-by: HarishwaranVijayakumar <harishwaran.vijayakumar@syncfusion.com>
Co-authored-by: Simon Cropp <simon.cropp@gmail.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Shane Neuville <shneuvil@microsoft.com>
Co-authored-by: Jeremy Powell <47993233+jeremy-visionaid@users.noreply.github.com>
PureWeen pushed a commit that referenced this pull request Aug 1, 2025
* Fix for TapGesture ButtonMask

* Added TestCase

* Update Testcase

* Modified Testcase
@github-actions github-actions bot locked and limited conversation to collaborators Aug 3, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

area-gestures Gesture types community ✨ Community Contribution partner/syncfusion Issues / PR's with Syncfusion collaboration

Projects

None yet

Development

Successfully merging this pull request may close these issues.

TapGestureRecognizer ButtonMask always return 0.

3 participants