Class SettingsCategoryBase

Base class for settings objects.

Inheritance

System.Object

SettingsCategoryBase

DeviceManagementSettings

LogFilterSettings

PackageCacheSettings

VersionedSettingsCategoryBase

WindowSettings

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Phoenix.Settings

Assembly: Phoenix.Abstractions.Settings.dll

Syntax

public abstract class SettingsCategoryBase

Constructors

SettingsCategoryBase(String)

Initializes a new instance of the SettingsCategoryBase class.

Declaration

protected SettingsCategoryBase(string categoryName)

Parameters

Type	Name	Description
System.String	categoryName	Name of the category.

SettingsCategoryBase(String, Boolean)

Initializes a new instance of the SettingsCategoryBase class.

Declaration

protected SettingsCategoryBase(string categoryName, bool showInSettingsManager)

Parameters

Type	Name	Description
System.String	categoryName	Name of the category.
System.Boolean	showInSettingsManager	True if the category should be shown in the settings manager UI. Otherwise false.

SettingsCategoryBase(String, String)

Initializes a new instance of the SettingsCategoryBase class.

Declaration

protected SettingsCategoryBase(string categoryName, string displayName)

Parameters

Type	Name	Description
System.String	categoryName	Name of the category.
System.String	displayName	The display name for the category, for UI and logging purposes.

SettingsCategoryBase(String, String, Boolean)

Initializes a new instance of the SettingsCategoryBase class.

Declaration

protected SettingsCategoryBase(string categoryName, string displayName, bool showInSettingsManager)

Parameters

Type	Name	Description
System.String	categoryName	Name of the category.
System.String	displayName	The display name for the category, for UI and logging purposes.
System.Boolean	showInSettingsManager	True if the category should be shown in the settings manager UI. Otherwise false.

Properties

AllowedValues

Gets a collection of setting names mapped to objects defining their allowed values (for validation).

Declaration

protected Dictionary<string, AllowedValuesModel> AllowedValues { get; }

Property Value

Type	Description
System.Collections.Generic.Dictionary<System.String, AllowedValuesModel>

CategoryName

Gets or sets the name of the category that the settings belong to.

Declaration

public string CategoryName { get; set; }

Property Value

Type	Description
System.String

DisplayName

Gets or sets the name of the category used for UI and logging.

Declaration

public string DisplayName { get; set; }

Property Value

Type	Description
System.String

ShowInSettingsManager

Gets a value indicating whether this category should be shown in the settings manager UI.

Declaration

public bool ShowInSettingsManager { get; }

Property Value

Type	Description
System.Boolean

Methods

GetAllowedValuesOrDefault(String)

Gets the allowed values for a specific property.

Declaration

public AllowedValuesModel GetAllowedValuesOrDefault(string propertyName)

Parameters

Type	Name	Description
System.String	propertyName	Name of the property.

Returns

Type	Description
AllowedValuesModel	The allowed value(s) for the property.