Language

ContentCaptureNodeProperties Class

Definition

Properties of a Node for Content Capture.

[Android.Runtime.Register("android/view/contentcapture/ContentCaptureNodeProperties", ApiSince=37, DoNotGenerateAcw=true)]
public class ContentCaptureNodeProperties : Java.Lang.Object
[<Android.Runtime.Register("android/view/contentcapture/ContentCaptureNodeProperties", ApiSince=37, DoNotGenerateAcw=true)>]
type ContentCaptureNodeProperties = class
    inherit Object
Inheritance
ContentCaptureNodeProperties
Attributes

Remarks

Properties of a Node for Content Capture.

Used to provide changes from a UI node (e.g. a View or a virtual view) to the Content Capture System efficiently. An instance of this class should be reused during view tree traversal to minimize memory allocations.

To use this class: Obtain the AutofillId of the node. For virtual views, use ContentCaptureSession.newAutofillId(AutofillId,long); Set the desired properties on an instance of this class (e.g., setText(CharSequence), setBounds(int, int, int, int)); Pass the ID and this properties instance to ContentCaptureSession.notifyNodeAppearedOrChanged(AutofillId,ContentCaptureNodeProperties); Call clear() to reset the properties before reusing the instance for the next node.

To track which properties have been modified explicitly this class offers methods like hasBounds(), hasText() that will return true only if the corresponding property was explicitly set. Calling clear() removes all set fields and brings back this class to its initial state to be reused.

Calling a getter method when the corresponding property has not been set (i.e. when has*() returns false) will throw an IllegalStateException. Callers should check has*() prior to calling the getter.

Android reference for android.view.contentcapture.ContentCaptureNodeProperties.

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.

Constructors

Name Description
ContentCaptureNodeProperties()

Creates a set of content capture node properties with no properties set.

ContentCaptureNodeProperties(IntPtr, JniHandleOwnership)

Creates a managed instance that represents an existing Java object.

Properties

Name Description
Class

Returns the runtime class of this Object.

(Inherited from Object)
ContentDescription

Gets or sets the content description of the node as a string.

ContentDescriptionFormatted

Gets the content description of the node. -or- Sets the content description for this node.

Handle

The handle to the underlying Android instance.

(Inherited from Object)
HasBounds

Checks if the bounds have been explicitly set.

HasContentDescription

Checks if the content description has been explicitly set.

HasParentId

Checks if the parent ID has been explicitly set.

HasText

Checks if the text has been explicitly set.

JniIdentityHashCode

Gets the identity hash code assigned to this Java peer by the interop runtime.

(Inherited from Object)
JniManagedPeerState (Inherited from JavaObject)
JniPeerMembers

Gets the JNI metadata used to access members of this Java binding.

ParentId

Gets the parent ID of the node. -or- Sets the parent ID for this node.

PeerReference

Gets the JNI object reference for this Java peer.

(Inherited from Object)
Text

Gets or sets the text of the node as a string.

TextFormatted

Gets the text of the node. -or- Sets the text for this node.

ThresholdClass

Gets the Java class used for virtual method dispatch.

ThresholdType

Gets the managed type that declares this Java binding.

Methods

Name Description
Clear()

Clears the entire properties object for reuse.

Clone()

Creates and returns a copy of this object.

(Inherited from Object)
Construct(JniObjectReference, JniObjectReferenceOptions) (Inherited from JavaObject)
Dispose()

Releases the resources held by this Java peer.

(Inherited from Object)
Dispose(Boolean)

Releases the resources held by this Java peer.

(Inherited from Object)
DisposeUnlessReferenced() (Inherited from JavaObject)
Equals(Object) (Inherited from JavaObject)
Equals(Object)

Indicates whether some other object is "equal to" this one.

(Inherited from Object)
GetBounds(Rect)

Copies the relative boundaries of this node into the provided Rect.

GetHashCode()

Returns a hash code value for the object.

(Inherited from Object)
JavaFinalize()
Obsolete.

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

(Inherited from Object)
Notify()

Wakes up a single thread that is waiting on this object's monitor.

(Inherited from Object)
NotifyAll()

Wakes up all threads that are waiting on this object's monitor.

(Inherited from Object)
SetBounds(Int32, Int32, Int32, Int32)

Sets the boundaries for this node relative to the parent node.

SetHandle(IntPtr, JniHandleOwnership)

Sets the Handle property.

(Inherited from Object)
SetPeerReference(JniObjectReference, JniObjectReferenceOptions) (Inherited from JavaObject)
ToArray<T>()

Creates a managed array from this Java array wrapper.

(Inherited from Object)
ToString()

Returns a string representation of the object.

(Inherited from Object)
UnregisterFromRuntime()

Unregisters this Java peer from the interop runtime.

(Inherited from Object)
Wait()

Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>.

(Inherited from Object)
Wait(Int64, Int32)

Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed.

(Inherited from Object)
Wait(Int64)

Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed.

(Inherited from Object)

Explicit Interface Implementations

Name Description
IJavaPeerable.Disposed() (Inherited from JavaObject)
IJavaPeerable.Finalized() (Inherited from JavaObject)
IJavaPeerable.JniObjectReferenceControlBlock (Inherited from JavaObject)
IJavaPeerable.SetJniIdentityHashCode(Int32) (Inherited from JavaObject)
IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates) (Inherited from JavaObject)
IJavaPeerable.SetPeerReference(JniObjectReference) (Inherited from JavaObject)

Extension Methods

Name Description
GetJniTypeName(IJavaPeerable)

Gets the JNI name of the type of the instance self.

JavaAs<TResult>(IJavaPeerable)

Try to coerce self to type TResult, checking that the coercion is valid on the Java side.

JavaCast<TResult>(IJavaObject)

Performs an Android runtime-checked type conversion.

JavaCast<TResult>(IJavaObject)
TryJavaCast<TResult>(IJavaPeerable, TResult)

Try to coerce self to type TResult, checking that the coercion is valid on the Java side.

Applies to