PreferenceActivity.Header Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Description of a single Header item that the user can select.
[Android.Runtime.Register("android/preference/PreferenceActivity$Header", DoNotGenerateAcw=true)]
public sealed class PreferenceActivity.Header : Java.Lang.Object, Android.OS.IParcelable, IDisposable[<Android.Runtime.Register("android/preference/PreferenceActivity$Header", DoNotGenerateAcw=true)>]
type PreferenceActivity.Header = class
inherit Object
interface IParcelable
interface IJavaObject
interface IDisposable
interface IJavaPeerable- Inheritance
- Attributes
- Implements
Remarks
Description of a single Header item that the user can select.
This member is deprecated. Use the AndroidX Preference Library for consistent behavior across all devices. For more information on using the AndroidX Preference Library see Settings.
Java documentation for android.preference.PreferenceActivity.Header.
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 |
|---|---|
| PreferenceActivity.Header() |
Initializes an empty preference header with an undefined identifier. |
Properties
| Name | Description |
|---|---|
| BreadCrumbShortTitle |
Optional text to show as the short title in the bread crumb. |
| BreadCrumbShortTitleRes |
Resource ID of optional text to show as the short title in the bread crumb. |
| BreadCrumbTitle |
Optional text to show as the title in the bread crumb. |
| BreadCrumbTitleRes |
Resource ID of optional text to show as the title in the bread crumb. |
| Class |
Returns the runtime class of this |
| Creator |
Gets the creator for preference headers. |
| Extras |
Optional additional data for use by subclasses of PreferenceActivity. |
| Fragment |
Full class name of the fragment to display when this header is selected. |
| FragmentArguments |
Optional arguments to supply to the fragment when it is instantiated. |
| Handle |
The handle to the underlying Android instance. (Inherited from Object) |
| IconRes |
Optional icon resource to show for this header. |
| Id |
Identifier for this header, to correlate with a new list when it is updated. |
| Intent |
Intent to launch when the preference is selected. |
| JniIdentityHashCode |
Gets the identity hash code assigned to this Java peer by the interop runtime. (Inherited from Object) |
| JniManagedPeerState |
Gets the state flags last assigned by the runtime. (Inherited from JavaObject) |
| JniPeerMembers |
Gets the JNI metadata used to access members of this Java binding. |
| PeerReference |
Gets the JNI object reference for this Java peer. (Inherited from Object) |
| Summary |
Optional summary describing what this header controls. |
| SummaryRes |
Resource ID of optional summary describing what this header controls. |
| ThresholdClass |
This API supports the Mono for Android infrastructure and is not intended to be used directly from your code. (Inherited from Object) |
| ThresholdType |
This API supports the Mono for Android infrastructure and is not intended to be used directly from your code. (Inherited from Object) |
| Title |
Title of the header that is shown to the user. |
| TitleRes |
Resource ID of title of the header that is shown to the user. |
Methods
| Name | Description |
|---|---|
| Clone() |
Creates and returns a copy of this object. (Inherited from Object) |
| Construct(JniObjectReference, JniObjectReferenceOptions) |
Delegates construction of this peer to the runtime's value manager. (Inherited from JavaObject) |
| DescribeContents() |
Describe the kinds of special objects contained in this Parcelable's marshalled representation. |
| 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() |
Asks the value manager to dispose this peer unless its mapping retains this same managed instance. (Inherited from JavaObject) |
| Equals(Object) |
Tests whether another managed peer refers to the same Java object. (Inherited from JavaObject) |
| Equals(Object) |
Indicates whether some other object is "equal to" this one. (Inherited from Object) |
| GetBreadCrumbShortTitle(Resources) |
Return the currently set bread crumb short title. |
| GetBreadCrumbShortTitleFormatted(Resources) |
Return the currently set bread crumb short title. |
| GetBreadCrumbTitle(Resources) |
Return the currently set bread crumb title. |
| GetBreadCrumbTitleFormatted(Resources) |
Return the currently set bread crumb title. |
| GetHashCode() |
Returns a hash code value for the object. (Inherited from Object) |
| GetSummary(Resources) |
Return the currently set summary. |
| GetSummaryFormatted(Resources) |
Return the currently set summary. |
| GetTitle(Resources) |
Return the currently set title. |
| GetTitleFormatted(Resources) |
Return the currently set title. |
| 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) |
| ReadFromParcel(Parcel) |
Reads the header fields from a parcel. |
| SetHandle(IntPtr, JniHandleOwnership) |
Sets the Handle property. (Inherited from Object) |
| SetPeerReference(JniObjectReference, JniObjectReferenceOptions) |
Stores a reference value in the control block without creating a JNI reference copy. (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) |
| WriteToParcel(Parcel, ParcelableWriteFlags) |
Flatten this object in to a Parcel. |
Explicit Interface Implementations
| Name | Description |
|---|---|
| IJavaPeerable.Disposed() |
Marks this peer as disposed and calls |
| IJavaPeerable.Finalized() |
Marks this peer as disposed and calls |
| IJavaPeerable.JniObjectReferenceControlBlock |
Gets the native control-block pointer used by this peer. (Inherited from JavaObject) |
| IJavaPeerable.SetJniIdentityHashCode(Int32) |
Stores the identity hash code supplied by the runtime. (Inherited from JavaObject) |
| IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates) |
Replaces the stored managed peer state flags. (Inherited from JavaObject) |
| IJavaPeerable.SetPeerReference(JniObjectReference) |
Updates the peer reference and releases a disposed peer's control block when the reference is invalid. (Inherited from JavaObject) |
| IJavaPeerable.UnregisterFromRuntime() |
Removes this instance from the runtime's Java object lookup. |
Extension Methods
| Name | Description |
|---|---|
| GetJniTypeName(IJavaPeerable) |
Gets the JNI name of the type of the instance |
| JavaAs<TResult>(IJavaPeerable) |
Try to coerce |
| JavaCast<TResult>(IJavaObject) |
Performs an Android runtime-checked type conversion. |
| JavaCast<TResult>(IJavaObject) |
Reuses a compatible managed peer or obtains a wrapper of the requested type. |
| TryJavaCast<TResult>(IJavaPeerable, TResult) |
Try to coerce |