Click or drag to resize
FileTypeSettingsBase Class
This base class defines the common operations for settings objects used for processing a given file type.
Inheritance Hierarchy

Namespace: Sdl.FileTypeSupport.Framework.Core.Settings
Assembly: Sdl.FileTypeSupport.Framework.Core.Settings (in Sdl.FileTypeSupport.Framework.Core.Settings.dll) Version: 1.0.0.0 (1.0.2551.2)
Syntax
public abstract class FileTypeSettingsBase : INotifyPropertyChanged

The FileTypeSettingsBase type exposes the following members.

Constructors
  NameDescription
Protected methodFileTypeSettingsBase
Initializes a new instance of the FileTypeSettingsBase class
Top
Methods
  NameDescription
Protected methodGetSettingFromSettingsGroupT
Checks whether the setting exists in the settings group, and retrieves its value (if it exists). If it does not exist, the default value is returned instead.
Protected methodOnPropertyChanged
Fires the PropertyChanged event with the propertyName used as the event argument. This needs to be called from the setter of every property when using binding (for example, in Silverlight/WPF UIs).
Public methodPopulateFromSettingsBundle
Populates the settings for a specific file type configuration.
Public methodResetToDefaults
Restore all settings to default values.
Public methodSaveToSettingsBundle
Stores settings for a specified file type configuration.
Protected methodUpdateSettingInSettingsGroupT
Checks whether the setting exists in the settings group. If the setting does exist, then it is updated with the new value; if it does not exist, a new setting is created, but only if the value is not the same as the default value (in which case the call is effectively ignored).
Top
Events
  NameDescription
Public eventPropertyChanged
All property setters must fire this event if data binding is to be used. The recommended approach is to use OnPropertyChanged(String).
Top
Remarks

Settings implementations are not required to implement this class, but it is recommended.

The INotifyPropertyChanged interface facilitates dynamic UI updates for operations such as ResetToDefaults if data binding is used. Note that for this to work properly, all relevant property setters must raise the PropertyChanged event or call OnPropertyChanged(String).

See Also
Community
Edit

Be the first to Edit the community content of this topic.
Comments