Meziantou.Framework

TomlPropertiesMetadata Class

Namespace
Meziantou.Framework.Toml.Model
Assembly
Meziantou.Framework.Toml.dll
Package
Meziantou.Framework.Toml 1.0.4
Source
TomlPropertiesMetadata.cs
Available in package assets
net10.0net11.0

Stores metadata for TOML properties, including trivia and display hints.

public class TomlPropertiesMetadata

Constructors

NameDescription
TomlPropertiesMetadata()Initializes a new instance of the TomlPropertiesMetadata class.

TomlPropertiesMetadata()

TomlPropertiesMetadata.cs

Initializes a new instance of the TomlPropertiesMetadata class.

public TomlPropertiesMetadata()

Methods

NameDescription
Clear()Clears all property metadata.
ContainsProperty(string)Checks whether metadata exists for the specified property key.
SetProperty(string, TomlPropertyMetadata)Sets metadata for the specified property key.
TryGetProperty(string, TomlPropertyMetadata?)Tries to get metadata for the specified property key.

Clear()

TomlPropertiesMetadata.cs

Clears all property metadata.

public void Clear()

ContainsProperty(string)

TomlPropertiesMetadata.cs

Checks whether metadata exists for the specified property key.

public bool ContainsProperty(string propertyKey)

Parameters

propertyKey string
The property key.

Returns

bool true if metadata exists; otherwise false.

SetProperty(string, TomlPropertyMetadata)

TomlPropertiesMetadata.cs

Sets metadata for the specified property key.

public void SetProperty(string propertyKey, TomlPropertyMetadata propertyMetadata)

Parameters

propertyKey string
The property key.
propertyMetadata TomlPropertyMetadata
The metadata to set.

TryGetProperty(string, TomlPropertyMetadata?)

TomlPropertiesMetadata.cs

Tries to get metadata for the specified property key.

public bool TryGetProperty(string propertyKey, out TomlPropertyMetadata? propertyMetadata)

Parameters

propertyKey string
The property key.
propertyMetadata TomlPropertyMetadata?
The metadata when found.

Returns

bool true if metadata exists; otherwise false.