| SettingsGroup Class |
Abstract class providing common functionality for settings group
concrete implementations
Inheritance HierarchyNamespace: Sdl.Core.Settings
Assembly: Sdl.Core.Settings (in Sdl.Core.Settings.dll) Version: 1.8.0.0 (1.8.2564.0)
SyntaxThe SettingsGroup type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SettingsGroup |
Initializes a new instance of the SettingsGroup class.
|
Methods| Name | Description | |
|---|---|---|
| BeginEdit |
Begins and edit on an object
|
| CancelEdit |
Discards changes since the last System.ComponentModel.IEditableObject.BeginEdit() call.
|
| ContainsSetting |
Returns true if settingId is found in the current settings collection
or in any ancestor's settings collection
|
| EndEdit |
Pushes changes since the last System.ComponentModel.IEditableObject.BeginEdit() or
System.ComponentModel.IBindingList.AddNew() call into the underlying object.
|
| Equals | (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetDefaultValue |
Gets the default value for the sepcified settings. Always returns null.
Override this method in extending classes to define default setting values.
|
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetSettingT(String) |
Gets the setting with the specified id.
|
| GetSettingT(String, SettingT) |
Gets the setting with the specified id.
|
| GetSettingT(String, T) |
Gets the setting with the specified id.
|
| GetSettingT(String, T) |
Gets the setting with the specified id.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| ImportSettings |
Imports the settings from another group into this one. Resets the current settings before
importing the settings from the other group.
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| OnInit |
Called when SettingsBungle is set.
|
| OnSettingsChanged |
Called when a number of setting values change.
|
| RemoveSetting |
Removes a local setting from the this group. Returns true if the setting was successfully removed, false otherwise.
i.e. if the setting doesn't exist, false is returned.
|
| Reset |
Resets all settings locally defined in this settings group.
|
| ResumeEvents |
Resumes event notification. This raises the SettingsChanged event once this method
has been called an equal amount of times as SuspendEvents.
|
| SuspendEvents |
Suspends event notification.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Properties| Name | Description | |
|---|---|---|
 | EventsSuspended |
True if event notifications have been suspended.
|
| Id |
Gets the id of the settings group.
|
| Parent |
Gets the parent settings group in the parent bundle, or null if this settings group belongs to the root settings bundle.
|
| SettingsBundle |
The settings bundle this group belongs to
|
Events| Name | Description | |
|---|---|---|
 | PropertyChanged |
Raised when a property value changes.
|
| SettingsChanged |
Raised when a setting value changes.
|
See AlsoReference
CommunityComments