AccessibilityNodeInfo.SupplementalDescriptionFormatted Property

Definition

Gets the supplemental description of this node. -or- Sets the supplemental description of this node.

public virtual Java.Lang.ICharSequence? SupplementalDescriptionFormatted { [Android.Runtime.Register("getSupplementalDescription", "()Ljava/lang/CharSequence;", "GetGetSupplementalDescriptionHandler", ApiSince=36)] get; [Android.Runtime.Register("setSupplementalDescription", "(Ljava/lang/CharSequence;)V", "GetSetSupplementalDescription_Ljava_lang_CharSequence_Handler", ApiSince=36)] set; }
[<get: Android.Runtime.Register("getSupplementalDescription", "()Ljava/lang/CharSequence;", "GetGetSupplementalDescriptionHandler", ApiSince=36)>]
[<set: Android.Runtime.Register("setSupplementalDescription", "(Ljava/lang/CharSequence;)V", "GetSetSupplementalDescription_Ljava_lang_CharSequence_Handler", ApiSince=36)>]
member this.SupplementalDescriptionFormatted : Java.Lang.ICharSequence with get, set

Property Value

The supplemental description.

Attributes

Remarks

Property getter documentation:

Gets the supplemental description of this node. A supplemental description provides brief supplemental information for this node, such as the purpose of the node when that purpose is not conveyed within its textual representation. For example, if a dropdown select has a purpose of setting font family, the supplemental description could be "font family". If this node has children, its supplemental description serves as additional information and is not intended to replace any existing information in the subtree. This is different from the #getContentDescription() in that this description is purely supplemental while a content description may be used to replace a description for a node or its subtree that an assistive technology would otherwise compute based on other properties of the node and its descendants.

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

Property setter documentation:

Sets the supplemental description of this node. A supplemental description provides brief supplemental information for this node, such as the purpose of the node when that purpose is not conveyed within its textual representation. For example, if a dropdown select has a purpose of setting font family, the supplemental description could be "font family". If this node has children, its supplemental description serves as additional information and is not intended to replace any existing information in the subtree. This is different from the #setContentDescription(CharSequence) in that this description is purely supplemental while a content description may be used to replace a description for a node or its subtree that an assistive technology would otherwise compute based on other properties of the node and its descendants.

<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.setSupplementalDescription(java.lang.CharSequence).

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