Preference Class

Reference

Definition

Namespace:: Android.Preferences

Assembly:: Mono.Android.dll

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.

Represents the basic Preference UI building block displayed by a PreferenceActivity in the form of a ListView.

[Android.Runtime.Register("android/preference/Preference", DoNotGenerateAcw=true)]
public class Preference : Java.Lang.Object, IDisposable, Java.Interop.IJavaPeerable, Java.Lang.IComparable

[<Android.Runtime.Register("android/preference/Preference", DoNotGenerateAcw=true)>]
type Preference = class
    inherit Object
    interface IComparable
    interface IJavaObject
    interface IDisposable
    interface IJavaPeerable

Inheritance: Object

Object
Preference

Derived: Android.Preferences.DialogPreference

Android.Preferences.PreferenceGroup

Android.Preferences.RingtonePreference

Android.Preferences.TwoStatePreference

Attributes: RegisterAttribute

Implements: IJavaObject IJavaPeerable IComparable IDisposable

Remarks

Represents the basic Preference UI building block displayed by a PreferenceActivity in the form of a ListView. This class provides the View to be displayed in the activity and associates with a SharedPreferences to store/retrieve the preference data.

When specifying a preference hierarchy in XML, each element can point to a subclass of Preference, similar to the view hierarchy and layouts.

This class contains a key that will be used as the key into the SharedPreferences. It is up to the subclass to decide how to store the value.

<div class="special reference"> <h3>Developer Guides</h3>

For information about building a settings UI with Preferences, read the Settings guide.

</div>

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.Preference.

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

Preference(Context, IAttributeSet, Int32, Int32)	Perform inflation from XML and apply a class-specific base style.
Preference(Context, IAttributeSet, Int32)	Perform inflation from XML and apply a class-specific base style.
Preference(Context, IAttributeSet)	Constructor that is called when inflating a Preference from XML.
Preference(Context)	Constructor to create a Preference.
Preference(IntPtr, JniHandleOwnership)	A constructor used when creating managed representations of JNI objects; called by the runtime.

Fields

DefaultOrder

Specify for #setOrder(int) if a specific order is not required.

Properties

Class	Returns the runtime class of this `Object`. (Inherited from Object)
Context	Returns the `android.content.Context` of this Preference.
Dependency	Returns the key of the dependency on this Preference. -or- Sets the key of a Preference that this Preference will depend on.
Editor	Returns an `SharedPreferences.Editor` where this Preference can save its value(s).
Enabled	Checks whether this Preference should be enabled in the list. -or- Sets whether this Preference is enabled.
Extras	Return the extras Bundle object associated with this preference, creating a new Bundle if there currently isn't one.
Fragment	Return the fragment class name associated with this Preference. -or- Sets the class name of a fragment to be shown when this Preference is clicked.
Handle	The handle to the underlying Android instance. (Inherited from Object)
HasKey	Checks whether this Preference has a valid key.
Icon	Returns the icon of this Preference. -or- Sets the icon for this Preference with a Drawable.
IconSpaceReserved	Gets whether the space this preference icon view is reserved. -or- Sets whether to reserve the space of this Preference icon view when no icon is provided.
Intent	Return the `Intent` associated with this Preference. -or- Sets an `Intent` to be used for `Context#startActivity(Intent)` when this Preference is clicked.
JniIdentityHashCode	(Inherited from Object)
JniPeerMembers
Key	Gets the key for this Preference, which is also the key used for storing values into `SharedPreferences` or `PreferenceDataStore`. -or- Sets the key for this Preference, which is used as a key to the `SharedPreferences` or `PreferenceDataStore`.
LayoutResource	Gets the layout resource that will be shown as the `View` for this Preference. -or- Sets the layout resource that is inflated as the `View` to be shown for this Preference.
OnPreferenceChangeListener	Returns the callback to be invoked when this Preference is changed by the user (but before the internal state has been updated). -or- Sets the callback to be invoked when this Preference is changed by the user (but before the internal state has been updated).
OnPreferenceClickListener	Returns the callback to be invoked when this Preference is clicked. -or- Sets the callback to be invoked when this Preference is clicked.
Order	Gets the order of this Preference with respect to other Preference objects on the same level. -or- Sets the order of this Preference with respect to other Preference objects on the same level.
Parent	Returns the `PreferenceGroup` which is this Preference assigned to or `null` if this preference is not assigned to any group or is a root Preference.
PeerReference	(Inherited from Object)
Persistent	Checks whether this Preference is persistent. -or- Sets whether this Preference is persistent.
PreferenceDataStore	Returns `PreferenceDataStore` used by this Preference. -or- Sets a `PreferenceDataStore` to be used by this Preference instead of using `android.content.SharedPreferences`.
PreferenceManager	Gets the `PreferenceManager` that manages this Preference object's tree.
RecycleEnabled	Checks whether this Preference has enabled to have its view recycled when used in the list view. -or- Sets whether this Preference has enabled to have its view recycled when used in the list view.
Selectable	Checks whether this Preference should be selectable in the list. -or- Sets whether this Preference is selectable.
SharedPreferences	Returns the `SharedPreferences` where this Preference can read its value(s).
ShouldDisableView	Checks whether this Preference should disable its view when it's action is disabled. -or- Sets whether this Preference should disable its view when it gets disabled.
SingleLineTitle	Gets whether the title of this preference is constrained to a single line. -or- Sets whether to constrain the title of this Preference to a single line instead of letting it wrap onto multiple lines.
Summary
SummaryFormatted	Returns the summary of this Preference. -or- Sets the summary for this Preference with a CharSequence.
ThresholdClass	This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.
ThresholdType	This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.
Title
TitleFormatted	Returns the title of this Preference. -or- Sets the title for this Preference with a CharSequence.
TitleRes	Returns the title resource ID of this Preference.
WidgetLayoutResource	Gets the layout resource for the controllable widget portion of this Preference. -or- Sets the layout for the controllable widget portion of this Preference.

Methods

CallChangeListener(Object)	Call this method after the user changes the preference, but before the internal state is set.
Clone()	Creates and returns a copy of this object. (Inherited from Object)
CompareTo(Preference)	Compares Preference objects based on order (if set), otherwise alphabetically on the titles.
Dispose()	(Inherited from Object)
Dispose(Boolean)	(Inherited from Object)
Equals(Object)	Indicates whether some other object is "equal to" this one. (Inherited from Object)
FindPreferenceInHierarchy(String)	Finds a Preference in this hierarchy (the whole thing, even above/below your `PreferenceScreen` screen break) with the given key.
GetHashCode()	Returns a hash code value for the object. (Inherited from Object)
GetPersistedBoolean(Boolean)	Attempts to get a persisted boolean if this Preference is persistent.
GetPersistedFloat(Single)	Attempts to get a persisted float if this Preference is persistent.
GetPersistedInt(Int32)	Attempts to get a persisted int if this Preference is persistent.
GetPersistedLong(Int64)	Attempts to get a persisted long if this Preference is persistent.
GetPersistedString(String)	Attempts to get a persisted String if this Preference is persistent.
GetPersistedStringSet(ICollection<String>)	Attempts to get a persisted set of Strings if this Preference is persistent.
GetView(View, ViewGroup)	Gets the View that will be shown in the `PreferenceActivity`.
JavaFinalize()	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)
NotifyChanged()	Should be called when the data of this `Preference` has changed.
NotifyDependencyChange(Boolean)	Notifies any listening dependents of a change that affects the dependency.
NotifyHierarchyChanged()	Should be called when a Preference has been added/removed from this group, or the ordering should be re-evaluated.
OnAttachedToActivity()	Called when the Preference hierarchy has been attached to the `PreferenceActivity`.
OnAttachedToHierarchy(PreferenceManager)	Called when this Preference has been attached to a Preference hierarchy.
OnBindView(View)	Binds the created View to the data for this Preference.
OnClick()	Processes a click on the preference.
OnCreateView(ViewGroup)	Creates the View to be shown for this Preference in the `PreferenceActivity`.
OnDependencyChanged(Preference, Boolean)	Called when the dependency changes.
OnGetDefaultValue(TypedArray, Int32)	Called when a Preference is being inflated and the default value attribute needs to be read.
OnParentChanged(Preference, Boolean)	Called when the implicit parent dependency changes.
OnPrepareForRemoval()	Called when this Preference is being removed from the hierarchy.
OnRestoreInstanceState(IParcelable)	Hook allowing a Preference to re-apply a representation of its internal state that had previously been generated by `#onSaveInstanceState`.
OnSaveInstanceState()	Hook allowing a Preference to generate a representation of its internal state that can later be used to create a new instance with that same state.
OnSetInitialValue(Boolean, Object)	Implement this to set the initial value of the Preference.
PeekExtras()	Return the extras Bundle object associated with this preference, returning `null` if there is not currently one.
PersistBoolean(Boolean)	Attempts to persist a boolean if this Preference is persistent.
PersistFloat(Single)	Attempts to persist a long if this Preference is persistent.
PersistInt(Int32)	Attempts to persist an int if this Preference is persistent.
PersistLong(Int64)	Attempts to persist a long if this Preference is persistent.
PersistString(String)	Attempts to persist a String if this Preference is persistent.
PersistStringSet(ICollection<String>)	Attempts to persist a set of Strings if this Preference is persistent.
RestoreHierarchyState(Bundle)	Restore this Preference hierarchy's previously saved state from the given container.
SaveHierarchyState(Bundle)	Store this Preference hierarchy's frozen state into the given container.
SetDefaultValue(Object)	Sets the default value for this Preference, which will be set either if persistence is off or persistence is on and the preference is not found in the persistent storage.
SetHandle(IntPtr, JniHandleOwnership)	Sets the Handle property. (Inherited from Object)
SetIcon(Int32)	Sets the icon for this Preference with a resource ID.
SetSummary(Int32)	Sets the summary for this Preference with a resource ID.
SetTitle(Int32)	Sets the title for this Preference with a resource ID.
ShouldCommit()	Returns whether the `Preference` should commit its saved value(s) in `#getEditor()`.
ShouldDisableDependents()	Checks whether this preference's dependents should currently be disabled.
ShouldPersist()	Checks whether, at the given time this method is called, this Preference should store/restore its value(s) into the `SharedPreferences` or into `PreferenceDataStore` if assigned.
ToArray<T>()	(Inherited from Object)
ToString()	Returns a string representation of the object. (Inherited from Object)
UnregisterFromRuntime()	(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)

Events

PreferenceChange
PreferenceClick

Explicit Interface Implementations

IComparable.CompareTo(Object)
IJavaPeerable.Disposed()	(Inherited from Object)
IJavaPeerable.DisposeUnlessReferenced()	(Inherited from Object)
IJavaPeerable.Finalized()	(Inherited from Object)
IJavaPeerable.JniManagedPeerState	(Inherited from Object)
IJavaPeerable.SetJniIdentityHashCode(Int32)	(Inherited from Object)
IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates)	(Inherited from Object)
IJavaPeerable.SetPeerReference(JniObjectReference)	(Inherited from Object)

Extension Methods

JavaCast<TResult>(IJavaObject)	Performs an Android runtime-checked type conversion.
JavaCast<TResult>(IJavaObject)
GetJniTypeName(IJavaPeerable)

Applies to

Share via