Class SettingsUtil

Provides functionality to serialize and deserialize settings bundles.

Inheritance

System.Object

SettingsUtil

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 static class SettingsUtil

Methods

CreateJsonSettingsBundle(ISettingsBundle)

Declaration

public static ISettingsBundle CreateJsonSettingsBundle(ISettingsBundle parent)

Parameters

Type	Name	Description
ISettingsBundle	parent

Returns

Type	Description
ISettingsBundle

CreateSettingsBundle(ISettingsBundle)

Creates a new SettingsBundle

Declaration

public static ISettingsBundle CreateSettingsBundle(ISettingsBundle parent)

Parameters

Type	Name	Description
ISettingsBundle	parent	the SettingsBundle parent

Returns

Type	Description
ISettingsBundle	the created ISettingsBundle

CreateSettingsBundle(ISettingsBundle, ISettingsBundle)

Creates a new SettingsBundle

Declaration

public static ISettingsBundle CreateSettingsBundle(ISettingsBundle parent, ISettingsBundle source)

Parameters

Type	Name	Description
ISettingsBundle	parent	the SettingsBundle parent
ISettingsBundle	source	the source implementation

Returns

Type	Description
ISettingsBundle	the created ISettingsBundle

CreateSettingsBundle(ISettingsBundle, Boolean)

Creates a new SettingsBundle

Declaration

public static ISettingsBundle CreateSettingsBundle(ISettingsBundle parent, bool isDefault)

Parameters

Type	Name	Description
ISettingsBundle	parent	the SettingsBundle parent
System.Boolean	isDefault	whether the created SettingsBundle uses default settings

Returns

Type	Description
ISettingsBundle	the created ISettingsBundle

DeserializeJsonSettingsBundle(JObject)

Declaration

public static ISettingsBundle DeserializeJsonSettingsBundle(JObject settingBundleJObject)

Parameters

Type	Name	Description
Newtonsoft.Json.Linq.JObject	settingBundleJObject

Returns

Type	Description
ISettingsBundle

DeserializeJsonSettingsBundle(String)

Declaration

public static ISettingsBundle DeserializeJsonSettingsBundle(string jsonSettingsBundle)

Parameters

Type	Name	Description
System.String	jsonSettingsBundle

Returns

Type	Description
ISettingsBundle

DeserializeSettingsBundle(XmlReader, ISettingsBundle)

Deserialize the content pointed to in the specified XmlReader to a SettingsBundle object and give it access to the hierarchy information through the specified provider

Declaration

public static ISettingsBundle DeserializeSettingsBundle(XmlReader reader, ISettingsBundle parent)

Parameters

Type	Name	Description
System.Xml.XmlReader	reader	The XML reader, pointing to a valid opening SettingsBundle tag
ISettingsBundle	parent	The hierarchy provider

Returns

Type	Description
ISettingsBundle	the desiralized ISettingsBundle

DeserializeSettingsBundle(XmlReader, ISettingsBundle, Boolean)

Deserialize the content pointed to in the specified XmlReader to a SettingsBundle object and give it access to the hierarchy information through the specified provider

Declaration

public static ISettingsBundle DeserializeSettingsBundle(XmlReader reader, ISettingsBundle parent, bool isDefault)

Parameters

Type	Name	Description
System.Xml.XmlReader	reader	The XML reader, pointing to a valid opening SettingsBundle tag
ISettingsBundle	parent	The hierarchy provider
System.Boolean	isDefault	Whether the deserialized settings bundle defines default settings

Returns

Type	Description
ISettingsBundle	the desiralized ISettingsBundle

SerializeJsonSettingsBundle(ISettingsBundle)

Declaration

public static string SerializeJsonSettingsBundle(ISettingsBundle jsonSettingsBundle)

Parameters

Type	Name	Description
ISettingsBundle	jsonSettingsBundle

Returns

Type	Description
System.String

SerializeJsonSettingsBundleToJObject(ISettingsBundle)

Declaration

public static JObject SerializeJsonSettingsBundleToJObject(ISettingsBundle jsonSettingsBundle)

Parameters

Type	Name	Description
ISettingsBundle	jsonSettingsBundle

Returns

Type	Description
Newtonsoft.Json.Linq.JObject

SerializeSettingsBundle(XmlWriter, ISettingsBundle)

Serialize the given SettingsBundle using the specified XmlWriter

Declaration

public static void SerializeSettingsBundle(XmlWriter writer, ISettingsBundle iSettingsBundle)

Parameters

Type	Name	Description
System.Xml.XmlWriter	writer	The XML writer to use
ISettingsBundle	iSettingsBundle	The ISettingsBundle to serialize

SerializeSettingsBundle(XmlWriter, ISettingsBundle, Boolean)

Serialize the given SettingsBundle using the specified XmlWriter

Declaration

public static void SerializeSettingsBundle(XmlWriter writer, ISettingsBundle iSettingsBundle, bool includeInheritedSettings)

Parameters

Type	Name	Description
System.Xml.XmlWriter	writer	The XML writer to use
ISettingsBundle	iSettingsBundle	The ISettingsBundle to serialize
System.Boolean	includeInheritedSettings	Whether to include inherited settings