DovetailConfigurationAttribute<T>

1. Docs
2. /Search C# APIs
3. /Joinery.Dovetail
4. /DovetailConfigurationAttribute

Classsealednet10.0

📦 Joinery.Dovetail v0.4.3-beta.13

Declares the configuration section of an options type T from the assembly, for types you don't own.

namespace Joinery.Dovetail.Attributes;

public sealed class DovetailConfigurationAttribute<T>
    : System.Attribute
    where T : class
{
    // ...
}

T: class

Attribute

Inherits

Attribute→DovetailConfigurationAttribute<T>

Search members of DovetailConfigurationAttribute...

constructorproperty

6 members

Clear filtersReset all

Type Parameters

T

The options type.

Remarks

For example, [assembly: DovetailConfiguration<HostOptions>("Hosting")].

The section path follows the same rules as DovetailConfigurationAttribute. Apply it once for each type you configure. A type has one section: naming it twice, or also declaring it with the class form, is reported as DT0015. DovetailConfigurationAttribute`1.KeyStyle works as it does on the class form.

Only works with source generators enabled.

Constructors2

DovetailConfigurationAttribute

Declares T under the section derived from its name.

DovetailConfigurationAttribute(string)

Declares T under section.

View all constructors

Properties4

KeyStyleget; set

ConfigurationKeyStyle

How the configuration keys are spelled: those of every bound property and constructor parameter of the options type and of the object types nested in it, and the default section path derived from the type name. The default is ConfigurationKeyStyle.Undefined, which keeps the declared names. See ConfigurationKeyStyle.

RegisterOptionsget; set

bool

Whether to register IOptions<T> for the type. false only describes the section in the schema. The default is true.

Sectionget

string?

The section path, or null for the one derived from the type name.

ValidateOnStartget; set

bool

Whether to validate the options when the host starts. The default is false.

View all properties