AccessibilityNodeInfo.AccessibilityAction Class

Definition

[Android.Runtime.Register("android/view/accessibility/AccessibilityNodeInfo$AccessibilityAction", DoNotGenerateAcw=true)]
public sealed class AccessibilityNodeInfo.AccessibilityAction : Java.Lang.Object, Android.OS.IParcelable, IDisposable, Java.Interop.IJavaPeerable

[<Android.Runtime.Register("android/view/accessibility/AccessibilityNodeInfo$AccessibilityAction", DoNotGenerateAcw=true)>]
type AccessibilityNodeInfo.AccessibilityAction = class
    inherit Object
    interface IParcelable
    interface IJavaObject
    interface IDisposable
    interface IJavaPeerable

Inheritance

Object

Object

AccessibilityNodeInfo.AccessibilityAction

Attributes

RegisterAttribute

Implements

IParcelable IJavaObject IJavaPeerable IDisposable

Remarks

A class defining an action that can be performed on an AccessibilityNodeInfo. Each action has a unique id that is mandatory and optional data.

There are three categories of actions: <ul> <li><strong>Standard actions</strong> - These are actions that are reported and handled by the standard UI widgets in the platform. For each standard action there is a static constant defined in this class, e.g. #ACTION_FOCUS. These actions will have null labels. </li> <li><strong>Custom actions action</strong> - These are actions that are reported and handled by custom widgets. i.e. ones that are not part of the UI toolkit. For example, an application may define a custom action for clearing the user history. </li> <li><strong>Overridden standard actions</strong> - These are actions that override standard actions to customize them. For example, an app may add a label to the standard #ACTION_CLICK action to indicate to the user that this action clears browsing history. </ul>

Actions are typically added to an AccessibilityNodeInfo by using AccessibilityNodeInfo#addAction(AccessibilityAction) within View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo) and are performed within View#performAccessibilityAction(int, Bundle).

"note"> <b>Note:</b> Views which support these actions should invoke <c>View#setImportantForAccessibility(int)</c> with <c>View#IMPORTANT_FOR_ACCESSIBILITY_YES</c> to ensure an <c>AccessibilityService</c> can discover the set of supported actions. </aside>

"note"> <b>Note:</b> Use <c>androidx.core.view.ViewCompat#addAccessibilityAction(View, CharSequence, AccessibilityViewCommand)</c> to register an action directly on the view. </aside>

Java documentation for android.view.accessibility.AccessibilityNodeInfo.AccessibilityAction.

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.