Interface IDotNetProjectEditor

File editor interface for dot Net type projects

Inherited Members
Namespace: IdeProjectFileEditor
Assembly: BuildSystem.Utils.dll
Syntax
public interface IDotNetProjectEditor : IXMLEditor, IProjectReferenceEditor

Properties

ProjAppType

Returns the project type value;

Expected values for c# projects: "Library", "Exe", "Module", "Winexe"

Expected values for c++ projects: "DynamicLibrary", "StaticLibrary", "Application", "Utility", "Makefile"

Declaration
string ProjAppType { get; }
Property Value
Type Description
string

Methods

GenerateDocumentationFile(string, string)

Returns true if the project generates XML documentations. Otherwise, returns false.

Declaration
bool GenerateDocumentationFile(string platform = "AnyCPU", string configuration = "Release")
Parameters
Type Name Description
string platform
string configuration
Returns
Type Description
bool

GetDocumentationFile(string, string)

Returns the output path value of the project's XML documentation file.

Declaration
string GetDocumentationFile(string platform = "AnyCPU", string configuration = "Release")
Parameters
Type Name Description
string platform
string configuration
Returns
Type Description
string

GetElementValue(string)

Returns the first matched project element value. Elements are searched at the second level of the project (for example: 'PropertyGroup' elements).

Declaration
string? GetElementValue(string elName)
Parameters
Type Name Description
string elName

XML element name (the name of the tag)
Returns
Type Description
string

GetOutPutPath(DotNetOutPathType, string, string)

Returns the "outputType" attribute value if it is found and the condition is matched.

Declaration
string GetOutPutPath(DotNetOutPathType outputType, string platform = "AnyCPU", string configuration = "Release")
Parameters
Type Name Description
DotNetOutPathType outputType

Project output path type
string platform

Applicable platform to match the condition
string configuration

Applicable configuration to match the condition
Returns
Type Description
string

GetProjectReferences(DotNetReferenceType)

Returns project references

Declaration
string[] GetProjectReferences(DotNetReferenceType referenceType)
Parameters
Type Name Description
DotNetReferenceType referenceType
Returns
Type Description
string[]