Search Results for

    Show / Hide Table of Contents

    Class AbstractSettingsGroupBase

    Inheritance
    System.Object
    AbstractSettingsGroupBase
    JsonSettingsGroup
    SettingsGroup
    Implements
    ISettingsGroup
    System.ComponentModel.INotifyPropertyChanged
    System.ComponentModel.IEditableObject
    Inherited Members
    System.Object.ToString()
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    Namespace: Sdl.Core.Settings
    Assembly: Sdl.Core.Settings.dll
    Syntax
    public abstract class AbstractSettingsGroupBase : ISettingsGroup, INotifyPropertyChanged, IEditableObject

    Constructors

    AbstractSettingsGroupBase()

    Declaration
    protected AbstractSettingsGroupBase()

    Fields

    _parentEventHandlerAttached

    Declaration
    protected bool _parentEventHandlerAttached
    Field Value
    Type Description
    System.Boolean

    _parentPropertyChangedEventHandlerAttached

    Declaration
    protected bool _parentPropertyChangedEventHandlerAttached
    Field Value
    Type Description
    System.Boolean

    _propertyChangedDelegate

    Declaration
    protected PropertyChangedEventHandler _propertyChangedDelegate
    Field Value
    Type Description
    System.ComponentModel.PropertyChangedEventHandler

    _settingChangedDelegate

    Declaration
    protected EventHandler<SettingsChangedEventArgs> _settingChangedDelegate
    Field Value
    Type Description
    System.EventHandler<SettingsChangedEventArgs>

    _suspended

    Declaration
    protected int _suspended
    Field Value
    Type Description
    System.Int32

    _suspendedEvents

    Declaration
    protected List<string> _suspendedEvents
    Field Value
    Type Description
    System.Collections.Generic.List<System.String>

    Properties

    EventsSuspended

    Declaration
    public bool EventsSuspended { get; }
    Property Value
    Type Description
    System.Boolean

    Id

    Declaration
    public abstract string Id { get; set; }
    Property Value
    Type Description
    System.String

    Parent

    Declaration
    public abstract ISettingsGroup Parent { get; }
    Property Value
    Type Description
    ISettingsGroup

    SettingsBundle

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

    Methods

    BeginEdit()

    Declaration
    public abstract void BeginEdit()

    CancelEdit()

    Declaration
    public abstract void CancelEdit()

    CollectSettings(ISettingsGroup, List<String>)

    Declaration
    protected abstract void CollectSettings(ISettingsGroup settingsGroup, List<string> keys)
    Parameters
    Type Name Description
    ISettingsGroup settingsGroup
    System.Collections.Generic.List<System.String> keys

    ContainsSetting(String)

    Declaration
    public abstract bool ContainsSetting(string settingId)
    Parameters
    Type Name Description
    System.String settingId
    Returns
    Type Description
    System.Boolean

    DiscardEvents()

    Declaration
    protected void DiscardEvents()

    EndEdit()

    Declaration
    public abstract void EndEdit()

    GetSetting<T>(String)

    Declaration
    public abstract Setting<T> GetSetting<T>(string id)
    Parameters
    Type Name Description
    System.String id
    Returns
    Type Description
    Setting<T>
    Type Parameters
    Name Description
    T

    GetSetting<T>(String, T)

    Declaration
    public abstract Setting<T> GetSetting<T>(string settingId, T defaultValue)
    Parameters
    Type Name Description
    System.String settingId
    T defaultValue
    Returns
    Type Description
    Setting<T>
    Type Parameters
    Name Description
    T

    GetSetting<T>(String, out T)

    Declaration
    public abstract bool GetSetting<T>(string settingId, out T value)
    Parameters
    Type Name Description
    System.String settingId
    T value
    Returns
    Type Description
    System.Boolean
    Type Parameters
    Name Description
    T

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

    Declaration
    public abstract bool GetSetting<T>(string settingId, out Setting<T> setting)
    Parameters
    Type Name Description
    System.String settingId
    Setting<T> setting
    Returns
    Type Description
    System.Boolean
    Type Parameters
    Name Description
    T

    GetSettingIds()

    Declaration
    public abstract IEnumerable<string> GetSettingIds()
    Returns
    Type Description
    System.Collections.Generic.IEnumerable<System.String>

    ImportSettings(ISettingsGroup)

    Declaration
    public abstract void ImportSettings(ISettingsGroup otherGroup)
    Parameters
    Type Name Description
    ISettingsGroup otherGroup

    OnSettingChanged(String)

    Declaration
    protected virtual void OnSettingChanged(string settingId)
    Parameters
    Type Name Description
    System.String settingId

    OnSettingsChanged(IList<String>, Boolean)

    Declaration
    protected virtual void OnSettingsChanged(IList<string> settingIds, bool isResumingEvents)
    Parameters
    Type Name Description
    System.Collections.Generic.IList<System.String> settingIds
    System.Boolean isResumingEvents

    parent_PropertyChanged(Object, PropertyChangedEventArgs)

    Declaration
    protected abstract void parent_PropertyChanged(object sender, PropertyChangedEventArgs e)
    Parameters
    Type Name Description
    System.Object sender
    System.ComponentModel.PropertyChangedEventArgs e

    parent_SettingsChanged(Object, SettingsChangedEventArgs)

    Declaration
    protected abstract void parent_SettingsChanged(object sender, SettingsChangedEventArgs e)
    Parameters
    Type Name Description
    System.Object sender
    SettingsChangedEventArgs e

    RemoveSetting(String)

    Declaration
    public abstract bool RemoveSetting(string settingId)
    Parameters
    Type Name Description
    System.String settingId
    Returns
    Type Description
    System.Boolean

    Reset()

    Declaration
    public abstract void Reset()

    ResumeEvents()

    Declaration
    public void ResumeEvents()

    SuspendEvents()

    Declaration
    public void SuspendEvents()

    Events

    PropertyChanged

    Declaration
    public event PropertyChangedEventHandler PropertyChanged
    Event Type
    Type Description
    System.ComponentModel.PropertyChangedEventHandler

    SettingsChanged

    Declaration
    public event EventHandler<SettingsChangedEventArgs> SettingsChanged
    Event Type
    Type Description
    System.EventHandler<SettingsChangedEventArgs>

    Implements

    ISettingsGroup
    System.ComponentModel.INotifyPropertyChanged
    System.ComponentModel.IEditableObject

    On this page

    • Constructors
      • AbstractSettingsGroupBase()
    • Fields
      • _parentEventHandlerAttached
      • _parentPropertyChangedEventHandlerAttached
      • _propertyChangedDelegate
      • _settingChangedDelegate
      • _suspended
      • _suspendedEvents
    • Properties
      • EventsSuspended
      • Id
      • Parent
      • SettingsBundle
    • Methods
      • BeginEdit()
      • CancelEdit()
      • CollectSettings(ISettingsGroup, List<String>)
      • ContainsSetting(String)
      • DiscardEvents()
      • EndEdit()
      • GetSetting<T>(String)
      • GetSetting<T>(String, T)
      • GetSetting<T>(String, out T)
      • GetSetting<T>(String, out Setting<T>)
      • GetSettingIds()
      • ImportSettings(ISettingsGroup)
      • OnSettingChanged(String)
      • OnSettingsChanged(IList<String>, Boolean)
      • parent_PropertyChanged(Object, PropertyChangedEventArgs)
      • parent_SettingsChanged(Object, SettingsChangedEventArgs)
      • RemoveSetting(String)
      • Reset()
      • ResumeEvents()
      • SuspendEvents()
    • Events
      • PropertyChanged
      • SettingsChanged
    • Implements
    Back to top Generated by DocFX