Class AbstractSettingsGroupBase

Inheritance
object
AbstractSettingsGroupBase
JsonSettingsGroup
SettingsGroup
Implements
Inherited Members
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
bool

_parentPropertyChangedEventHandlerAttached

Declaration
protected bool _parentPropertyChangedEventHandlerAttached
Field Value
Type Description
bool

_propertyChangedDelegate

Declaration
protected PropertyChangedEventHandler _propertyChangedDelegate
Field Value
Type Description
PropertyChangedEventHandler

_settingChangedDelegate

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

_suspended

Declaration
protected int _suspended
Field Value
Type Description
int

_suspendedEvents

Declaration
protected List<string> _suspendedEvents
Field Value
Type Description
List<string>

Properties

EventsSuspended

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

Id

Declaration
public abstract string Id { get; set; }
Property Value
Type Description
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
List<string> keys

ContainsSetting(string)

Declaration
public abstract bool ContainsSetting(string settingId)
Parameters
Type Name Description
string settingId
Returns
Type Description
bool

DiscardEvents()

Declaration
protected void DiscardEvents()

EndEdit()

Declaration
public abstract void EndEdit()

GetSettingIds()

Declaration
public abstract IEnumerable<string> GetSettingIds()
Returns
Type Description
IEnumerable<string>

GetSetting<T>(string)

Declaration
public abstract Setting<T> GetSetting<T>(string id)
Parameters
Type Name Description
string id
Returns
Type Description
Setting<T>
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
string settingId
Setting<T> setting
Returns
Type Description
bool
Type Parameters
Name Description
T

GetSetting<T>(string, T)

Declaration
public abstract 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

GetSetting<T>(string, out T)

Declaration
public abstract 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

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
string settingId

OnSettingsChanged(IList<string>, bool)

Declaration
protected virtual void OnSettingsChanged(IList<string> settingIds, bool isResumingEvents)
Parameters
Type Name Description
IList<string> settingIds
bool isResumingEvents

RemoveSetting(string)

Declaration
public abstract bool RemoveSetting(string settingId)
Parameters
Type Name Description
string settingId
Returns
Type Description
bool

Reset()

Declaration
public abstract void Reset()

ResumeEvents()

Declaration
public void ResumeEvents()

SuspendEvents()

Declaration
public void SuspendEvents()

parent_PropertyChanged(object, PropertyChangedEventArgs)

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

parent_SettingsChanged(object, SettingsChangedEventArgs)

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

Events

PropertyChanged

Declaration
public event PropertyChangedEventHandler PropertyChanged
Event Type
Type Description
PropertyChangedEventHandler

SettingsChanged

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

Implements