Skip to main content

Class SettingsAttribute

Specifies the settings type, path in the settings UI, and optionally its filename. If the filename is not set, the type's name is used.

public sealed class SettingsAttribute : Attribute

Inheritance​

object→Attribute→SettingsAttribute

Constructors​

SettingsAttribute(SettingsUsage, string, string)​

Initializes a new instance of the SettingsAttribute class.

public SettingsAttribute(SettingsUsage usage, string displayPath = null, string filename = null)

Parameters​

NameTypeDescription
usageSettingsUsageThe type of settings (how and when they are used).
displayPathstringThe display path of the settings in the settings UI. Optional.
filenamestringThe filename used to store the settings. If null, the type's name is used. Optional.

Fields​

displayPath​

The display name and optional path in the settings dialog.

public readonly string displayPath

Field Value​

string

filename​

The filename used to store the settings. If null, the type's name is used.

public readonly string filename

Field Value​

string

usage​

The type of settings (how and when they are used).

public readonly SettingsUsage usage

Field Value​

SettingsUsage

  • Constructors
    • SettingsAttribute(SettingsUsage, string, string)
  • Fields
    • displayPath
    • filename
    • usage