UI Automation Support for the Edit Control Type

 
System_CAPS_ICON_note.jpg Note

This documentation is intended for .NET Framework developers who want to use the managed UI Automation classes defined in the System.Windows.Automation namespace. For the latest information about UI Automation, see Windows Automation API: UI Automation.

This topic provides information about UI Automation support for the Edit 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.

Edit controls enable a user to view and edit a simple line of text without rich formatting support.

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

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

Control ViewContent View
EditEdit

The controls that implement the Edit control type will always have zero scroll bars in the control view of the UI Automation tree because it is a single-line control. The single line of text may wrap in some layout scenarios. The Edit control type is best suited for holding small amounts of editable or selectable text.

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

UI Automation PropertyValueNotes
AutomationIdPropertySee notes.The value of this property needs to be unique across all controls in an application.
BoundingRectanglePropertySee notes.The outermost rectangle that contains the whole control.
ClickablePointPropertySee notes.The edit control must have a clickable point that gives input focus to the edit portion of the control when a user clicks the mouse there.
IsKeyboardFocusablePropertySee notes.If the control can receive keyboard focus, it must support this property.
NamePropertySee notes.The name of the edit control is typically generated from a static text label. If there is not a static text label, a property value for Name must be assigned by the application developer. The Name property should never contain the textual contents of the edit control.
LabeledByPropertySee notes.If there is a static text label associated with the control, then this property must expose a reference to that control. If the text control is a subcomponent of another control, it will not have a LabeledBy property set.
ControlTypePropertyEditThis value is the same for all UI frameworks.
LocalizedControlTypeProperty"edit"Localized string corresponding to the Edit control type.
IsContentElementPropertyTrueThe edit control is always included in the content view of the UI Automation tree.
IsControlElementPropertyTrueThe edit control is always included in the control view of the UI Automation tree.
IsPasswordPropertySee notes.Must be set to true on edit controls that contain passwords. If an edit control does contain Password contents then this property can be used by a screen reader to determine whether keystrokes should be read out as the user types them.

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

Control Pattern/Control Pattern PropertySupport/ValueNotes
ITextProviderDependsEdit controls should support the Text control pattern because detailed text information should always be available for clients.
IValueProviderDependsAll edit controls that take a string must expose the Value pattern.
IsReadOnlySee notes.This property must be set to indicate whether the control can have a value set programmatically or is editable by the user.
ValueSee notes.This property will return the textual contents of the edit control. If the IsPasswordProperty is set to true, this property must raise an InvalidOpertaionException when requested.
IRangeValueProviderDependsAll edit controls that take a numeric range must expose Range Value control pattern.
MinimumSee notes.This property must be the smallest value that the edit control's contents can be set to.
MaximumSee notes.This property must be the largest value that the edit control's contents can be set to.
SmallChangeSee notes.This property must indicate the number of decimal places that the value can be set to. If the edit only take integers, the SmallChangeProperty must be 1. If the edit takes a range from 1.0 to 2.0, then the SmallChangeProperty must be 0.1. If the edit control takes a range from 1.00 to 2.00 then the SmallChangeProperty must be 0.001.
LargeChangeNullThis property does not need to be exposed on an edit control.
ValueSee notes.This property will indicate the numeric contents of the edit control. When a more precise value is set by a UI Automation client within the ranges specified in the Minimum and Maximum properties, the Value property will automatically be rounded to the closest accepted value.

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

UI Automation EventSupportNotes
InvalidatedEventRequiredNone
TextSelectionChangedEventRequiredNone
TextChangedEventRequiredNone
BoundingRectangleProperty property-changed event.RequiredNone
IsOffscreenProperty property-changed event.RequiredNone
IsEnabledProperty property-changed event.RequiredNone
NameProperty property-changed event.RequiredNone
ValueProperty property-changed event.DependsNone
HorizontallyScrollableProperty property-changed event.NeverNone
HorizontalScrollPercentProperty property-changed event.NeverNone
HorizontalViewSizeProperty property-changed event.NeverNone
VerticalScrollPercentProperty property-changed event.NeverNone
VerticallyScrollableProperty property-changed event.NeverNone
VerticalViewSizeProperty property-changed event.NeverNone
ValueProperty property-changed event.DependsIf the control supports the range Value control pattern, it must support this event.
AutomationFocusChangedEventRequiredNone
StructureChangedEventRequiredNone

Edit
UI Automation Control Types Overview
UI Automation Overview

Show: