Class VersionedSettingsCategoryBase

Base class for settings objects which may become out-of-date and replaced with default settings.

Inheritance

System.Object

SettingsCategoryBase

VersionedSettingsCategoryBase

Inherited Members

SettingsCategoryBase.CategoryName

SettingsCategoryBase.DisplayName

SettingsCategoryBase.ShowInSettingsManager

SettingsCategoryBase.AllowedValues

SettingsCategoryBase.GetAllowedValuesOrDefault(String)

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 VersionedSettingsCategoryBase : SettingsCategoryBase

Constructors

VersionedSettingsCategoryBase(String, String, Boolean)

Initializes a new instance of the VersionedSettingsCategoryBase class.

Declaration

protected VersionedSettingsCategoryBase(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

IsOutOfDate

Gets a value indicating whether or not this settings object is out-of-date compared to the default settings.

Declaration

public abstract bool IsOutOfDate { get; }

Property Value

Type	Description
System.Boolean