AccessibilityNodeInfo.LiveRegion Property

Definition

Gets the node's live region mode. -or- Sets the node's live region mode.

public virtual Android.Views.AccessibilityLiveRegion LiveRegion { [Android.Runtime.Register("getLiveRegion", "()I", "GetGetLiveRegionHandler")] get; [Android.Runtime.Register("setLiveRegion", "(I)V", "GetSetLiveRegion_IHandler")] set; }
[<get: Android.Runtime.Register("getLiveRegion", "()I", "GetGetLiveRegionHandler")>]
[<set: Android.Runtime.Register("setLiveRegion", "(I)V", "GetSetLiveRegion_IHandler")>]
member this.LiveRegion : Android.Views.AccessibilityLiveRegion with get, set

Property Value

The live region mode, or View#ACCESSIBILITY_LIVE_REGION_NONE if the view is not a live region.

Attributes

Remarks

Property getter documentation:

Gets the node's live region mode.

A live region is a node that contains information that is important for the user and when it changes the user should be notified. For example, a Snackbar that displays a confirmation notification should be marked as a live region with mode View#ACCESSIBILITY_LIVE_REGION_POLITE.

It is the responsibility of the accessibility service to monitor AccessibilityEvent#TYPE_WINDOW_CONTENT_CHANGED events indicating changes to live region nodes and their children.

Java documentation for android.view.accessibility.AccessibilityNodeInfo.getLiveRegion().

Property setter documentation:

Sets the node's live region mode.

<strong>Note:</strong> Cannot be called from an android.accessibilityservice.AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.

Java documentation for android.view.accessibility.AccessibilityNodeInfo.setLiveRegion(int).

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.

Applies to

See also