Table of Contents

Class StoreInSeparateFileAttribute

Namespace
OpenSettings.Attributes
Assembly
OpenSettings.dll

Specifies that a setting should be stored in a separate file, such as settings-generated.*.json, rather than the general settings file settings-generated.json.

[AttributeUsage(AttributeTargets.Class)]
public class StoreInSeparateFileAttribute : Attribute
Inheritance
StoreInSeparateFileAttribute
Inherited Members

Remarks

If the class is marked with this attribute, its settings will be stored in a specific file. The IgnoreOnFileChange property determines whether changes to the file should be ignored when the file is modified.

Constructors

StoreInSeparateFileAttribute(bool)

Initializes a new instance of the StoreInSeparateFileAttribute class.

public StoreInSeparateFileAttribute(bool ignoreOnFileChange = false)

Parameters

ignoreOnFileChange bool

Indicates whether changes to the file should be ignored on file change.

Exceptions

InvalidSecretTextAttributeUsageException

Thrown in runtime if attribute not assigned to property of the string type.

Properties

IgnoreOnFileChange

Gets a value indicating whether changes to the file should be ignored when the file is modified.

public bool IgnoreOnFileChange { get; }

Property Value

bool

Exceptions

InvalidSecretTextAttributeUsageException

Thrown in runtime if attribute not assigned to property of the string type.