Skip to content

Class ConfigurationPropertyAttribute

Namespace: Void.Proxy.Api.Configurations.Attributes
Assembly: Void.Proxy.Api.dll

Provides TOML mapping metadata for a configuration field or property.

[AttributeUsage(AttributeTargets.Property|AttributeTargets.Field)]
public class ConfigurationPropertyAttribute : Attribute

Inheritance

objectAttributeConfigurationPropertyAttribute

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.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.MemberwiseClone(), object.ReferenceEquals(object?, object?), object.ToString()

Remarks

During TOML mapping, null or whitespace values in , , and are ignored.

Constructors

ConfigurationPropertyAttribute(string?)

Provides TOML mapping metadata for a configuration field or property.

public ConfigurationPropertyAttribute(string? name = null)

Parameters

name string?

Optional serialized key name used by the TOML serializer instead of the member name.

Remarks

During TOML mapping, null or whitespace values in , , and are ignored.

Properties

InlineComment

Gets an inline comment to attach to the serialized TOML member.

public string? InlineComment { get; init; }

Property Value

string?

Name

Gets the serialized key name override.

public string? Name { get; init; }

Property Value

string?

PrecedingComment

Gets a preceding comment to attach above the serialized TOML member.

public string? PrecedingComment { get; init; }

Property Value

string?