Class ConfigProject

Holds the configuration for a target project and any target project folder under the project that are needed in the configuration.

Inheritance
object
ConfigProject
Implements
Inherited Members
Namespace: CodeFactory.WinVs.Commands
Assembly: CodeFactory.WinVs.dll
Syntax
public class ConfigProject : IConfigGuidance

Properties

Folders

ConfigFolder that are part of the project.

Declaration
public ImmutableList<ConfigFolder> Folders { get; set; }
Property Value
Type Description
ImmutableList<ConfigFolder>

Guidance

Instructions for what data is to go into the configuration.

Declaration
public string Guidance { get; set; }
Property Value
Type Description
string

Name

The configuration name assigned to the project.

Declaration
public string Name { get; set; }
Property Value
Type Description
string

Parameters

Parameters that are assigned to the project.

Declaration
public ImmutableList<ConfigParameter> Parameters { get; set; }
Property Value
Type Description
ImmutableList<ConfigParameter>

ProjectName

The target project in the solution this configuration talks to.

Declaration
public string ProjectName { get; set; }
Property Value
Type Description
string

Methods

AddFolder(ConfigFolder)

Fluent method that adds a folder to the project source.

Declaration
public ConfigProject AddFolder(ConfigFolder folder)
Parameters
Type Name Description
ConfigFolder folder

Target folder to add to the project.
Returns
Type Description
ConfigProject

Updated project source.

AddParameter(ConfigParameter)

Fluent method that adds a parameter to the project source.

Declaration
public ConfigProject AddParameter(ConfigParameter parameter)
Parameters
Type Name Description
ConfigParameter parameter

The parameter to add to the project.
Returns
Type Description
ConfigProject

Updated project source.

Folder(string)

Gets the folder from the hosting project.

Declaration
public ConfigFolder Folder(string name)
Parameters
Type Name Description
string name

The name of the folder to retrieve.
Returns
Type Description
ConfigFolder

The folder or null if it is not found.

Parameter(string)

Gets the parameter source from the hosting project.

Declaration
public ConfigParameter Parameter(string name)
Parameters
Type Name Description
string name

The name of the parameter to retrieve.
Returns
Type Description
ConfigParameter

The parameter source or null if it is not found.

ParameterValue(string)

Get the value for a parameter that is hosted in the project.

Declaration
public string ParameterValue(string name)
Parameters
Type Name Description
string name

The name of the parameter to get the value from.
Returns
Type Description
string

The value of the parameter or null if the parameter is not found.

Implements

IConfigGuidance