Skip to content

Add support UIA provider for CheckedListBox control #5276

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 1, 2021
Merged

Add support UIA provider for CheckedListBox control #5276

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
116 changes: 4 additions & 112 deletions ...m.Windows.Forms/src/System/Windows/Forms/CheckedListBox.CheckedListBoxAccessibleObject.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,125 +2,17 @@
// The .NET Foundation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.

#nullable disable

namespace System.Windows.Forms
{
public partial class CheckedListBox
{
internal class CheckedListBoxAccessibleObject : ControlAccessibleObject
internal class CheckedListBoxAccessibleObject : ListBoxAccessibleObject
{
public CheckedListBoxAccessibleObject(CheckedListBox owner) : base(owner)
{
}

private CheckedListBox CheckedListBox
{
get
{
return (CheckedListBox)Owner;
}
}

public override AccessibleObject GetChild(int index)
{
if (index >= 0 && index < CheckedListBox.Items.Count)
{
return new CheckedListBoxItemAccessibleObject(CheckedListBox.GetItemText(CheckedListBox.Items[index]), index, this);
}
else
{
return null;
}
}

public override int GetChildCount()
{
return CheckedListBox.Items.Count;
}

public override AccessibleObject GetFocused()
{
if (!CheckedListBox.IsHandleCreated)
{
return null;
}

int index = CheckedListBox.FocusedIndex;

if (index >= 0)
{
return GetChild(index);
}

return null;
}

public override AccessibleObject GetSelected()
{
if (!CheckedListBox.IsHandleCreated)
{
return null;
}

int index = CheckedListBox.SelectedIndex;

if (index >= 0)
{
return GetChild(index);
}

return null;
}

public override AccessibleObject HitTest(int x, int y)
{
if (!CheckedListBox.IsHandleCreated)
{
return null;
}

// Within a child element?
//
int count = GetChildCount();

for (int index = 0; index < count; ++index)
{
AccessibleObject child = GetChild(index);

if (child.Bounds.Contains(x, y))
{
return child;
}
}

// Within the CheckedListBox bounds?
//
if (Bounds.Contains(x, y))
{
return this;
}

return null;
}

public override AccessibleObject Navigate(AccessibleNavigation direction)
{
if (GetChildCount() > 0)
{
if (direction == AccessibleNavigation.FirstChild)
{
return GetChild(0);
}

if (direction == AccessibleNavigation.LastChild)
{
return GetChild(GetChildCount() - 1);
}
}
{ }

return base.Navigate(direction);
}
private protected override ListBoxItemAccessibleObject CreateItemAccessibleObject(ListBox listBox, ItemArray.Entry item)
=> new CheckedListBoxItemAccessibleObject((CheckedListBox)listBox, item, this);
}
}
}
193 changes: 46 additions & 147 deletions ...ndows.Forms/src/System/Windows/Forms/CheckedListBox.CheckedListBoxItemAccessibleObject.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,129 +2,87 @@
// The .NET Foundation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.

#nullable disable

using System.Drawing;
using static Interop;

namespace System.Windows.Forms
{
public partial class CheckedListBox
{
internal class CheckedListBoxItemAccessibleObject : AccessibleObject
internal class CheckedListBoxItemAccessibleObject : ListBoxItemAccessibleObject
{
private string _name;
private readonly int _index;
private readonly CheckedListBoxAccessibleObject _parent;
private readonly CheckedListBox _owningCheckedListBox;

public CheckedListBoxItemAccessibleObject(string name, int index, CheckedListBoxAccessibleObject parent) : base()
public CheckedListBoxItemAccessibleObject(CheckedListBox owningCheckedListBox, ItemArray.Entry item, CheckedListBoxAccessibleObject owningAccessibleObject) : base(owningCheckedListBox, item, owningAccessibleObject)
{
_name = name;
_parent = parent;
_index = index;
}

public override Rectangle Bounds
{
get
{
if (!ParentCheckedListBox.IsHandleCreated)
{
return Rectangle.Empty;
}

Rectangle rect = ParentCheckedListBox.GetItemRectangle(_index);

if (rect.IsEmpty)
{
return rect;
}

// Translate rect to screen coordinates
//
rect = ParentCheckedListBox.RectangleToScreen(rect);
Rectangle visibleArea = ParentCheckedListBox.RectangleToScreen(ParentCheckedListBox.ClientRectangle);

if (visibleArea.Bottom < rect.Bottom)
{
rect.Height = visibleArea.Bottom - rect.Top;
}

rect.Width = visibleArea.Width;

return rect;
}
_owningCheckedListBox = owningCheckedListBox;
}

public override string DefaultAction
{
get
{
if (!ParentCheckedListBox.IsHandleCreated)
if (!_owningCheckedListBox.IsHandleCreated)
{
return string.Empty;
}

if (ParentCheckedListBox.GetItemChecked(_index))
{
return SR.AccessibleActionUncheck;
}
else
{
return SR.AccessibleActionCheck;
}
return IsItemChecked ? SR.AccessibleActionUncheck : SR.AccessibleActionCheck;
}
}

private CheckedListBox ParentCheckedListBox
public override void DoDefaultAction()
{
get
if (!_owningCheckedListBox.IsHandleCreated)
{
return (CheckedListBox)_parent.Owner;
return;
}
}

public override string Name
{
get
{
return _name;
}
set
{
_name = value;
}
_owningCheckedListBox.SetItemChecked(CurrentIndex, !IsItemChecked);
}

public override AccessibleObject Parent
{
get
internal override object? GetPropertyValue(UiaCore.UIA propertyID)
=> propertyID switch
{
return _parent;
}
}

public override AccessibleRole Role
{
get
UiaCore.UIA.ControlTypePropertyId => UiaCore.UIA.CheckBoxControlTypeId,
UiaCore.UIA.IsInvokePatternAvailablePropertyId => IsPatternSupported(UiaCore.UIA.InvokePatternId),
UiaCore.UIA.IsLegacyIAccessiblePatternAvailablePropertyId => IsPatternSupported(UiaCore.UIA.LegacyIAccessiblePatternId),
UiaCore.UIA.IsTogglePatternAvailablePropertyId => IsPatternSupported(UiaCore.UIA.TogglePatternId),
UiaCore.UIA.IsValuePatternAvailablePropertyId => IsPatternSupported(UiaCore.UIA.ValuePatternId),
UiaCore.UIA.ValueValuePropertyId => Value,
_ => base.GetPropertyValue(propertyID)
};

private bool IsItemChecked => _owningCheckedListBox.GetItemChecked(CurrentIndex);

internal override bool IsPatternSupported(UiaCore.UIA patternId)
=> patternId switch
{
return AccessibleRole.CheckButton;
}
}
UiaCore.UIA.InvokePatternId => true,
UiaCore.UIA.TogglePatternId => true,
UiaCore.UIA.ValuePatternId => true,
_ => base.IsPatternSupported(patternId)
};

public override AccessibleRole Role => AccessibleRole.CheckButton;

public override AccessibleStates State
{
get
{
if (!ParentCheckedListBox.IsHandleCreated)
if (!_owningCheckedListBox.IsHandleCreated)
{
return AccessibleStates.None;
}

AccessibleStates state = AccessibleStates.Selectable | AccessibleStates.Focusable;

if (!Parent.BoundingRectangle.IntersectsWith(Bounds))
{
state |= AccessibleStates.Offscreen;
}

// Checked state
//
switch (ParentCheckedListBox.GetItemCheckState(_index))
switch (_owningCheckedListBox.GetItemCheckState(CurrentIndex))
{
case CheckState.Checked:
state |= AccessibleStates.Checked;
Expand All @@ -138,13 +96,12 @@ public override AccessibleStates State
}

// Selected state
//
if (ParentCheckedListBox.SelectedIndex == _index)
if (_owningCheckedListBox.SelectedIndex == CurrentIndex)
{
state |= AccessibleStates.Selected | AccessibleStates.Focused;
}

if (ParentCheckedListBox.Focused && ParentCheckedListBox.SelectedIndex == -1)
if (_owningCheckedListBox.Focused && _owningCheckedListBox.SelectedIndex == -1)
{
state |= AccessibleStates.Focused;
}
Expand All @@ -153,70 +110,12 @@ public override AccessibleStates State
}
}

public override string Value
{
get
{
return ParentCheckedListBox.GetItemChecked(_index).ToString();
}
}

public override void DoDefaultAction()
{
if (!ParentCheckedListBox.IsHandleCreated)
{
return;
}
internal override void Toggle() => DoDefaultAction();

ParentCheckedListBox.SetItemChecked(_index, !ParentCheckedListBox.GetItemChecked(_index));
}
internal override UiaCore.ToggleState ToggleState
=> IsItemChecked ? UiaCore.ToggleState.On : UiaCore.ToggleState.Off;

public override AccessibleObject Navigate(AccessibleNavigation direction)
{
// Down/Next
//
if (direction == AccessibleNavigation.Down ||
direction == AccessibleNavigation.Next)
{
if (_index < _parent.GetChildCount() - 1)
{
return _parent.GetChild(_index + 1);
}
}

// Up/Previous
//
if (direction == AccessibleNavigation.Up ||
direction == AccessibleNavigation.Previous)
{
if (_index > 0)
{
return _parent.GetChild(_index - 1);
}
}

return base.Navigate(direction);
}

public override void Select(AccessibleSelection flags)
{
try
{
if (ParentCheckedListBox.IsHandleCreated)
{
ParentCheckedListBox.AccessibilityObject.GetSystemIAccessibleInternal()?.accSelect((int)flags, _index + 1);
}
}
catch (ArgumentException)
{
// In Everett, the CheckedListBox accessible children did not have any selection capability.
// In Whidbey, they delegate the selection capability to OLEACC.
// However, OLEACC does not deal w/ several Selection flags: ExtendSelection, AddSelection, RemoveSelection.
// OLEACC instead throws an ArgumentException.
// Since Whidbey API's should not throw an exception in places where Everett API's did not, we catch
// the ArgumentException and fail silently.
}
}
public override string Value => IsItemChecked.ToString();
}
}
}
Loading