Click or drag to resize
DefaultSettingsPageTControl, TSettings Class
Default implementation for AutomaticTask settings page.
Inheritance Hierarchy
SystemObject
  Sdl.Core.SettingsAbstractSettingsPage
    Sdl.Desktop.IntegrationApiDefaultSettingsPageTControl, TSettings

Namespace: Sdl.Desktop.IntegrationApi
Assembly: Sdl.Desktop.IntegrationApi (in Sdl.Desktop.IntegrationApi.dll) Version: 4.0.0.0 (4.2.2764.0)
Syntax
public class DefaultSettingsPage<TControl, TSettings> : AbstractSettingsPage
where TControl : new(), UserControl, ISettingsAware<TSettings>
where TSettings : new(), SettingsGroup

Type Parameters

TControl
TSettings

The DefaultSettingsPageTControl, TSettings type exposes the following members.

Constructors
  NameDescription
Public methodDefaultSettingsPageTControl, TSettings
Initializes a new instance of the DefaultSettingsPageTControl, TSettings class
Top
Properties
  NameDescription
Public propertyDataSource
The object which the settings page will manipulate the values upon. This is typically an ISettingsBundle.
(Inherited from AbstractSettingsPage.)
Public propertyHasDefaultSettings
Called to determine whether the settings page supports the ResetToDefaults method.
(Inherited from AbstractSettingsPage.)
Public propertySettings
Gets the settings associated with this settings page.
Public propertySettingsBundle
Helper get function to cast the datasource to ISettingsBundle
Top
Methods
  NameDescription
Public methodAfterCancel
Called after all settings pages shown on the settings dialog have been canceled.
(Inherited from AbstractSettingsPage.)
Public methodAfterSave
Called after all settings pages shown on the settings dialog have been saved.
(Inherited from AbstractSettingsPage.)
Public methodCancel
Cancels the settings data editing.
(Overrides AbstractSettingsPageCancel.)
Public methodDispose
Dispose the settings page.
(Overrides AbstractSettingsPageDispose.)
Public methodGetControl
Makes sure a UI control is created for the seetings
(Overrides AbstractSettingsPageGetControl.)
Public methodOnActivate
Called when this settings page is activated.
(Inherited from AbstractSettingsPage.)
Public methodOnDeactivate
Called when this settings page is deactivated.
(Inherited from AbstractSettingsPage.)
Public methodRefresh
Called to refresh the page to the current DataSource if it has been changed externally. This can happen when a user imports external settings that affect the data source.
(Inherited from AbstractSettingsPage.)
Public methodResetToDefaults
Responds to the framework to restore all the settings to default values.
(Overrides AbstractSettingsPageResetToDefaults.)
Public methodSave
Saves the the settings data permantly.
(Overrides AbstractSettingsPageSave.)
Public methodValidateInput
Calls the controlls ValidateChildren function to cause the validation to be issued.
(Overrides AbstractSettingsPageValidateInput.)
Top
See Also
Community
Edit

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