| AbstractFileTypeSettingsPageSettingsControlType, SettingsType Class |
Namespace: Sdl.FileTypeSupport.Framework.Core.Settings
public abstract class AbstractFileTypeSettingsPage<SettingsControlType, SettingsType> : AbstractSettingsPage, IFileTypeConfigurationAware where SettingsControlType : new() where SettingsType : new(), FileTypeSettingsBase
The AbstractFileTypeSettingsPageSettingsControlType, SettingsType type exposes the following members.
| Name | Description | |
|---|---|---|
| AbstractFileTypeSettingsPageSettingsControlType, SettingsType |
Default constructor, does not do anything
|
| Name | Description | |
|---|---|---|
| Control |
This property provides derived classes direct access to the
control, which may or may not yet have been created.
| |
| DataSource |
The object which the settings page will manipulate the values upon. This is typically an ISettingsBundle.
(Inherited from AbstractSettingsPage.) | |
| FileTypeConfigurationId |
Id of the file type that is being configured. This id can be used (as a key) to retrieve
the settings group representing the file type settings from a settings
bundle.
| |
| HasDefaultSettings |
Called to determine whether the settings page supports the ResetToDefaults method.
(Inherited from AbstractSettingsPage.) | |
| Settings |
The settings are created and initialized the first time
this property is accessed.
| |
| SettingsBundle |
The SettingsBundle which contains setting information for the page
| |
| SubContentFileTypeConfigurationIds |
List of FileTypeConfigurationIds of all subcontent processing file types
|
| Name | Description | |
|---|---|---|
| AfterCancel |
Called after all settings pages shown on the settings dialog have been canceled.
(Inherited from AbstractSettingsPage.) | |
| AfterSave |
Called after all settings pages shown on the settings dialog have been saved.
(Inherited from AbstractSettingsPage.) | |
| Cancel |
Called when the settings dialog is canceled.
(Inherited from AbstractSettingsPage.) | |
| CreateAndInitializeControl |
Called from GetControl when the control implementation is needed for the first time.
The implementation should create and initialize the control.
| |
| CreateAndInitializeSettings |
Called to create the settings the first time they are needed, typically
during the first call to GetControl.
| |
| Dispose |
Standard implementation of the Dispose method; calls Dispose(Boolean) with true
and suppresses finalization.
(Overrides AbstractSettingsPageDispose.) | |
| Dispose(Boolean) |
Override this method to perform additional clean-up tasks when the object is destroyed.
| |
| Finalize |
Finalizer calls Dispose(Boolean) with false (Overrides ObjectFinalize.) | |
| GetControl |
Called by the framework to obtain the user interface control.
(Overrides AbstractSettingsPageGetControl.) | |
| OnActivate |
Called when this settings page is activated.
(Inherited from AbstractSettingsPage.) | |
| OnDeactivate |
Called when this settings page is deactivated.
(Inherited from AbstractSettingsPage.) | |
| Refresh |
Called to re-populate the settings when the underlying data source has been changed externally. This
can happen when settings are imported, for example.
(Overrides AbstractSettingsPageRefresh.) | |
| ResetToDefaults |
Called to reset settings to their default values. Should update the user interface accordingly.
(Overrides AbstractSettingsPageResetToDefaults.) | |
| Save |
Called when settings should be saved. The implementation is responsible for persisting the settings.
(Overrides AbstractSettingsPageSave.) | |
| ValidateInput |
Returns true if the input on this settings page is valid.
(Inherited from AbstractSettingsPage.) |
Settings pages do not need to be derived from this class. However, if they follow standard patterns, deriving from this class can result in a simpler implementation.
To use this class in order to implement a file type settings page, take the following steps:
The default implementation of the settings page and the data binding will take care of everything else. Unless you require special processing for anything, there should be no need to override any of the methods and properties in this base class.