SolutionFileBuilder

Definition

Assembly: CloudNimble.EasyAF.Tools.dll Namespace: CloudNimble.EasyAF.Tools.Scaffolding Inheritance: System.Object

Syntax

CloudNimble.EasyAF.Tools.Scaffolding.SolutionFileBuilder

Summary

Builds a Visual Studio .slnx solution file in-process with Microsoft.VisualStudio.SolutionPersistence, placing projects and solution items into solution folders.

Constructors

.ctor

Initializes a new instance of the SolutionFileBuilder class.

Syntax

public SolutionFileBuilder(string solutionDirectory, string solutionName)

Parameters

Name	Type	Description
`solutionDirectory`	`string`	The directory the solution file is written to.
`solutionName`	`string`	The solution file name without extension.

.ctor Inherited

Inherited from object

Syntax

public Object()

Properties

BuildTypes

Gets the build types (configurations) the solution declares, in the order they were added. Always starts with Debug and Release.

Syntax

public System.Collections.Generic.IReadOnlyList<string> BuildTypes { get; }

Property Value

Type: System.Collections.Generic.IReadOnlyList<string>

SolutionDirectory

Gets the directory the solution file is written to. Project and item paths are stored relative to it.

Syntax

public string SolutionDirectory { get; }

Property Value

Type: string

SolutionName

Gets the solution file name without extension.

Syntax

public string SolutionName { get; }

Property Value

Type: string

Methods

AddBuildType

Adds a build type (configuration) such as DEV. Duplicates are ignored.

Syntax

public CloudNimble.EasyAF.Tools.Scaffolding.SolutionFileBuilder AddBuildType(string buildType)

Parameters

Name	Type	Description
`buildType`	`string`	The build type name.

Returns

Type: CloudNimble.EasyAF.Tools.Scaffolding.SolutionFileBuilder The current instance for method chaining.

AddProject

Adds a project to a solution folder.

Syntax

public CloudNimble.EasyAF.Tools.Scaffolding.SolutionFileBuilder AddProject(string solutionFolder, string projectFilePath)

Parameters

Name	Type	Description
`solutionFolder`	`string`	The solution folder, for example `Core` or `/Core/`.
`projectFilePath`	`string`	The project file path; relative paths are resolved against SolutionFileBuilder.SolutionDirectory.

Returns

Type: CloudNimble.EasyAF.Tools.Scaffolding.SolutionFileBuilder The current instance for method chaining.

Exceptions

Exception	Description
`InvalidOperationException`	Thrown when the same project has already been added.

AddSolutionItem

Adds a loose file (for example Directory.Build.props) to a solution folder.

Syntax

public CloudNimble.EasyAF.Tools.Scaffolding.SolutionFileBuilder AddSolutionItem(string solutionFolder, string filePath)

Parameters

Name	Type	Description
`solutionFolder`	`string`	The solution folder, for example `Solution Items`.
`filePath`	`string`	The file path; relative paths are resolved against SolutionFileBuilder.SolutionDirectory.

Returns

Type: CloudNimble.EasyAF.Tools.Scaffolding.SolutionFileBuilder The current instance for method chaining.

Equals Inherited Virtual

Inherited from object

Syntax

public virtual bool Equals(object obj)

Parameters

Name	Type	Description
`obj`	`object?`	-

Returns

Type: bool

Equals Inherited

Inherited from object

Syntax

public static bool Equals(object objA, object objB)

Parameters

Name	Type	Description
`objA`	`object?`	-
`objB`	`object?`	-

Returns

Type: bool

GetHashCode Inherited Virtual

Inherited from object

Syntax

public virtual int GetHashCode()

Returns

Type: int

GetType Inherited

Inherited from object

Syntax

public System.Type GetType()

Returns

Type: System.Type

MemberwiseClone Inherited

Inherited from object

Syntax

protected internal object MemberwiseClone()

Returns

Type: object

ReferenceEquals Inherited

Inherited from object

Syntax

public static bool ReferenceEquals(object objA, object objB)

Parameters

Name	Type	Description
`objA`	`object?`	-
`objB`	`object?`	-

Returns

Type: bool

SaveAsync

Writes the solution file, replacing any existing file of the same name.

Syntax

public System.Threading.Tasks.Task<string> SaveAsync(System.Threading.CancellationToken cancellationToken = null)

Parameters

Name	Type	Description
`cancellationToken`	`System.Threading.CancellationToken`	A token to cancel the operation.

Returns

Type: System.Threading.Tasks.Task<string> The full path of the written solution file.

ToString Inherited Virtual

Inherited from object

Syntax

public virtual string ToString()

Returns

Type: string?

​Definition

​Syntax

​Summary

​Constructors

​ .ctor

​Syntax

​Parameters

​ .ctor Inherited

​Syntax

​Properties

​ BuildTypes

​Syntax

​Property Value

​ SolutionDirectory

​Syntax

​Property Value

​ SolutionName

​Syntax

​Property Value

​Methods

​ AddBuildType

​Syntax

​Parameters

​Returns

​ AddProject

​Syntax

​Parameters

​Returns

​Exceptions

​ AddSolutionItem

​Syntax

​Parameters

​Returns

​ Equals Inherited Virtual

​Syntax

​Parameters

​Returns

​ Equals Inherited

​Syntax

​Parameters

​Returns

​ GetHashCode Inherited Virtual

​Syntax

​Returns

​ GetType Inherited

​Syntax

​Returns

​ MemberwiseClone Inherited

​Syntax

​Returns

​ ReferenceEquals Inherited

​Syntax

​Parameters

​Returns

​ SaveAsync

​Syntax

​Parameters

​Returns

​ ToString Inherited Virtual

​Syntax

​Returns

Definition

Syntax

Summary

Constructors

.ctor

Syntax

Parameters

.ctor Inherited

Syntax

Properties

BuildTypes

Syntax

Property Value

SolutionDirectory

Syntax

Property Value

SolutionName

Syntax

Property Value

Methods

AddBuildType

Syntax

Parameters

Returns

AddProject

Syntax

Parameters

Returns

Exceptions

AddSolutionItem

Syntax

Parameters

Returns

Equals Inherited Virtual

Syntax

Parameters

Returns

Equals Inherited

Syntax

Parameters

Returns

GetHashCode Inherited Virtual

Syntax

Returns

GetType Inherited

Syntax

Returns

MemberwiseClone Inherited

Syntax

Returns

ReferenceEquals Inherited

Syntax

Parameters

Returns

SaveAsync

Syntax

Parameters

Returns

ToString Inherited Virtual

Syntax

Returns