DovetailConfigurationAttribute

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 class. Dovetail's source generator describes the class as JSON Schema, which is merged into the application's appsettings.schema.json for editor completion and validation, and registers it with the options pipeline.

namespace Joinery.Dovetail.Attributes;

public sealed class DovetailConfigurationAttribute
    : System.Attribute
{
    // ...
}

Attribute

Inherits

Attribute→DovetailConfigurationAttribute

Search members of DovetailConfigurationAttribute...

constructorproperty

6 members

Clear filtersReset all

Remarks

Without a section path the section is the type name with an Options, Settings, Configuration or Config suffix removed, so GreetingsOptions becomes Greetings. Nested sections use :, as in "Http:Retry".

A type has one section, so it can be declared once. For a type you don't own, use the assembly form, Attributes.DovetailConfigurationAttribute`1.

DovetailConfigurationAttribute.KeyStyle picks how the keys of the type and of the types nested in it are spelled (as declared, Pascal, camel, dash or underscore case). A type that several sections reach has to spell its keys the same way in all of them; DT0016 reports a mismatch.

The generated registration reads its own section from the application's complete IConfiguration and creates or binds the options.

Only works with source generators enabled.

Constructors2

DovetailConfigurationAttribute

Declares the attributed class under the section derived from its name.

DovetailConfigurationAttribute(string)

Declares the attributed class 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