Search Results for

    Show / Hide Table of Contents

    Class SettingsGroup

    Inheritance
    object
    AbstractSettingsGroupBase
    SettingsGroup
    Implements
    ISettingsGroup
    INotifyPropertyChanged
    IEditableObject
    Inherited Members
    AbstractSettingsGroupBase._settingChangedDelegate
    AbstractSettingsGroupBase._propertyChangedDelegate
    AbstractSettingsGroupBase._parentEventHandlerAttached
    AbstractSettingsGroupBase._parentPropertyChangedEventHandlerAttached
    AbstractSettingsGroupBase._suspended
    AbstractSettingsGroupBase._suspendedEvents
    AbstractSettingsGroupBase.SuspendEvents()
    AbstractSettingsGroupBase.ResumeEvents()
    AbstractSettingsGroupBase.DiscardEvents()
    AbstractSettingsGroupBase.OnSettingChanged(string)
    AbstractSettingsGroupBase.OnSettingsChanged(IList<string>, bool)
    AbstractSettingsGroupBase.EventsSuspended
    AbstractSettingsGroupBase.SettingsChanged
    object.ToString()
    object.Equals(object)
    object.Equals(object, object)
    object.ReferenceEquals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    Namespace: Sdl.Core.Settings
    Assembly: Sdl.Core.Settings.dll
    Syntax
    public abstract class SettingsGroup : AbstractSettingsGroupBase, ISettingsGroup, INotifyPropertyChanged, IEditableObject

    Constructors

    SettingsGroup()

    Declaration
    protected SettingsGroup()

    Properties

    Id

    Declaration
    public override string Id { get; set; }
    Property Value
    Type Description
    string
    Overrides
    AbstractSettingsGroupBase.Id

    Parent

    Declaration
    public override ISettingsGroup Parent { get; }
    Property Value
    Type Description
    ISettingsGroup
    Overrides
    AbstractSettingsGroupBase.Parent

    SettingsBundle

    Declaration
    public override ISettingsBundle SettingsBundle { get; set; }
    Property Value
    Type Description
    ISettingsBundle
    Overrides
    AbstractSettingsGroupBase.SettingsBundle

    Methods

    BeginEdit()

    Declaration
    public override void BeginEdit()
    Overrides
    AbstractSettingsGroupBase.BeginEdit()

    CancelEdit()

    Declaration
    public override void CancelEdit()
    Overrides
    AbstractSettingsGroupBase.CancelEdit()

    CollectSettings(ISettingsGroup, List<string>)

    Declaration
    protected override void CollectSettings(ISettingsGroup settingsGroup, List<string> keys)
    Parameters
    Type Name Description
    ISettingsGroup settingsGroup
    List<string> keys
    Overrides
    AbstractSettingsGroupBase.CollectSettings(ISettingsGroup, List<string>)

    ContainsSetting(string)

    Declaration
    public override bool ContainsSetting(string settingId)
    Parameters
    Type Name Description
    string settingId
    Returns
    Type Description
    bool
    Overrides
    AbstractSettingsGroupBase.ContainsSetting(string)

    EndEdit()

    Declaration
    public override void EndEdit()
    Overrides
    AbstractSettingsGroupBase.EndEdit()

    GetDefaultValue(string)

    Declaration
    protected virtual object GetDefaultValue(string settingId)
    Parameters
    Type Name Description
    string settingId
    Returns
    Type Description
    object

    GetSettingIds()

    Declaration
    public override IEnumerable<string> GetSettingIds()
    Returns
    Type Description
    IEnumerable<string>
    Overrides
    AbstractSettingsGroupBase.GetSettingIds()

    GetSetting<T>(string)

    Declaration
    public override Setting<T> GetSetting<T>(string id)
    Parameters
    Type Name Description
    string id
    Returns
    Type Description
    Setting<T>
    Type Parameters
    Name Description
    T
    Overrides
    AbstractSettingsGroupBase.GetSetting<T>(string)

    GetSetting<T>(string, out Setting<T>)

    Declaration
    public override bool GetSetting<T>(string settingId, out Setting<T> setting)
    Parameters
    Type Name Description
    string settingId
    Setting<T> setting
    Returns
    Type Description
    bool
    Type Parameters
    Name Description
    T
    Overrides
    AbstractSettingsGroupBase.GetSetting<T>(string, out Setting<T>)

    GetSetting<T>(string, T)

    Declaration
    public override Setting<T> GetSetting<T>(string settingId, T defaultValue)
    Parameters
    Type Name Description
    string settingId
    T defaultValue
    Returns
    Type Description
    Setting<T>
    Type Parameters
    Name Description
    T
    Overrides
    AbstractSettingsGroupBase.GetSetting<T>(string, T)

    GetSetting<T>(string, out T)

    Declaration
    public override bool GetSetting<T>(string settingId, out T value)
    Parameters
    Type Name Description
    string settingId
    T value
    Returns
    Type Description
    bool
    Type Parameters
    Name Description
    T
    Overrides
    AbstractSettingsGroupBase.GetSetting<T>(string, out T)

    ImportSettings(ISettingsGroup)

    Declaration
    public override void ImportSettings(ISettingsGroup otherGroup)
    Parameters
    Type Name Description
    ISettingsGroup otherGroup
    Overrides
    AbstractSettingsGroupBase.ImportSettings(ISettingsGroup)

    OnInit(ISettingsBundle)

    Declaration
    protected virtual void OnInit(ISettingsBundle settingsBundle)
    Parameters
    Type Name Description
    ISettingsBundle settingsBundle

    RemoveSetting(string)

    Declaration
    public override bool RemoveSetting(string settingId)
    Parameters
    Type Name Description
    string settingId
    Returns
    Type Description
    bool
    Overrides
    AbstractSettingsGroupBase.RemoveSetting(string)

    Reset()

    Declaration
    public override void Reset()
    Overrides
    AbstractSettingsGroupBase.Reset()

    parent_PropertyChanged(object, PropertyChangedEventArgs)

    Declaration
    protected override void parent_PropertyChanged(object sender, PropertyChangedEventArgs e)
    Parameters
    Type Name Description
    object sender
    PropertyChangedEventArgs e
    Overrides
    AbstractSettingsGroupBase.parent_PropertyChanged(object, PropertyChangedEventArgs)

    parent_SettingsChanged(object, SettingsChangedEventArgs)

    Declaration
    protected override void parent_SettingsChanged(object sender, SettingsChangedEventArgs e)
    Parameters
    Type Name Description
    object sender
    SettingsChangedEventArgs e
    Overrides
    AbstractSettingsGroupBase.parent_SettingsChanged(object, SettingsChangedEventArgs)

    Events

    PropertyChanged

    Declaration
    public event PropertyChangedEventHandler PropertyChanged
    Event Type
    Type Description
    PropertyChangedEventHandler

    Implements

    ISettingsGroup
    INotifyPropertyChanged
    IEditableObject
    In this article
    • Constructors
      • SettingsGroup()
    • Properties
      • Id
      • Parent
      • SettingsBundle
    • Methods
      • BeginEdit()
      • CancelEdit()
      • CollectSettings(ISettingsGroup, List<string>)
      • ContainsSetting(string)
      • EndEdit()
      • GetDefaultValue(string)
      • GetSettingIds()
      • GetSetting<T>(string)
      • GetSetting<T>(string, out Setting<T>)
      • GetSetting<T>(string, T)
      • GetSetting<T>(string, out T)
      • ImportSettings(ISettingsGroup)
      • OnInit(ISettingsBundle)
      • RemoveSetting(string)
      • Reset()
      • parent_PropertyChanged(object, PropertyChangedEventArgs)
      • parent_SettingsChanged(object, SettingsChangedEventArgs)
    • Events
      • PropertyChanged
    • Implements
    Back to top Generated by DocFX