View.DispatchPopulateAccessibilityEvent(AccessibilityEvent) Method

Definition

Namespace:

Android.Views

Assembly:

Mono.Android.dll

Dispatches an AccessibilityEvent to the View first and then to its children for adding their text content to the event.

[Android.Runtime.Register("dispatchPopulateAccessibilityEvent", "(Landroid/view/accessibility/AccessibilityEvent;)Z", "GetDispatchPopulateAccessibilityEvent_Landroid_view_accessibility_AccessibilityEvent_Handler")]
public virtual bool DispatchPopulateAccessibilityEvent (Android.Views.Accessibility.AccessibilityEvent? e);

[<Android.Runtime.Register("dispatchPopulateAccessibilityEvent", "(Landroid/view/accessibility/AccessibilityEvent;)Z", "GetDispatchPopulateAccessibilityEvent_Landroid_view_accessibility_AccessibilityEvent_Handler")>]
abstract member DispatchPopulateAccessibilityEvent : Android.Views.Accessibility.AccessibilityEvent -> bool
override this.DispatchPopulateAccessibilityEvent : Android.Views.Accessibility.AccessibilityEvent -> bool

Parameters

e

AccessibilityEvent

The event.

Returns

Boolean

True if the event population was completed.

Attributes

RegisterAttribute

Remarks

Dispatches an AccessibilityEvent to the View first and then to its children for adding their text content to the event. Note that the event text is populated in a separate dispatch path since we add to the event not only the text of the source but also the text of all its descendants. A typical implementation will call #onPopulateAccessibilityEvent(AccessibilityEvent) on the this view and then call the #dispatchPopulateAccessibilityEvent(AccessibilityEvent) on each child. Override this method if custom population of the event text content is required.

If an AccessibilityDelegate has been specified via calling #setAccessibilityDelegate(AccessibilityDelegate) its AccessibilityDelegate#dispatchPopulateAccessibilityEvent(View, AccessibilityEvent) is responsible for handling this call.

If this view sets #isAccessibilityDataSensitive() then this view should only append sensitive information to an event that also sets AccessibilityEvent#isAccessibilityDataSensitive().

<em>Note:</em> Accessibility events of certain types are not dispatched for populating the event text via this method. For details refer to AccessibilityEvent.

Java documentation for android.view.View.dispatchPopulateAccessibilityEvent(android.view.accessibility.AccessibilityEvent).

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.