Class

UIAccessibilityElement

The UIAccessibilityElement class encapsulates information about an item that should be accessible to users with disabilities, but that isn’t accessible by default. For example, an icon or text image is not automatically accessible because it does not inherit from UIView (or UIControl). A view that contains such nonview items creates an instance of UIAccessibilityElement to represent each item that needs to be accessible.

Overview

The properties of an accessibility element provide information about the element, such as location and current value, to an assistive application. You might need to set an element’s property even if you don’t need to create an instance of UIAccessibilityElement to represent it. For example, if your application includes a button with a custom icon that means “solve,” the button itself is already represented by an accessibility element because it is a subclass of UIButton. However, you need to supply information for the label and hint properties because this information is unique to this button. You can do this in Interface Builder or by setting the properties in the UIAccessibility informal protocol.

Symbols

Creating an Accessibility Element

init(accessibilityContainer: Any)

Creates and initializes an accessibility element to represent an item in the specified container.

Accessing the Containing View

var accessibilityContainer: AnyObject?

The view that contains the accessibility element.

Determining Accessibility

var isAccessibilityElement: Bool

A Boolean value indicating whether the item is an accessibility element an assistive application can access.

Accessing the Attributes of an Accessibility Element

var accessibilityLabel: String?

A string that succinctly identifies the accessibility element.

var accessibilityHint: String?

A string that briefly describes the result of performing an action on the accessibility element.

var accessibilityValue: String?

A string that represents the current value of the accessibility element.

var accessibilityFrame: CGRect

The frame of the accessibility element, in screen coordinates.

var accessibilityTraits: UIAccessibilityTraits

The combination of traits that best characterize the accessibility element.