Documentation Index Fetch the complete documentation index at: https://easyaf.dev/llms.txt
Use this file to discover all available pages before exploring further.
Definition Assembly: CloudNimble.EasyAF.MSBuild.dllNamespace: CloudNimble.EasyAF.MSBuildInheritance: System.ObjectSyntax CloudNimble . EasyAF . MSBuild . MSBuildProjectManager
Summary Manages MSBuild project files (.csproj, Directory.Build.props, etc.) with formatting preservation capabilities.
This class provides comprehensive support for loading, validating, and modifying MSBuild
project files while preserving the original formatting (indentation, line breaks).
It follows the same pattern as DocsJsonManager for consistency.
Constructors Initializes a new instance of the MSBuildProjectManager class.
Syntax public MSBuildProjectManager ()
Initializes a new instance of the MSBuildProjectManager class with the specified file path.
Syntax public MSBuildProjectManager ( string filePath )
Parameters Name Type Description filePathstringThe file path to the MSBuild project file.
Exceptions Exception Description ArgumentExceptionThrown when filePath is null or whitespace.
Inherited Syntax Properties Gets the file path of the loaded project.
Syntax public string FilePath { get ; private set ; }
Property Value Type: string
The absolute path to the project file that was loaded or will be saved to.
Returns null if no file path has been specified.
Gets a value indicating whether a project is successfully loaded.
Syntax public bool IsLoaded { get ; }
Property Value Type: bool
True if a project is loaded and there are no errors; otherwise, false.
Gets a value indicating whether formatting preservation is enabled.
Syntax public bool PreserveFormatting { get ; private set ; }
Property Value Type: bool
True if the project was loaded with formatting preservation; otherwise, false.
Gets the loaded MSBuild project root element.
Syntax public Microsoft . Build . Construction . ProjectRootElement Project { get ; private set ; }
Property Value Type: Microsoft.Build.Construction.ProjectRootElement
The ProjectRootElement instance loaded from the file system.
Returns null if no project has been loaded or if loading failed.
Gets the collection of project loading and processing errors.
Syntax public System . Collections . Generic . List < System . CodeDom . Compiler . CompilerError > ProjectErrors { get ; private set ; }
Property Value Type: System.Collections.Generic.List<System.CodeDom.Compiler.CompilerError>
A list of CompilerError instances representing any errors
encountered during project loading, validation, or processing operations.
Methods Adds an ItemGroup with the specified condition and configures it using the provided action.
Syntax public CloudNimble . EasyAF . MSBuild . MSBuildProjectManager AddItemGroup ( string condition , System . Action < CloudNimble . EasyAF . MSBuild . ItemGroupBuilder > configure )
Parameters Name Type Description conditionstringThe condition for the ItemGroup. configureSystem.Action<CloudNimble.EasyAF.MSBuild.ItemGroupBuilder>An action to configure the ItemGroup.
Returns Type: CloudNimble.EasyAF.MSBuild.MSBuildProjectManager
The current instance for method chaining.
Exceptions Exception Description ArgumentNullExceptionThrown when configure is null. InvalidOperationExceptionThrown when no project is loaded.
Adds a PackageReference to the project.
Syntax public CloudNimble . EasyAF . MSBuild . MSBuildProjectManager AddPackageReference ( string packageId , string version , string condition = null )
Parameters Name Type Description packageIdstringThe package ID. versionstringThe package version. conditionstringOptional condition for the PackageReference.
Returns Type: CloudNimble.EasyAF.MSBuild.MSBuildProjectManager
The current instance for method chaining.
Exceptions Exception Description ArgumentExceptionThrown when packageId or version is null or whitespace. InvalidOperationExceptionThrown when no project is loaded.
Creates a new MSBuild project file with default structure.
Syntax public void CreateNew ( string filePath , string targetFramework = "net8.0" )
Parameters Name Type Description filePathstringThe file path where the new project should be created. targetFrameworkstringThe target framework for the project (default: net8.0).
Exceptions Exception Description ArgumentExceptionThrown when filePath is null or whitespace.
Ensures MSBuild is registered with the latest available version.
Syntax public static void EnsureMSBuildRegistered ()
This method should be called before any MSBuild operations to ensure the correct
version of MSBuild is loaded. On .NET Core, QueryVisualStudioInstances() returns
SDK instances (versions like 8.0.x, 9.0.x, 10.0.x), not Visual Studio instances.
We explicitly select and register the latest available instance.
Inherited Virtual Syntax public virtual bool Equals ( object obj )
Parameters Name Type Description objobject?-
Returns Type: bool
Inherited Syntax public static bool Equals ( object objA , object objB )
Parameters Name Type Description objAobject?- objBobject?-
Returns Type: bool
Inherited Virtual Syntax public virtual int GetHashCode ()
Returns Type: int
Gets the value of a property from the project.
Syntax public string GetPropertyValue ( string name )
Parameters Name Type Description namestringThe property name.
Returns Type: string
The property value, or null if the property does not exist.
Exceptions Exception Description ArgumentExceptionThrown when name is null or whitespace. InvalidOperationExceptionThrown when no project is loaded.
Inherited Syntax public System . Type GetType ()
Returns Type: System.Type
Loads an existing MSBuild project file from the file path specified in the constructor.
Syntax public CloudNimble . EasyAF . MSBuild . MSBuildProjectManager Load ( bool preserveFormatting = true )
Parameters Name Type Description preserveFormattingboolWhether to preserve the original formatting of the project file.
Returns Type: CloudNimble.EasyAF.MSBuild.MSBuildProjectManager
The current instance for method chaining.
Exceptions Exception Description InvalidOperationExceptionThrown when no file path has been specified.
Loads an existing MSBuild project file from the specified file path.
Syntax public CloudNimble . EasyAF . MSBuild . MSBuildProjectManager Load ( string filePath , bool preserveFormatting = true )
Parameters Name Type Description filePathstringThe file path to the MSBuild project file. preserveFormattingboolWhether to preserve the original formatting of the project file.
Returns Type: CloudNimble.EasyAF.MSBuild.MSBuildProjectManager
The current instance for method chaining.
Exceptions Exception Description ArgumentExceptionThrown when filePath is null or whitespace.
Inherited Syntax protected internal object MemberwiseClone ()
Returns Type: object
Inherited Syntax public static bool ReferenceEquals ( object objA , object objB )
Parameters Name Type Description objAobject?- objBobject?-
Returns Type: bool
Removes a property from the project.
Syntax public CloudNimble . EasyAF . MSBuild . MSBuildProjectManager RemoveProperty ( string name )
Parameters Name Type Description namestringThe property name to remove.
Returns Type: CloudNimble.EasyAF.MSBuild.MSBuildProjectManager
The current instance for method chaining.
Exceptions Exception Description ArgumentExceptionThrown when name is null or whitespace. InvalidOperationExceptionThrown when no project is loaded.
Saves the current project to the file system using the original file path.
Syntax Exceptions Exception Description InvalidOperationExceptionThrown when no project is loaded or no file path is specified.
Saves the current project to the specified file path.
Syntax public void Save ( string filePath )
Parameters Name Type Description filePathstringThe file path where the project should be saved.
Exceptions Exception Description ArgumentExceptionThrown when filePath is null or whitespace. InvalidOperationExceptionThrown when no project is loaded.
Sets a property value in the project.
Syntax public CloudNimble . EasyAF . MSBuild . MSBuildProjectManager SetProperty ( string name , string value )
Parameters Name Type Description namestringThe property name. valuestringThe property value.
Returns Type: CloudNimble.EasyAF.MSBuild.MSBuildProjectManager
The current instance for method chaining.
Exceptions Exception Description ArgumentExceptionThrown when name or value is null or whitespace. InvalidOperationExceptionThrown when no project is loaded.
Inherited Virtual Syntax public virtual string ToString ()
Returns Type: string? 
