Interface IFileTypeSettingsPage
This interface defines the interaction between a settings page that is implemented in Silverlight or WPF and the host application.
Inherited Members
Namespace: SdlSdl.FileTypeSupportFrameworkSdl.FileTypeSupport.Framework.CoreSettings
Assembly: Sdl.FileTypeSupport.Framework.Core.Settings.dll
Syntax
public interface IFileTypeSettingsPage : IAbstractSettingsPage, IDisposable
Properties
IsInitialized
The implementation should return true after Init(ISettingsBundle) has been called.
Declaration
bool IsInitialized { get; }
Property Value
Type | Description |
---|---|
bool |
SettingsBundle
The implementation should return the settings bundle passed in the Init(ISettingsBundle) method.
Declaration
ISettingsBundle SettingsBundle { get; }
Property Value
Type | Description |
---|---|
ISettingsBundle |
Methods
GetControl()
Declaration
Control GetControl()
Returns
Type | Description |
---|---|
Control |
Init(ISettingsBundle)
The framework calls this method after the settings page has been created, before it is used for the first time.
Declaration
void Init(ISettingsBundle settingsBundle)
Parameters
Type | Name | Description |
---|---|---|
ISettingsBundle | settingsBundle | The settings bundle in which settings are persisted. The implementation should store this value and make it accessible from the SettingsBundle property. The implementation should use settings from the bundle to initialize the user interface before returning the control from GetControl, and to persist changed settings in the Save() method. |
Remarks
This method will only be called once. The implementation may throw an exception if it is called multiple times.
File type specific settings need the configuration id to determine which settings group to access in the
settings bundle. This can be retrieved by implementing IFileTypeConfigurationAware. The framework
will set the configuration id before calling the Init()
method.