File: System\Windows\Forms\AccessibleObjects\ButtonBase.ButtonBaseAccessibleObjectTests.cs
Web Access
Project: src\src\System.Windows.Forms\tests\UnitTests\System.Windows.Forms.Tests.csproj (System.Windows.Forms.Tests)
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
 
using Windows.Win32.System.Variant;
using Windows.Win32.UI.Accessibility;
 
namespace System.Windows.Forms.Tests.AccessibleObjects;
 
public class ButtonBase_ButtonBaseAccessibleObjectTests
{
    [WinFormsFact]
    public void ButtonBaseAccessibleObject_Ctor_NullControl_ThrowsArgumentException()
    {
        Assert.Throws<ArgumentException>(() => new ButtonBase.ButtonBaseAccessibleObject(null));
    }
 
    [WinFormsFact]
    public void ButtonBaseAccessibleObject_Ctor_InvalidTypeControl_ThrowsArgumentException()
    {
        using TextBox textBox = new();
        Assert.Throws<ArgumentException>(() => new ButtonBase.ButtonBaseAccessibleObject(textBox));
    }
 
    [WinFormsTheory]
    [InlineData(FlatStyle.Flat, true, true, AccessibleStates.Focusable | AccessibleStates.Pressed)]
    [InlineData(FlatStyle.Flat, false, true, AccessibleStates.None)]
    [InlineData(FlatStyle.Flat, true, false, AccessibleStates.Focusable)]
    [InlineData(FlatStyle.Flat, false, false, AccessibleStates.None)]
    [InlineData(FlatStyle.Popup, true, true, AccessibleStates.Focusable | AccessibleStates.Pressed)]
    [InlineData(FlatStyle.Popup, false, true, AccessibleStates.None)]
    [InlineData(FlatStyle.Popup, true, false, AccessibleStates.Focusable)]
    [InlineData(FlatStyle.Popup, false, false, AccessibleStates.None)]
    [InlineData(FlatStyle.Standard, true, true, AccessibleStates.Focusable | AccessibleStates.Pressed)]
    [InlineData(FlatStyle.Standard, false, true, AccessibleStates.None)]
    [InlineData(FlatStyle.Standard, true, false, AccessibleStates.Focusable)]
    [InlineData(FlatStyle.Standard, false, false, AccessibleStates.None)]
    [InlineData(FlatStyle.System, true, true, AccessibleStates.Focusable)]
    [InlineData(FlatStyle.System, false, true, AccessibleStates.None)]
    [InlineData(FlatStyle.System, true, false, AccessibleStates.Focusable)]
    [InlineData(FlatStyle.System, false, false, AccessibleStates.None)]
    public void ButtonBaseAccessibleObject_State_is_correct(FlatStyle flatStyle, bool createControl, bool mouseIsDown, AccessibleStates expectedAccessibleState)
    {
        using SubButtonBase button = new()
        {
            FlatStyle = flatStyle
        };
 
        if (createControl)
        {
            button.CreateControl();
        }
 
        Assert.Equal(createControl, button.IsHandleCreated);
 
        if (mouseIsDown)
        {
            button.OnMouseDown(new MouseEventArgs(MouseButtons.Left, 1, 0, 0, 0));
        }
 
        var buttonBaseAccessibleObject = new ButtonBase.ButtonBaseAccessibleObject(button);
 
        Assert.Equal(expectedAccessibleState, buttonBaseAccessibleObject.State);
        Assert.Equal(createControl, button.IsHandleCreated);
    }
 
    [WinFormsTheory]
    [InlineData(true, true, AccessibleRole.Client)]
    [InlineData(true, false, AccessibleRole.HelpBalloon)]
    [InlineData(false, true, AccessibleRole.None)]
    [InlineData(false, false, AccessibleRole.HelpBalloon)]
    public void ButtonBase_CreateAccessibilityInstance_InvokeWithRole_ReturnsExpected(bool createControl, bool defaultRole, AccessibleRole expectedAccessibleRole)
    {
        using SubButtonBase control = new();
 
        if (!defaultRole)
        {
            control.AccessibleRole = AccessibleRole.HelpBalloon;
        }
 
        if (createControl)
        {
            control.CreateControl();
        }
 
        Assert.Equal(createControl, control.IsHandleCreated);
 
        ButtonBase.ButtonBaseAccessibleObject instance = Assert.IsType<ButtonBase.ButtonBaseAccessibleObject>(control.CreateAccessibilityInstance());
 
        Assert.NotNull(instance);
        Assert.Same(control, instance.Owner);
        Assert.Equal(expectedAccessibleRole, instance.Role);
        Assert.NotSame(control.CreateAccessibilityInstance(), instance);
        Assert.NotSame(control.AccessibilityObject, instance);
        Assert.Equal(createControl, control.IsHandleCreated);
    }
 
    [WinFormsTheory]
    [EnumData<FlatStyle>]
    public void ButtonBase_CreateAccessibilityInstance_InvokeWithDefaultRole_ReturnsExpected_ForAllFlatStyles_IfControlIsCreated(FlatStyle flatStyle)
    {
        using SubButtonBase control = new()
        {
            FlatStyle = flatStyle
        };
        control.CreateControl();
        ButtonBase.ButtonBaseAccessibleObject instance = Assert.IsType<ButtonBase.ButtonBaseAccessibleObject>(control.CreateAccessibilityInstance());
        Assert.Equal(AccessibleRole.Client, instance.Role);
        Assert.True(control.IsHandleCreated);
    }
 
    [WinFormsTheory]
    [EnumData<FlatStyle>]
    public void ButtonBase_CreateAccessibilityInstance_InvokeWithDefaultRole_ReturnsNone_ForAllFlatStyles_IfControlIsNotCreated(FlatStyle flatStyle)
    {
        using SubButtonBase control = new()
        {
            FlatStyle = flatStyle
        };
 
        Assert.False(control.IsHandleCreated);
 
        ButtonBase.ButtonBaseAccessibleObject instance = Assert.IsType<ButtonBase.ButtonBaseAccessibleObject>(control.CreateAccessibilityInstance());
        Assert.Equal(AccessibleRole.None, instance.Role);
        Assert.False(control.IsHandleCreated);
    }
 
    [WinFormsTheory]
    [InlineData(true)]
    [InlineData(false)]
    public void ButtonBase_CreateAccessibilityInstance_InvokeDoDefaultAction_CallsOnClick(bool createControl)
    {
        using SubButtonBase control = new();
 
        if (createControl)
        {
            control.CreateControl();
        }
 
        Assert.Equal(createControl, control.IsHandleCreated);
 
        int callCount = 0;
        control.Click += (sender, e) =>
        {
            Assert.Same(control, sender);
            Assert.Same(EventArgs.Empty, e);
            callCount++;
        };
 
        var buttonBaseAccessibleObject = new ButtonBase.ButtonBaseAccessibleObject(control);
        buttonBaseAccessibleObject.DoDefaultAction();
 
        Assert.Equal(createControl ? 1 : 0, callCount);
        Assert.Equal(createControl, control.IsHandleCreated);
    }
 
    [WinFormsTheory]
    [InlineData(true, 1)]
    [InlineData(false, 0)]
    public void ButtonBase_CreateAccessibilityInstance_InvokeIButtonControlDoDefaultAction_CallsOnClick(bool createControl, int expectedCallCount)
    {
        using SubButtonBase control = new();
 
        if (createControl)
        {
            control.CreateControl();
        }
 
        int callCount = 0;
        control.Click += (sender, e) =>
        {
            Assert.Same(control, sender);
            Assert.Same(EventArgs.Empty, e);
            callCount++;
        };
        int performClickCallCount = 0;
        control.PerformClickAction = () => performClickCallCount++;
        var buttonBaseAccessibleObject = new ButtonBase.ButtonBaseAccessibleObject(control);
 
        buttonBaseAccessibleObject.DoDefaultAction();
 
        Assert.Equal(expectedCallCount, callCount);
        Assert.Equal(0, performClickCallCount);
        Assert.Equal(createControl, control.IsHandleCreated);
    }
 
    [WinFormsTheory]
    [InlineData(true, AccessibleRole.Client)]
    [InlineData(false, AccessibleRole.None)]
    public void ButtonBaseBoxAccessibleObject_ControlType_IsPane_IfAccessibleRoleIsDefault(bool createControl, AccessibleRole expectedRole)
    {
        using ButtonBase buttonBase = new SubButtonBase();
        // AccessibleRole is not set = Default
 
        if (createControl)
        {
            buttonBase.CreateControl();
        }
 
        AccessibleObject accessibleObject = buttonBase.AccessibilityObject;
        VARIANT actual = accessibleObject.GetPropertyValue(UIA_PROPERTY_ID.UIA_ControlTypePropertyId);
 
        Assert.Equal(expectedRole, accessibleObject.Role);
        Assert.Equal(UIA_CONTROLTYPE_ID.UIA_PaneControlTypeId, (UIA_CONTROLTYPE_ID)(int)actual);
        Assert.Equal(createControl, buttonBase.IsHandleCreated);
    }
 
    public static IEnumerable<object[]> ButtonBaseAccessibleObject_GetPropertyValue_ControlType_IsExpected_ForCustomRole_TestData()
    {
        Array roles = Enum.GetValues(typeof(AccessibleRole));
 
        foreach (AccessibleRole role in roles)
        {
            if (role == AccessibleRole.Default)
            {
                continue; // The test checks custom roles
            }
 
            yield return new object[] { role };
        }
    }
 
    [WinFormsTheory]
    [MemberData(nameof(ButtonBaseAccessibleObject_GetPropertyValue_ControlType_IsExpected_ForCustomRole_TestData))]
    public void ButtonBaseAccessibleObject_GetPropertyValue_ControlType_IsExpected_ForCustomRole(AccessibleRole role)
    {
        using ButtonBase buttonBase = new SubButtonBase();
        buttonBase.AccessibleRole = role;
 
        VARIANT actual = buttonBase.AccessibilityObject.GetPropertyValue(UIA_PROPERTY_ID.UIA_ControlTypePropertyId);
        UIA_CONTROLTYPE_ID expected = AccessibleRoleControlTypeMap.GetControlType(role);
 
        Assert.Equal(expected, (UIA_CONTROLTYPE_ID)(int)actual);
        Assert.False(buttonBase.IsHandleCreated);
    }
 
    [WinFormsFact]
    public void ButtonBaseAccessibleObject_GetPropertyValue_AutomationId_ReturnsExpected()
    {
        using SubButtonBase ownerControl = new() { Name = "test name" };
        string expected = ownerControl.Name;
        using VARIANT actual = ownerControl.AccessibilityObject.GetPropertyValue(UIA_PROPERTY_ID.UIA_AutomationIdPropertyId);
 
        Assert.Equal(expected, ((BSTR)actual).ToString());
        Assert.False(ownerControl.IsHandleCreated);
    }
 
    [WinFormsFact]
    public void ButtonBaseAccessibleObject_TextChanged_AutomationPropertyChanged_Raised()
    {
        const string newText = "New text";
        using ButtonWithCustomAccessibleObject control = new(
            (propertyId, value) => propertyId == UIA_PROPERTY_ID.UIA_NamePropertyId && newText.Equals(value.ToObject()))
        {
            Text = "Text"
        };
 
        var accessibilityObject = control.AccessibilityObject as ControlAccessibleObjectWithNotificationCounter;
        Assert.NotNull(accessibilityObject);
        Assert.True(control.IsAccessibilityObjectCreated);
        Assert.Equal(0, accessibilityObject.RaiseAutomationNotificationCallCount);
 
        control.Text = newText;
 
        Assert.Equal(1, accessibilityObject.RaiseAutomationNotificationCallCount);
    }
 
    private class SubButtonBase : ButtonBase
    {
        public Action PerformClickAction { get; set; }
 
        public new AccessibleObject CreateAccessibilityInstance() => base.CreateAccessibilityInstance();
 
        public new void OnMouseDown(MouseEventArgs e) => base.OnMouseDown(e);
 
        public void PerformClick() => PerformClickAction();
    }
 
    private class ButtonWithCustomAccessibleObject : ButtonBase
    {
        private readonly Func<UIA_PROPERTY_ID, VARIANT, bool> _checkRaisedEvent;
 
        public ButtonWithCustomAccessibleObject(Func<UIA_PROPERTY_ID, VARIANT, bool> checkRaisedEvent)
        {
            _checkRaisedEvent = checkRaisedEvent;
        }
 
        protected override AccessibleObject CreateAccessibilityInstance() => new ControlAccessibleObjectWithNotificationCounter(this, _checkRaisedEvent);
    }
 
    private class ControlAccessibleObjectWithNotificationCounter : Control.ControlAccessibleObject
    {
        private readonly Func<UIA_PROPERTY_ID, VARIANT, bool> _checkRaisedEvent;
 
        public ControlAccessibleObjectWithNotificationCounter(Control ownerControl, Func<UIA_PROPERTY_ID, VARIANT, bool> checkRaisedEvent) : base(ownerControl)
        {
            _checkRaisedEvent = checkRaisedEvent;
        }
        
        internal int RaiseAutomationNotificationCallCount { get; private set; }
 
        internal override bool RaiseAutomationPropertyChangedEvent(UIA_PROPERTY_ID propertyId, VARIANT oldValue, VARIANT newValue)
        {
            if (_checkRaisedEvent(propertyId, newValue))
            {
                RaiseAutomationNotificationCallCount++;
            }
 
            return base.RaiseAutomationPropertyChangedEvent(propertyId, oldValue, newValue);
        }
    }
}