| 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 | |
|---|---|---|
| AfterCancel | (Inherited from AbstractSettingsPage.) | |
| AfterSave | (Inherited from AbstractSettingsPage.) | |
| Cancel | (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 AbstractSettingsPage.Dispose.) | |
| Dispose(Boolean) |
Override this method to perform additional clean-up tasks when the object is destroyed.
| |
| Equals | (Inherited from Object.) | |
| Finalize |
Finalizer calls Dispose(Boolean) with false (Overrides ObjectFinalize.) | |
| GetControl |
Called by the framework to obtain the user interface control.
(Overrides AbstractSettingsPage.GetControl.) | |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) | |
| GetType | Gets the Type of the current instance. (Inherited from Object.) | |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
| OnActivate | (Inherited from AbstractSettingsPage.) | |
| OnDeactivate | (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 AbstractSettingsPage.Refresh.) | |
| ResetToDefaults |
Called to reset settings to their default values. Should update the user interface accordingly.
(Overrides AbstractSettingsPage.ResetToDefaults.) | |
| Save |
Called when settings should be saved. The implementation is responsible for persisting the settings.
(Overrides AbstractSettingsPage.Save.) | |
| ToString | Returns a string that represents the current object. (Inherited from Object.) | |
| ValidateInput | (Inherited from AbstractSettingsPage.) |
| Name | Description | |
|---|---|---|
| Control |
This property provides derived classes direct access to the
control, which may or may not yet have been created.
| |
| DataSource | (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 | (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
|
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.