PreferenceScreen 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 a top-level Preference that is the root of a Preference hierarchy.

[Android.Runtime.Register("android/preference/PreferenceScreen", DoNotGenerateAcw=true)]
public sealed class PreferenceScreen : Android.Preferences.PreferenceGroup, Android.Content.IDialogInterfaceOnDismissListener, Android.Widget.AdapterView.IOnItemClickListener, IDisposable, Java.Interop.IJavaPeerable

[<Android.Runtime.Register("android/preference/PreferenceScreen", DoNotGenerateAcw=true)>]
type PreferenceScreen = class
    inherit PreferenceGroup
    interface IDialogInterfaceOnDismissListener
    interface IJavaObject
    interface IDisposable
    interface IJavaPeerable
    interface AdapterView.IOnItemClickListener

Inheritance: Object

Object

Preference

PreferenceGroup
PreferenceScreen

Attributes: RegisterAttribute

Implements: IDialogInterfaceOnDismissListener IJavaObject AdapterView.IOnItemClickListener IJavaPeerable IDisposable

Remarks

Represents a top-level Preference that is the root of a Preference hierarchy. A PreferenceActivity points to an instance of this class to show the preferences. To instantiate this class, use PreferenceManager#createPreferenceScreen(Context). <ul> This class can appear in two places: <li> When a PreferenceActivity points to this, it is used as the root and is not shown (only the contained preferences are shown). <li> When it appears inside another preference hierarchy, it is shown and serves as the gateway to another screen of preferences (either by showing another screen of preferences as a Dialog or via a Context#startActivity(android.content.Intent) from the Preference#getIntent()). The children of this PreferenceScreen are NOT shown in the screen that this PreferenceScreen is shown in. Instead, a separate screen will be shown when this preference is clicked. </ul>

Here's an example XML layout of a PreferenceScreen:

&lt;PreferenceScreen
                    xmlns:android="http://schemas.android.com/apk/res/android"
                    android:key="first_preferencescreen"&gt;
                &lt;CheckBoxPreference
                        android:key="wifi enabled"
                        android:title="WiFi" /&gt;
                &lt;PreferenceScreen
                        android:key="second_preferencescreen"
                        android:title="WiFi settings"&gt;
                    &lt;CheckBoxPreference
                            android:key="prefer wifi"
                            android:title="Prefer WiFi" /&gt;
                    ... other preferences here ...
                &lt;/PreferenceScreen&gt;
            &lt;/PreferenceScreen&gt;

In this example, the "first_preferencescreen" will be used as the root of the hierarchy and given to a PreferenceActivity. The first screen will show preferences "WiFi" (which can be used to quickly enable/disable WiFi) and "WiFi settings". The "WiFi settings" is the "second_preferencescreen" and when clicked will show another screen of preferences such as "Prefer WiFi" (and the other preferences that are children of the "second_preferencescreen" tag).

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

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.

Fields

DefaultOrder

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

(Inherited from Preference)

Properties

Class	Returns the runtime class of this `Object`. (Inherited from Object)
Context	Returns the `android.content.Context` of this Preference. (Inherited from Preference)
Dependency	Returns the key of the dependency on this Preference. -or- Sets the key of a Preference that this Preference will depend on. (Inherited from Preference)
Dialog	Used to get a handle to the dialog.
Editor	Returns an `SharedPreferences.Editor` where this Preference can save its value(s). (Inherited from Preference)
Enabled	Checks whether this Preference should be enabled in the list. -or- Sets whether this Preference is enabled. (Inherited from Preference)
Extras	Return the extras Bundle object associated with this preference, creating a new Bundle if there currently isn't one. (Inherited from Preference)
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. (Inherited from Preference)
Handle	The handle to the underlying Android instance. (Inherited from Object)
HasKey	Checks whether this Preference has a valid key. (Inherited from Preference)
Icon	Returns the icon of this Preference. -or- Sets the icon for this Preference with a Drawable. (Inherited from Preference)
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. (Inherited from Preference)
Intent	Return the `Intent` associated with this Preference. -or- Sets an `Intent` to be used for `Context#startActivity(Intent)` when this Preference is clicked. (Inherited from Preference)
IsOnSameScreenAsChildren	Whether this preference group should be shown on the same screen as its contained preferences. (Inherited from PreferenceGroup)
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`. (Inherited from Preference)
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. (Inherited from 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). (Inherited from Preference)
OnPreferenceClickListener	Returns the callback to be invoked when this Preference is clicked. -or- Sets the callback to be invoked when this Preference is clicked. (Inherited from Preference)
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. (Inherited from Preference)
OrderingAsAdded	Whether this group is ordering preferences in the order they are added. -or- Whether to order the `Preference` children of this group as they are added. (Inherited from PreferenceGroup)
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. (Inherited from Preference)
PeerReference	(Inherited from Object)
Persistent	Checks whether this Preference is persistent. -or- Sets whether this Preference is persistent. (Inherited from Preference)
PreferenceCount	Returns the number of children `Preference`s. (Inherited from PreferenceGroup)
PreferenceDataStore	Returns `PreferenceDataStore` used by this Preference. -or- Sets a `PreferenceDataStore` to be used by this Preference instead of using `android.content.SharedPreferences`. (Inherited from Preference)
PreferenceManager	Gets the `PreferenceManager` that manages this Preference object's tree. (Inherited from Preference)
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. (Inherited from Preference)
RootAdapter	Returns an adapter that can be attached to a `PreferenceActivity` or `PreferenceFragment` to show the preferences contained in this `PreferenceScreen`.
Selectable	Checks whether this Preference should be selectable in the list. -or- Sets whether this Preference is selectable. (Inherited from Preference)
SharedPreferences	Returns the `SharedPreferences` where this Preference can read its value(s). (Inherited from Preference)
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. (Inherited from Preference)
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. (Inherited from Preference)
Summary	(Inherited from Preference)
SummaryFormatted	Returns the summary of this Preference. -or- Sets the summary for this Preference with a CharSequence. (Inherited from Preference)
ThresholdClass	This API supports the Mono for Android infrastructure and is not intended to be used directly from your code. (Inherited from PreferenceGroup)
ThresholdType	This API supports the Mono for Android infrastructure and is not intended to be used directly from your code. (Inherited from PreferenceGroup)
Title	(Inherited from Preference)
TitleFormatted	Returns the title of this Preference. -or- Sets the title for this Preference with a CharSequence. (Inherited from Preference)
TitleRes	Returns the title resource ID of this Preference. (Inherited from 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. (Inherited from Preference)

Methods

AddItemFromInflater(Preference)	Called by the inflater to add an item to this group. (Inherited from PreferenceGroup)
AddPreference(Preference)	Adds a `Preference` at the correct position based on the preference's order. (Inherited from PreferenceGroup)
Bind(ListView)	Binds a `ListView` to the preferences contained in this `PreferenceScreen` via `#getRootAdapter()`.
CallChangeListener(Object)	Call this method after the user changes the preference, but before the internal state is set. (Inherited from Preference)
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. (Inherited from Preference)
DispatchRestoreInstanceState(Bundle)	Called by RestoreHierarchyState(Bundle) to retrieve the saved state for this Preference and its children. (Inherited from PreferenceGroup)
DispatchSaveInstanceState(Bundle)	Called by SaveHierarchyState(Bundle) to store the instance for this Preference and its children. (Inherited from PreferenceGroup)
Dispose()	(Inherited from Object)
Dispose(Boolean)	(Inherited from Object)
Equals(Object)	Indicates whether some other object is "equal to" this one. (Inherited from Object)
FindPreference(ICharSequence)	Finds a `Preference` based on its key. (Inherited from PreferenceGroup)
FindPreference(String)	Finds a `Preference` based on its key. (Inherited from PreferenceGroup)
FindPreferenceInHierarchy(String)	Finds a Preference in this hierarchy (the whole thing, even above/below your `PreferenceScreen` screen break) with the given key. (Inherited from Preference)
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. (Inherited from Preference)
GetPersistedFloat(Single)	Attempts to get a persisted float if this Preference is persistent. (Inherited from Preference)
GetPersistedInt(Int32)	Attempts to get a persisted int if this Preference is persistent. (Inherited from Preference)
GetPersistedLong(Int64)	Attempts to get a persisted long if this Preference is persistent. (Inherited from Preference)
GetPersistedString(String)	Attempts to get a persisted String if this Preference is persistent. (Inherited from Preference)
GetPersistedStringSet(ICollection<String>)	Attempts to get a persisted set of Strings if this Preference is persistent. (Inherited from Preference)
GetPreference(Int32)	Returns the `Preference` at a particular index. (Inherited from PreferenceGroup)
GetView(View, ViewGroup)	Gets the View that will be shown in the `PreferenceActivity`. (Inherited from Preference)
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. (Inherited from Preference)
NotifyDependencyChange(Boolean)	Notifies any listening dependents of a change that affects the dependency. (Inherited from Preference)
NotifyHierarchyChanged()	Should be called when a Preference has been added/removed from this group, or the ordering should be re-evaluated. (Inherited from Preference)
OnAttachedToActivity()	Called when the Preference hierarchy has been attached to the `PreferenceActivity`. (Inherited from Preference)
OnAttachedToHierarchy(PreferenceManager)	Called when this Preference has been attached to a Preference hierarchy. (Inherited from Preference)
OnBindView(View)	Binds the created View to the data for this Preference. (Inherited from Preference)
OnClick()	Processes a click on the preference. (Inherited from Preference)
OnCreateView(ViewGroup)	Creates the View to be shown for this Preference in the `PreferenceActivity`. (Inherited from Preference)
OnDependencyChanged(Preference, Boolean)	Called when the dependency changes. (Inherited from Preference)
OnDismiss(IDialogInterface)	This method will be invoked when the dialog is dismissed.
OnGetDefaultValue(TypedArray, Int32)	Called when a Preference is being inflated and the default value attribute needs to be read. (Inherited from Preference)
OnItemClick(AdapterView, View, Int32, Int64)
OnParentChanged(Preference, Boolean)	Called when the implicit parent dependency changes. (Inherited from Preference)
OnPrepareAddPreference(Preference)	Prepares a `Preference` to be added to the group. (Inherited from PreferenceGroup)
OnPrepareForRemoval()	Called when this Preference is being removed from the hierarchy. (Inherited from Preference)
OnRestoreInstanceState(IParcelable)	Hook allowing a Preference to re-apply a representation of its internal state that had previously been generated by `#onSaveInstanceState`. (Inherited from Preference)
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. (Inherited from Preference)
OnSetInitialValue(Boolean, Object)	Implement this to set the initial value of the Preference. (Inherited from Preference)
PeekExtras()	Return the extras Bundle object associated with this preference, returning `null` if there is not currently one. (Inherited from Preference)
PersistBoolean(Boolean)	Attempts to persist a boolean if this Preference is persistent. (Inherited from Preference)
PersistFloat(Single)	Attempts to persist a long if this Preference is persistent. (Inherited from Preference)
PersistInt(Int32)	Attempts to persist an int if this Preference is persistent. (Inherited from Preference)
PersistLong(Int64)	Attempts to persist a long if this Preference is persistent. (Inherited from Preference)
PersistString(String)	Attempts to persist a String if this Preference is persistent. (Inherited from Preference)
PersistStringSet(ICollection<String>)	Attempts to persist a set of Strings if this Preference is persistent. (Inherited from Preference)
RemoveAll()	Removes all `Preference Preferences` from this group. (Inherited from PreferenceGroup)
RemovePreference(Preference)	Removes a `Preference` from this group. (Inherited from PreferenceGroup)
RestoreHierarchyState(Bundle)	Restore this Preference hierarchy's previously saved state from the given container. (Inherited from Preference)
SaveHierarchyState(Bundle)	Store this Preference hierarchy's frozen state into the given container. (Inherited from Preference)
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. (Inherited from Preference)
SetHandle(IntPtr, JniHandleOwnership)	Sets the Handle property. (Inherited from Object)
SetIcon(Int32)	Sets the icon for this Preference with a resource ID. (Inherited from Preference)
SetSummary(Int32)	Sets the summary for this Preference with a resource ID. (Inherited from Preference)
SetTitle(Int32)	Sets the title for this Preference with a resource ID. (Inherited from Preference)
ShouldCommit()	Returns whether the `Preference` should commit its saved value(s) in `#getEditor()`. (Inherited from Preference)
ShouldDisableDependents()	Checks whether this preference's dependents should currently be disabled. (Inherited from Preference)
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. (Inherited from Preference)
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	(Inherited from Preference)
PreferenceClick	(Inherited from Preference)

Explicit Interface Implementations

IComparable.CompareTo(Object)	(Inherited from Preference)
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