PreferenceScreen PreferenceScreen Class

Definition

Represents a top-level Preference that is the root of a Preference hierarchy.

[Android.Runtime.Register("android/preference/PreferenceScreen", ApiSince=1, DoNotGenerateAcw=true)]
public sealed class PreferenceScreen : Android.Preferences.PreferenceGroup, Android.Content.IDialogInterfaceOnDismissListener, Android.Widget.AdapterView.IOnItemClickListener, IDisposable
type PreferenceScreen = class
    inherit PreferenceGroup
    interface IDialogInterfaceOnDismissListener
    interface IJavaObject
    interface IDisposable
    interface AdapterView.IOnItemClickListener
Inheritance
Attributes
Implements

Remarks

Android platform documentation

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.

Properties

Class Class

Returns the unique instance of Class that represents this object's class.

(Inherited from Object)
Context Context

Returns the Context of this Preference.

(Inherited from Preference)
Dependency Dependency

Returns the key of the dependency on this Preference.

(Inherited from Preference)
Dialog Dialog

Used to get a handle to the dialog.

Editor Editor

Returns an ISharedPreferencesEditor where this Preference can save its value(s).

(Inherited from Preference)
Enabled Enabled

Checks whether this Preference should be enabled in the list.

(Inherited from Preference)
Extras Extras

Return the extras Bundle object associated with this preference, creating a new Bundle if there currently isn't one.

(Inherited from Preference)
Fragment Fragment

Return the fragment class name associated with this Preference.

(Inherited from Preference)
Handle Handle

The handle to the underlying Android instance.

(Inherited from Object)
HasKey HasKey

Checks whether this Preference has a valid key.

(Inherited from Preference)
Icon Icon

Returns the icon of this Preference.

(Inherited from Preference)
IconSpaceReserved IconSpaceReserved Inherited from Preference
IJavaObjectEx.IsProxy IJavaObjectEx.IsProxy Inherited from Object
IJavaObjectEx.KeyHandle IJavaObjectEx.KeyHandle Inherited from Object
IJavaObjectEx.NeedsActivation IJavaObjectEx.NeedsActivation Inherited from Object
IJavaPeerable.JniManagedPeerState IJavaPeerable.JniManagedPeerState Inherited from Object
Intent Intent

Return the Intent associated with this Preference.

(Inherited from Preference)
IsOnSameScreenAsChildren IsOnSameScreenAsChildren

Whether this preference group should be shown on the same screen as its contained preferences.

(Inherited from PreferenceGroup)
JniIdentityHashCode JniIdentityHashCode Inherited from Object
JniPeerMembers JniPeerMembers
Key Key

Gets the key for this Preference, which is also the key used for storing values into SharedPreferences.

(Inherited from Preference)
LayoutResource LayoutResource

Gets the layout resource that will be shown as the View for this Preference.

(Inherited from Preference)
OnPreferenceChangeListener OnPreferenceChangeListener

Returns 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 OnPreferenceClickListener

Returns the callback to be invoked when this Preference is clicked.

(Inherited from Preference)
Order Order

Gets the order of this Preference with respect to other Preference objects on the same level.

(Inherited from Preference)
OrderingAsAdded OrderingAsAdded

Whether this group is ordering preferences in the order they are added.

(Inherited from PreferenceGroup)
Parent Parent Inherited from Preference
PeerReference PeerReference Inherited from Object
Persistent Persistent

Checks whether this Preference is persistent.

(Inherited from Preference)
PreferenceCount PreferenceCount

Returns the number of children Preferences.

(Inherited from PreferenceGroup)
PreferenceDataStore PreferenceDataStore Inherited from Preference
PreferenceManager PreferenceManager

Gets the PreferenceManager that manages this Preference object's tree.

(Inherited from Preference)
RecycleEnabled RecycleEnabled Inherited from Preference
RootAdapter RootAdapter

Returns an adapter that can be attached to a PreferenceActivity or PreferenceFragment to show the preferences contained in this PreferenceScreen.

Selectable Selectable

Checks whether this Preference should be selectable in the list.

(Inherited from Preference)
SharedPreferences SharedPreferences

Returns the ISharedPreferences where this Preference can read its value(s).

(Inherited from Preference)
ShouldDisableView ShouldDisableView

Checks whether this Preference should disable its view when it's action is disabled.

(Inherited from Preference)
SingleLineTitle SingleLineTitle Inherited from Preference
Summary Summary Inherited from Preference
SummaryFormatted SummaryFormatted

Returns the summary of this Preference.

(Inherited from Preference)
ThresholdClass ThresholdClass

This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.

(Inherited from PreferenceGroup)
ThresholdType ThresholdType

This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.

(Inherited from PreferenceGroup)
Title Title Inherited from Preference
TitleFormatted TitleFormatted

Returns the title of this Preference.

(Inherited from Preference)
TitleRes TitleRes

Returns the title resource ID of this Preference.

(Inherited from Preference)
WidgetLayoutResource WidgetLayoutResource

Gets the layout resource for the controllable widget portion of this Preference.

(Inherited from Preference)

Methods

AddItemFromInflater(Preference) AddItemFromInflater(Preference)

Called by the inflater to add an item to this group.

(Inherited from PreferenceGroup)
AddPreference(Preference) AddPreference(Preference)

Adds a Preference at the correct position based on the preference's order.

(Inherited from PreferenceGroup)
Bind(ListView) Bind(ListView)

Binds a ListView to the preferences contained in this PreferenceScreen via RootAdapter.

CallChangeListener(Object) CallChangeListener(Object)

Call this method after the user changes the preference, but before the internal state is set.

(Inherited from Preference)
Clone() Clone()

Creates and returns a copy of this Object.

(Inherited from Object)
CompareTo(Preference) CompareTo(Preference)

Compares Preference objects based on order (if set), otherwise alphabetically on the titles.

(Inherited from Preference)
DispatchRestoreInstanceState(Bundle) DispatchRestoreInstanceState(Bundle)

Called by RestoreHierarchyState(Bundle) to retrieve the saved state for this Preference and its children.

(Inherited from PreferenceGroup)
DispatchSaveInstanceState(Bundle) DispatchSaveInstanceState(Bundle)

Called by SaveHierarchyState(Bundle) to store the instance for this Preference and its children.

(Inherited from PreferenceGroup)
Dispose() Dispose() Inherited from Object
Dispose(Boolean) Dispose(Boolean) Inherited from Object
Equals(Object) Equals(Object)

Compares this instance with the specified object and indicates if they are equal.

(Inherited from Object)
FindPreference(ICharSequence) FindPreference(ICharSequence)

Finds a Preference based on its key.

(Inherited from PreferenceGroup)
FindPreference(String) FindPreference(String) Inherited from PreferenceGroup
FindPreferenceInHierarchy(String) 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() GetHashCode()

Returns an integer hash code for this object.

(Inherited from Object)
GetPersistedBoolean(Boolean) GetPersistedBoolean(Boolean)

Attempts to get a persisted boolean from the ISharedPreferences.

(Inherited from Preference)
GetPersistedFloat(Single) GetPersistedFloat(Single)

Attempts to get a persisted float from the ISharedPreferences.

(Inherited from Preference)
GetPersistedInt(Int32) GetPersistedInt(Int32)

Attempts to get a persisted int from the ISharedPreferences.

(Inherited from Preference)
GetPersistedLong(Int64) GetPersistedLong(Int64)

Attempts to get a persisted long from the ISharedPreferences.

(Inherited from Preference)
GetPersistedString(String) GetPersistedString(String)

Attempts to get a persisted String from the ISharedPreferences.

(Inherited from Preference)
GetPersistedStringSet(ICollection<String>) GetPersistedStringSet(ICollection<String>) Inherited from Preference
GetPreference(Int32) GetPreference(Int32)

Returns the Preference at a particular index.

(Inherited from PreferenceGroup)
GetView(View, ViewGroup) GetView(View, ViewGroup)

Gets the View that will be shown in the PreferenceActivity.

(Inherited from Preference)
JavaFinalize() JavaFinalize()

Invoked when the garbage collector has detected that this instance is no longer reachable.

(Inherited from Object)
Notify() Notify()

Causes a thread which is waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.

(Inherited from Object)
NotifyAll() NotifyAll()

Causes all threads which are waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.

(Inherited from Object)
NotifyChanged() NotifyChanged()

Should be called when the data of this Preference has changed.

(Inherited from Preference)
NotifyDependencyChange(Boolean) NotifyDependencyChange(Boolean)

Notifies any listening dependents of a change that affects the dependency.

(Inherited from Preference)
NotifyHierarchyChanged() 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() OnAttachedToActivity()

Called when the Preference hierarchy has been attached to the PreferenceActivity.

(Inherited from Preference)
OnAttachedToHierarchy(PreferenceManager) OnAttachedToHierarchy(PreferenceManager)

Called when this Preference has been attached to a Preference hierarchy.

(Inherited from Preference)
OnBindView(View) OnBindView(View)

Binds the created View to the data for this Preference.

(Inherited from Preference)
OnClick() OnClick()

Processes a click on the preference.

(Inherited from Preference)
OnCreateView(ViewGroup) OnCreateView(ViewGroup)

Creates the View to be shown for this Preference in the PreferenceActivity.

(Inherited from Preference)
OnDependencyChanged(Preference, Boolean) OnDependencyChanged(Preference, Boolean)

Called when the dependency changes.

(Inherited from Preference)
OnDismiss(IDialogInterface) OnDismiss(IDialogInterface)

This method will be invoked when the dialog is dismissed.

OnGetDefaultValue(TypedArray, Int32) 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) OnItemClick(AdapterView, View, Int32, Int64)
OnParentChanged(Preference, Boolean) OnParentChanged(Preference, Boolean)

Called when the implicit parent dependency changes.

(Inherited from Preference)
OnPrepareAddPreference(Preference) OnPrepareAddPreference(Preference)

Prepares a Preference to be added to the group.

(Inherited from PreferenceGroup)
OnPrepareForRemoval() OnPrepareForRemoval()

Called when this Preference is being removed from the hierarchy.

(Inherited from Preference)
OnRestoreInstanceState(IParcelable) 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() 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) OnSetInitialValue(Boolean, Object)

Implement this to set the initial value of the Preference.

(Inherited from Preference)
PeekExtras() PeekExtras()

Return the extras Bundle object associated with this preference, returning null if there is not currently one.

(Inherited from Preference)
PersistBoolean(Boolean) PersistBoolean(Boolean)

Attempts to persist a boolean to the ISharedPreferences.

(Inherited from Preference)
PersistFloat(Single) PersistFloat(Single)

Attempts to persist a float to the ISharedPreferences.

(Inherited from Preference)
PersistInt(Int32) PersistInt(Int32)

Attempts to persist an int to the ISharedPreferences.

(Inherited from Preference)
PersistLong(Int64) PersistLong(Int64)

Attempts to persist a long to the ISharedPreferences.

(Inherited from Preference)
PersistString(String) PersistString(String)

Attempts to persist a String to the ISharedPreferences.

(Inherited from Preference)
PersistStringSet(ICollection<String>) PersistStringSet(ICollection<String>) Inherited from Preference
RemoveAll() RemoveAll()

Removes all Preference from this group.

(Inherited from PreferenceGroup)
RemovePreference(Preference) RemovePreference(Preference)

Removes a Preference from this group.

(Inherited from PreferenceGroup)
RestoreHierarchyState(Bundle) RestoreHierarchyState(Bundle)

Restore this Preference hierarchy's previously saved state from the given container.

(Inherited from Preference)
SaveHierarchyState(Bundle) SaveHierarchyState(Bundle)

Store this Preference hierarchy's frozen state into the given container.

(Inherited from Preference)
SetDefaultValue(Object) 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) SetHandle(IntPtr, JniHandleOwnership)

Sets the Handle property.

(Inherited from Object)
SetIcon(Int32) SetIcon(Int32)

Sets the icon for this Preference with a resource ID.

(Inherited from Preference)
SetSummary(Int32) SetSummary(Int32)

Sets the summary for this Preference with a resource ID.

(Inherited from Preference)
SetTitle(Int32) SetTitle(Int32)

Sets the title for this Preference with a resource ID.

(Inherited from Preference)
ShouldCommit() ShouldCommit()

Returns whether the Preference should commit its saved value(s) in Editor.

(Inherited from Preference)
ShouldDisableDependents() ShouldDisableDependents()

Checks whether this preference's dependents should currently be disabled.

(Inherited from Preference)
ShouldPersist() ShouldPersist()

Checks whether, at the given time this method is called, this Preference should store/restore its value(s) into the ISharedPreferences.

(Inherited from Preference)
ToArray<T>() ToArray<T>() Inherited from Object
ToString() ToString()

Returns a string containing a concise, human-readable description of this object.

(Inherited from Object)
UnregisterFromRuntime() UnregisterFromRuntime() Inherited from Object
Wait() Wait()

Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object.

(Inherited from Object)
Wait(Int64) Wait(Int64)

Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.

(Inherited from Object)
Wait(Int64, Int32) Wait(Int64, Int32)

Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.

(Inherited from Object)

Fields

DefaultOrder DefaultOrder

Specify for Order if a specific order is not required.

(Inherited from Preference)

Explicit Interface Implementations

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

Events

PreferenceChange PreferenceChange Inherited from Preference
PreferenceClick PreferenceClick Inherited from Preference

Extension Methods

JavaCast<TResult>(IJavaObject) JavaCast<TResult>(IJavaObject)

Performs an Android runtime-checked type conversion.

JavaCast<TResult>(IJavaObject) JavaCast<TResult>(IJavaObject)
GetJniTypeName(IJavaPeerable) GetJniTypeName(IJavaPeerable)

Applies to