IPreferencesService Interface
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.
Provides functionality for modules and pages to store preference information.
public interface class IPreferencesServicepublic interface IPreferencesServicetype IPreferencesService = interfacePublic Interface IPreferencesServiceRemarks
All objects that support per-user client settings should use this service. The preference service saves default values for column sizes, check box states, and other client settings.
Methods
| GetPreferencesStore(Guid) |
Returns the preference store instance that is associated with the specified identifier, or creates a new empty store if a store does not already exist. |
| GetPreferencesStore(Guid, PreferencesStore) |
Returns the preference store instance, if one exists, that is associated with the specified identifier. |
| ResetPreferencesStore(Guid) |
Deletes the preference store and all the data it contains. |
| Save() |
Saves the preferences. |
Applies to
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for