Search Results for

    Show / Hide Table of Contents

    Class DefaultSettingsPage<TControl, TSettings>

    Default implementation for AutomaticTask settings page.

    Inheritance
    object
    AbstractSettingsPage
    DefaultSettingsPage<TControl, TSettings>
    Implements
    ISettingsPage
    IDisposable
    Inherited Members
    AbstractSettingsPage.OnActivate()
    AbstractSettingsPage.OnDeactivate()
    AbstractSettingsPage.AfterSave()
    AbstractSettingsPage.AfterCancel()
    AbstractSettingsPage.Refresh()
    AbstractSettingsPage.DataSource
    AbstractSettingsPage.HasDefaultSettings
    object.ToString()
    object.Equals(object)
    object.Equals(object, object)
    object.ReferenceEquals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    Namespace: Sdl.Desktop.IntegrationApi
    Assembly: Sdl.Desktop.IntegrationApi.dll
    Syntax
    public class DefaultSettingsPage<TControl, TSettings> : AbstractSettingsPage, ISettingsPage, IDisposable where TControl : IUISettingsControl, ISettingsAware<TSettings>, new() where TSettings : SettingsGroup, new()
    Type Parameters
    Name Description
    TControl
    TSettings

    Constructors

    DefaultSettingsPage()

    Declaration
    public DefaultSettingsPage()

    Properties

    Settings

    Gets the settings associated with this settings page.

    Declaration
    public TSettings Settings { get; }
    Property Value
    Type Description
    TSettings

    SettingsBundle

    Helper get function to cast the datasource to ISettingsBundle

    Declaration
    public ISettingsBundle SettingsBundle { get; }
    Property Value
    Type Description
    ISettingsBundle

    Methods

    Cancel()

    Cancels the settings data editing.

    Declaration
    public override void Cancel()
    Overrides
    AbstractSettingsPage.Cancel()

    Dispose()

    Dispose the settings page.

    Declaration
    public override void Dispose()
    Overrides
    AbstractSettingsPage.Dispose()

    GetControl()

    Makes sure a UI control is created for the seetings

    Declaration
    public override object GetControl()
    Returns
    Type Description
    object
    Overrides
    AbstractSettingsPage.GetControl()

    ResetToDefaults()

    Responds to the framework to restore all the settings to default values.

    Declaration
    public override void ResetToDefaults()
    Overrides
    AbstractSettingsPage.ResetToDefaults()

    Save()

    Saves the the settings data permantly.

    Declaration
    public override void Save()
    Overrides
    AbstractSettingsPage.Save()

    ValidateInput()

    Calls the controlls ValidateChildren function to cause the validation to be issued.

    Declaration
    public override bool ValidateInput()
    Returns
    Type Description
    bool
    Overrides
    AbstractSettingsPage.ValidateInput()

    Implements

    ISettingsPage
    IDisposable

    Extension Methods

    WindowsControlUtils.ForWindowFromFrameworkElement(object, Action<Window>)
    In this article
    • Constructors
      • DefaultSettingsPage()
    • Properties
      • Settings
      • SettingsBundle
    • Methods
      • Cancel()
      • Dispose()
      • GetControl()
      • ResetToDefaults()
      • Save()
      • ValidateInput()
    • Implements
    • Extension Methods
    Back to top Generated by DocFX