UI Automation Support for the Split Button Control Type

This topic provides information about UI Automation support for the Split Button control type. In UI Automation, a control type is a set of conditions that a control must meet in order to use the ControlTypeProperty property. The conditions include specific guidelines for UI Automation tree structure, UI Automation property values and control patterns.

The split button control enables the ability to perform an action on a control and expand the control to see a list of other possible actions that can be performed.

The following sections define the required UI Automation tree structure, properties, control patterns, and events for the Split Button control type. The UI Automation requirements apply to all split button controls, whether Windows Presentation Foundation (WPF), Win32, or Windows Forms.

This topic contains the following sections.

Required UI Automation Tree Structure

The following table depicts the control view and the content view of the UI Automation tree that pertains to split button controls and describes what can be contained in each view. For more information about the UI Automation tree, see UI Automation Tree Overview.

Control View Content View
  • SplitButton

  • Image (0 or 1)

  • Text (0 or 1)

  • Button (1 or 2)

  • Menu

  • MenuItem (1 to many)

  • SplitButton

  • MenuItem (1 to many)

Required UI Automation Properties

The following table lists the UI Automation properties whose value or definition is especially relevant to split button controls. For more information about UI Automation properties, see UI Automation Properties for Clients.

UI Automation Property Value Notes

AutomationIdProperty

See notes.

The value of this property needs to be unique across all controls in an application.

BoundingRectangleProperty

See notes.

The outermost rectangle that contains the whole control.

ClickablePointProperty

See notes.

Supported if there is a bounding rectangle. If not every point within the bounding rectangle is clickable, and you perform specialized hit testing, then override and provide a clickable point.

IsKeyboardFocusableProperty

See notes.

If the control can receive keyboard focus, it must support this property.

NameProperty

"Back"

The split button control's name is displayed on the button.

LabeledByProperty

Null

Split button controls do not have a static text label.

ControlTypeProperty

SplitButton

This value is the same for all UI frameworks.

HelpTextProperty

"Left Arrow Symbol"

The visual description for the image contained in the button.

IsContentElementProperty

True

The split button control contains information for the end user.

IsControlElementProperty

True

The split button control is visible to the end user.

Required UI Automation Control Patterns

The following table lists the UI Automation control patterns required to be supported by split button controls. For more information about control patterns, see UI Automation Control Patterns Overview.

Control Pattern/Pattern Property Support/Value Notes

IInvokeProvider

Required

Split buttons always have a default action associated with Invoke.

IExpandCollapseProvider

Required

Split buttons always have the ability to expand a list of options.

Required UI Automation Events

The following table lists the UI Automation events required to be supported by all split button controls. For more information on events, see UI Automation Events Overview.

UI Automation Event Support Notes

InvokedEvent

Required

None

BoundingRectangleProperty property-changed event.

Required

None

IsOffscreenProperty property-changed event.

Required

None

IsEnabledProperty property-changed event.

Required

None

ExpandCollapseStateProperty property-changed event.

Required

None

AutomationFocusChangedEvent

Required

None

StructureChangedEvent

Required

None

Split Button Control Example

The following image illustrates a control that implements the Data Grid control type.

Split button
UI Automation Tree - Control View UI Automation Tree - Content View

DataGrid (Sort, Table, Selection, Grid)

  • Header

    • HeaderItem "Name" (Invoke)

    • SplitButton (Invoke)

Data Grid (Sort, Table, Selection, Grid)

  • Header

    • HeaderItem (Invoke)

See Also

Community Additions

ADD
Show: