Class ExtensionSettingsAttribute

Namespace

RDCore.SDK.Extensibility

Assembly

RDCore.SDK.dll

Says which settings an extension is configured with: the type it binds them to, the section of the configuration they are in, and where they are described.

[AttributeUsage(AttributeTargets.Assembly, AllowMultiple = false)]
public sealed class ExtensionSettingsAttribute : Attribute

Inheritance

object

Attribute

ExtensionSettingsAttribute

Inherited Members

Attribute.Equals(object)

Attribute.GetCustomAttribute(Assembly, Type)

Attribute.GetCustomAttribute(Assembly, Type, bool)

Attribute.GetCustomAttribute(MemberInfo, Type)

Attribute.GetCustomAttribute(MemberInfo, Type, bool)

Attribute.GetCustomAttribute(Module, Type)

Attribute.GetCustomAttribute(Module, Type, bool)

Attribute.GetCustomAttribute(ParameterInfo, Type)

Attribute.GetCustomAttribute(ParameterInfo, Type, bool)

Attribute.GetCustomAttributes(Assembly)

Attribute.GetCustomAttributes(Assembly, bool)

Attribute.GetCustomAttributes(Assembly, Type)

Attribute.GetCustomAttributes(Assembly, Type, bool)

Attribute.GetCustomAttributes(MemberInfo)

Attribute.GetCustomAttributes(MemberInfo, bool)

Attribute.GetCustomAttributes(MemberInfo, Type)

Attribute.GetCustomAttributes(MemberInfo, Type, bool)

Attribute.GetCustomAttributes(Module)

Attribute.GetCustomAttributes(Module, bool)

Attribute.GetCustomAttributes(Module, Type)

Attribute.GetCustomAttributes(Module, Type, bool)

Attribute.GetCustomAttributes(ParameterInfo)

Attribute.GetCustomAttributes(ParameterInfo, bool)

Attribute.GetCustomAttributes(ParameterInfo, Type)

Attribute.GetCustomAttributes(ParameterInfo, Type, bool)

Attribute.GetHashCode()

Attribute.IsDefaultAttribute()

Attribute.IsDefined(Assembly, Type)

Attribute.IsDefined(Assembly, Type, bool)

Attribute.IsDefined(MemberInfo, Type)

Attribute.IsDefined(MemberInfo, Type, bool)

Attribute.IsDefined(Module, Type)

Attribute.IsDefined(Module, Type, bool)

Attribute.IsDefined(ParameterInfo, Type)

Attribute.IsDefined(ParameterInfo, Type, bool)

Attribute.Match(object)

Attribute.TypeId

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

What this says is written into the extension's manifest when it is described (Describe(string, string)): a client knows the settings of every extension the platform has - offers them to a user, checks what is set - without starting any of them (Settings).

The settings type is read as the platform's are (SettingsSchema): when a change of a setting takes effect is what its SettingAttribute says, and a setting is described by the string of its key in DescriptionsResource, its dots written as underscores, in each language of the platform (Languages).

Constructors

ExtensionSettingsAttribute(Type, string, string)

Says which settings an extension is configured with: the type it binds them to, the section of the configuration they are in, and where they are described.

public ExtensionSettingsAttribute(Type optionsType, string section, string descriptionsResource)

Parameters

optionsType Type

The type the settings are bound to.

section string

The key of the section they are bound from, under Root: Diagnostics.

descriptionsResource string

The base name of the resources of the extension's assembly that describe them: RDCore.Diagnostics.SettingDescriptions.

Remarks

What this says is written into the extension's manifest when it is described (Describe(string, string)): a client knows the settings of every extension the platform has - offers them to a user, checks what is set - without starting any of them (Settings).

The settings type is read as the platform's are (SettingsSchema): when a change of a setting takes effect is what its SettingAttribute says, and a setting is described by the string of its key in DescriptionsResource, its dots written as underscores, in each language of the platform (Languages).

Properties

DescriptionsResource

The base name of the resources of the extension's assembly that describe the settings.

public string DescriptionsResource { get; }

Property Value

string

OptionsType

The type the settings are bound to.

public Type OptionsType { get; }

Property Value

Type

Section

The key of the section the settings are bound from, under Root.

public string Section { get; }

Property Value

string