Interface ISettingsStorage

Namespace

NDepend.Project

Assembly

NDepend.API.dll

Represents how some project settings are stored.

public interface ISettingsStorage

Extension Methods

ExtensionMethodsEnumerable.Concat<TElement>(TElement, IEnumerable<TElement>)

ExtensionMethodsEnumerable.ToEnumerable<TElement>(TElement)

ExtensionMethodsMisc.ToNullableDouble(object)

Remarks

Project settings can be stored in the project file or in a .ndsettings file.
This is why this interface only contains the read/write property SettingsFilePath.

Properties (4)

ErrorLoadingFromSettingsFile

Gets a plain english string that describes the error when trying to load the Debt settings from the referenced settings file.

string ErrorLoadingFromSettingsFile { get; }

Property Value

string

Remarks

This property is set when loading the IProject from the project file.
If an error occurs while loading from settings file, the debt settings ae loaded from the project file.

See Also

LoadProject(IAbsoluteFilePath)

ErrorSavingInSettingsFile

Gets a plain english string that describes the error when trying to save the Debt settings in the referenced settings file.

string ErrorSavingInSettingsFile { get; }

Property Value

string

Remarks

This property is set when saving the IProject from the project file.
If an error occurs while saving in settings file, the debt settings ae saved in the project file.

See Also

SaveProject(IProject)

SettingsFilePath

Gets or sets the path to the .ndsettings file that contains debt settings for this project.

IFilePath SettingsFilePath { get; set; }

Property Value

IFilePath

Remarks

When this property value is changed, the event IProject.SettingsChanged is triggered with the flag ProjectSettings.DebtSettingsStorage activated.
null value are acepted to reset this file path.

Storage

Gets or sets the location where the Debt settings are stored.

SettingsStorage Storage { get; set; }

Property Value

SettingsStorage