Class SettingsScope

Namespace

Terminal.Gui

Assembly

Terminal.Gui.dll

The root object of Terminal.Gui configuration settings / JSON schema. Contains only properties attributed with SettingsScope.

[JsonConverter(typeof(ScopeJsonConverter<SettingsScope>))]
public class SettingsScope : Scope<SettingsScope>, IDictionary<string, ConfigProperty>, ICollection<KeyValuePair<string, ConfigProperty>>, IReadOnlyDictionary<string, ConfigProperty>, IReadOnlyCollection<KeyValuePair<string, ConfigProperty>>, IEnumerable<KeyValuePair<string, ConfigProperty>>, IDictionary, ICollection, IEnumerable, IDeserializationCallback, ISerializable

Inheritance

object

Dictionary<string, ConfigProperty>

Scope<SettingsScope>

SettingsScope

Implements

IDictionary<string, ConfigProperty>

ICollection<KeyValuePair<string, ConfigProperty>>

IReadOnlyDictionary<string, ConfigProperty>

IReadOnlyCollection<KeyValuePair<string, ConfigProperty>>

IEnumerable<KeyValuePair<string, ConfigProperty>>

IDictionary

ICollection

IEnumerable

IDeserializationCallback

ISerializable

Inherited Members

Scope<SettingsScope>.RetrieveValues()

Scope<SettingsScope>.Update(Scope<SettingsScope>)

Dictionary<string, ConfigProperty>.Add(string, ConfigProperty)

Dictionary<string, ConfigProperty>.Clear()

Dictionary<string, ConfigProperty>.ContainsKey(string)

Dictionary<string, ConfigProperty>.ContainsValue(ConfigProperty)

Dictionary<string, ConfigProperty>.EnsureCapacity(int)

Dictionary<string, ConfigProperty>.GetEnumerator()

Dictionary<string, ConfigProperty>.OnDeserialization(object)

Dictionary<string, ConfigProperty>.Remove(string)

Dictionary<string, ConfigProperty>.Remove(string, out ConfigProperty)

Dictionary<string, ConfigProperty>.TrimExcess()

Dictionary<string, ConfigProperty>.TrimExcess(int)

Dictionary<string, ConfigProperty>.TryAdd(string, ConfigProperty)

Dictionary<string, ConfigProperty>.TryGetValue(string, out ConfigProperty)

Dictionary<string, ConfigProperty>.Comparer

Dictionary<string, ConfigProperty>.Count

Dictionary<string, ConfigProperty>.this[string]

Dictionary<string, ConfigProperty>.Keys

Dictionary<string, ConfigProperty>.Values

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Examples

{
  "$schema" : "https://gui-cs.github.io/Terminal.GuiV2Docs/schemas/tui-config-schema.json",
  "Application.UseSystemConsole" : true,
  "Theme" : "Default",
  "Themes": {
  },
},

Properties

Schema

Points to our JSON schema.

Sources

The list of paths to the configuration files.

Methods

Update(Stream, string, ConfigLocations)

Updates the SettingsScope with the settings in a JSON string.

Update(string?, string, ConfigLocations)

Updates the SettingsScope with the settings in a JSON string.

Update(string, ConfigLocations)

Updates the SettingsScope with the settings in a JSON file.

UpdateFromResource(Assembly, string, ConfigLocations)

Updates the SettingsScope with the settings from a Json resource.