Struct SnapshotKeyMap

Maps a snapshot field to a target configuration key with an optional string transformation.

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetType()

Namespace: Serenity.SystemConfiguration.Domain.ValueObjects

Assembly: Serenity.SystemConfiguration.Domain.dll

Syntax

public readonly struct SnapshotKeyMap

Constructors

SnapshotKeyMap(SnapshotFieldId, string, StringTransform)

Initializes a new instance of the SnapshotKeyMap struct.

Declaration

public SnapshotKeyMap(SnapshotFieldId field, string targetKey, StringTransform transform = StringTransform.None)

Parameters

Type	Name	Description
SnapshotFieldId	field	The snapshot field identifier.
string	targetKey	The target configuration key (e.g., "Graphics/RefreshRate").
StringTransform	transform	The string transformation to apply to the value (if applicable).

Fields

Field

Declaration

public readonly SnapshotFieldId Field

Field Value

Type	Description
SnapshotFieldId	The snapshot field identifier.

TargetKey

Declaration

public readonly string TargetKey

Field Value

Type	Description
string	The target configuration key (e.g., "Graphics/RefreshRate").

Transform

Declaration

public readonly StringTransform Transform

Field Value

Type	Description
StringTransform	The string transformation to apply to the value (if applicable).

Properties

IsValid

Indicates whether the mapping is valid (i.e., has a non-empty target key).

Declaration

public bool IsValid { get; }

Property Value

Type	Description
bool	True if the mapping is valid; otherwise, false.

Methods

ToString()

Returns a string representation of the SnapshotKeyMap.

Declaration

public override string ToString()

Returns

Type	Description
string	A string in the format "Field -> TargetKey (Transform)".

Overrides

ValueType.ToString()