Project Constructors
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Initializes a new instance of the Project class.
Overloads
| Project() |
This default constructor creates a new Project object associated with the global Engine object. |
| Project(Engine) |
Creates an instance of this class for the given engine. |
| Project(Engine, String) |
Creates an instance of this class for the given engine, specifying a tools version to use during builds of this project. |
Examples
The following example creates a Project object and uses the BuildItem, BuildPropertyBuildItemGroup, and BuildPropertyGroup classes to list all the items and properties in the project.
using System;
using System.Collections.Generic;
using System.Text;
using Microsoft.Build.BuildEngine;
namespace ListItemAndPropertiesCS
{
class Program
{
static void Main(string[] args)
{
// SET THIS TO POINT TO THE RIGHT LOCATION
Engine.GlobalEngine.BinPath = @"C:\Windows\Microsoft.NET\Framework\v2.0.xxxxx";
// Create a new empty project
Project project = new Project();
// Load a project
project.Load(@"c:\temp\validate.proj");
Console.WriteLine("Project Properties");
Console.WriteLine("----------------------------------");
// Iterate through the various property groups and subsequently
// through the various properties
foreach (BuildPropertyGroup propertyGroup in project.PropertyGroups)
{
foreach (BuildProperty prop in propertyGroup)
{
Console.WriteLine("{0}:{1}", prop.Name, prop.Value);
}
}
Console.WriteLine();
Console.WriteLine("Project Items");
Console.WriteLine("----------------------------------");
// Iterate through the various itemgroups
// and subsequently through the items
foreach (BuildItemGroup itemGroup in project.ItemGroups)
{
foreach (BuildItem item in itemGroup)
{
Console.WriteLine("{0}:{1}", item.Name, item.Include);
}
}
}
}
}
Module Module1
'You need to add references to Microsoft.Build.BuildEngine and
'Microsoft.Build.Framework
Sub Main()
'Set this to point to the location where the 2.0 clr/tools are installed
Engine.GlobalEngine.BinPath = "C:\windows\microsoft.net\framework\v2.0.xxxxx"
'Create a new empty project
Dim project As New Project()
'Load a project
project.Load("c:\temp\validate.proj")
'Output a header
Console.WriteLine("Project Properties")
Console.WriteLine("----------------------------------")
'Iterate through the various property groups and subsequently
'through the various properties
For Each propertyGroup As BuildPropertyGroup In project.PropertyGroups
For Each prop As BuildProperty In propertyGroup
Console.WriteLine("{0}:{1}", prop.Name, prop.Value)
Next
Next
Console.WriteLine()
Console.WriteLine("Project Items")
Console.WriteLine("----------------------------------")
'Iterate through the various itemgroups
'and subsequently through the items
For Each itemGroup As BuildItemGroup In project.ItemGroups
For Each item As BuildItem In itemGroup
Console.WriteLine("{0}:{1}", item.Name, item.Include)
Next
Next
End Sub
End Module
Project()
- Source:
- Project.cs
This default constructor creates a new Project object associated with the global Engine object.
public:
Project();public Project ();[System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]
public Project ();Public Sub New ()- Attributes
Examples
The following example creates a Project object and uses the BuildItem, BuildPropertyBuildItemGroup, and BuildPropertyGroup classes to list all the items and properties in the project.
using System;
using System.Collections.Generic;
using System.Text;
using Microsoft.Build.BuildEngine;
namespace ListItemAndPropertiesCS
{
class Program
{
static void Main(string[] args)
{
// SET THIS TO POINT TO THE RIGHT LOCATION
Engine.GlobalEngine.BinPath = @"C:\Windows\Microsoft.NET\Framework\v2.0.xxxxx";
// Create a new empty project
Project project = new Project();
// Load a project
project.Load(@"c:\temp\validate.proj");
Console.WriteLine("Project Properties");
Console.WriteLine("----------------------------------");
// Iterate through the various property groups and subsequently
// through the various properties
foreach (BuildPropertyGroup propertyGroup in project.PropertyGroups)
{
foreach (BuildProperty prop in propertyGroup)
{
Console.WriteLine("{0}:{1}", prop.Name, prop.Value);
}
}
Console.WriteLine();
Console.WriteLine("Project Items");
Console.WriteLine("----------------------------------");
// Iterate through the various itemgroups
// and subsequently through the items
foreach (BuildItemGroup itemGroup in project.ItemGroups)
{
foreach (BuildItem item in itemGroup)
{
Console.WriteLine("{0}:{1}", item.Name, item.Include);
}
}
}
}
}
Module Module1
'You need to add references to Microsoft.Build.BuildEngine and
'Microsoft.Build.Framework
Sub Main()
'Set this to point to the location where the 2.0 clr/tools are installed
Engine.GlobalEngine.BinPath = "C:\windows\microsoft.net\framework\v2.0.xxxxx"
'Create a new empty project
Dim project As New Project()
'Load a project
project.Load("c:\temp\validate.proj")
'Output a header
Console.WriteLine("Project Properties")
Console.WriteLine("----------------------------------")
'Iterate through the various property groups and subsequently
'through the various properties
For Each propertyGroup As BuildPropertyGroup In project.PropertyGroups
For Each prop As BuildProperty In propertyGroup
Console.WriteLine("{0}:{1}", prop.Name, prop.Value)
Next
Next
Console.WriteLine()
Console.WriteLine("Project Items")
Console.WriteLine("----------------------------------")
'Iterate through the various itemgroups
'and subsequently through the items
For Each itemGroup As BuildItemGroup In project.ItemGroups
For Each item As BuildItem In itemGroup
Console.WriteLine("{0}:{1}", item.Name, item.Include)
Next
Next
End Sub
End Module
Applies to
Project(Engine)
- Source:
- Project.cs
Creates an instance of this class for the given engine.
public:
Project(Microsoft::Build::BuildEngine::Engine ^ engine);public Project (Microsoft.Build.BuildEngine.Engine engine);[System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]
public Project (Microsoft.Build.BuildEngine.Engine engine);new Microsoft.Build.BuildEngine.Project : Microsoft.Build.BuildEngine.Engine -> Microsoft.Build.BuildEngine.Project[<System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]
new Microsoft.Build.BuildEngine.Project : Microsoft.Build.BuildEngine.Engine -> Microsoft.Build.BuildEngine.ProjectPublic Sub New (engine As Engine)Parameters
- engine
- Engine
Engine that will build this project.
- Attributes
Examples
The following example creates a Project object and uses the LoadXml method to add content to the project. The BuildItem, BuildItemGroup, and BuildItemGroupCollection classes are used to add, remove, and change items in the project.
using System;
using System.Collections.Generic;
using System.Text;
using Microsoft.Build.BuildEngine;
namespace AddNewItem
{
class Program
{
/// <summary>
/// This code demonstrates the use of the following methods:
/// Engine constructor
/// Project constructor
/// Project.LoadFromXml
/// Project.Xml
/// BuildItemGroupCollection.GetEnumerator
/// BuildItemGroup.GetEnumerator
/// BuildItem.Name (get)
/// BuildItem.Include (set)
/// BuildItem.GetMetadata
/// BuildItem.SetMetadata
/// BuildItemGroup.RemoveItem
/// BuildItemGroup.AddNewItem
/// </summary>
/// <param name="args"></param>
static void Main(string[] args)
{
// Create a new Engine object.
Engine engine = new Engine(Environment.CurrentDirectory);
// Create a new Project object.
Project project = new Project(engine);
// Load the project with the following XML, which contains
// two ItemGroups.
project.LoadXml(@"
<Project xmlns='http://schemas.microsoft.com/developer/msbuild/2003'>
<ItemGroup>
<Compile Include='Program.cs'/>
<Compile Include='Class1.cs'/>
<RemoveThisItemPlease Include='readme.txt'/>
</ItemGroup>
<ItemGroup>
<EmbeddedResource Include='Strings.resx'>
<LogicalName>Strings.resources</LogicalName>
<Culture>fr-fr</Culture>
</EmbeddedResource>
</ItemGroup>
</Project>
");
// Iterate through each ItemGroup in the Project. There are two.
foreach (BuildItemGroup ig in project.ItemGroups)
{
BuildItem itemToRemove = null;
// Iterate through each Item in the ItemGroup.
foreach (BuildItem item in ig)
{
// If the item's name is "RemoveThisItemPlease", then
// store a reference to this item in a local variable,
// so we can remove it later.
if (item.Name == "RemoveThisItemPlease")
{
itemToRemove = item;
}
// If the item's name is "EmbeddedResource" and it has a metadata Culture
// set to "fr-fr", then ...
if ((item.Name == "EmbeddedResource") && (item.GetMetadata("Culture") == "fr-fr"))
{
// Change the item's Include path to "FrenchStrings.fr.resx",
// and add a new metadata Visiable="false".
item.Include = @"FrenchStrings.fr.resx";
item.SetMetadata("Visible", "false");
}
}
// Remove the item named "RemoveThisItemPlease" from the
// ItemGroup
if (itemToRemove != null)
{
ig.RemoveItem(itemToRemove);
}
// For each ItemGroup that we found, add to the end of it
// a new item Content with Include="SplashScreen.bmp".
ig.AddNewItem("Content", "SplashScreen.bmp");
}
// The project now looks like this:
//
// <?xml version="1.0" encoding="utf-16"?>
// <Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
// <Compile Include="Program.cs" />
// <Compile Include="Class1.cs" />
// <Content Include="SplashScreen.bmp" />
// <EmbeddedResource Include="FrenchStrings.fr.resx">
// <LogicalName>Strings.resources</LogicalName>
// <Culture>fr-fr</Culture>
// <Visible>false</Visible>
// <Content Include="SplashScreen.bmp" />
//
Console.WriteLine(project.Xml);
}
}
}
Module Module1
''' <summary>
''' This code demonstrates the use of the following methods:
''' Engine constructor
''' Project constructor
''' Project.LoadFromXml
''' Project.Xml
''' BuildItemGroupCollection.GetEnumerator
''' BuildItemGroup.GetEnumerator
''' BuildItem.Name (get)
''' BuildItem.Include (set)
''' BuildItem.GetMetadata
''' BuildItem.SetMetadata
''' BuildItemGroup.RemoveItem
''' BuildItemGroup.AddNewItem
''' </summary>
''' <remarks></remarks>
Sub Main()
' Create a new Engine object.
Dim engine As New Engine(Environment.CurrentDirectory)
' Create a new Project object.
Dim project As New Project(engine)
' Load the project with the following XML, which contains
' two ItemGroups.
project.LoadXml( _
"<Project xmlns='http://schemas.microsoft.com/developer/msbuild/2003'>" & _
"<ItemGroup>" & _
"<Compile Include='Program.cs'/>" & _
"<Compile Include='Class1.cs'/>" & _
"<RemoveThisItemPlease Include='readme.txt'/>" & _
"</ItemGroup>" & _
"<ItemGroup>" & _
"<EmbeddedResource Include='Strings.resx'>" & _
"<LogicalName>Strings.resources</LogicalName>" & _
"<Culture>fr-fr</Culture>" & _
"</EmbeddedResource>" & _
"</ItemGroup>" & _
"</Project>" _
)
' Iterate through each ItemGroup in the Project. There are two.
For Each ig As BuildItemGroup In project.ItemGroups
Dim itemToRemove As BuildItem
itemToRemove = Nothing
' Iterate through each Item in the ItemGroup.
For Each item As BuildItem In ig
' If the item's name is "RemoveThisItemPlease", then
' store a reference to this item in a local variable,
' so we can remove it later.
If item.Name = "RemoveThisItemPlease" Then
itemToRemove = item
End If
' If the item's name is "EmbeddedResource" and it has a metadata Culture
' set to "fr-fr", then ...
If (item.Name = "EmbeddedResource") And (item.GetMetadata("Culture") = "fr-fr") Then
' Change the item's Include path to "FrenchStrings.fr.resx",
' and add a new metadata Visiable="false".
item.Include = "FrenchStrings.fr.resx"
item.SetMetadata("Visible", "false")
End If
Next
' Remove the item named "RemoveThisItemPlease" from the
' ItemGroup
If Not itemToRemove Is Nothing Then
ig.RemoveItem(itemToRemove)
End If
' For each ItemGroup that we found, add to the end of it
' a new item Content with Include="SplashScreen.bmp".
ig.AddNewItem("Content", "SplashScreen.bmp")
Next
' The project now looks like this:
'
' <?xml version="1.0" encoding="utf-16"?>
' <Project xmlns="http:'schemas.microsoft.com/developer/msbuild/2003">
' <Compile Include="Program.cs" />
' <Compile Include="Class1.cs" />
' <Content Include="SplashScreen.bmp" />
' <EmbeddedResource Include="FrenchStrings.fr.resx">
' <LogicalName>Strings.resources</LogicalName>
' <Culture>fr-fr</Culture>
' <Visible>false</Visible>
' <Content Include="SplashScreen.bmp" />
'
Console.WriteLine(project.Xml)
End Sub
End Module
Applies to
Project(Engine, String)
- Source:
- Project.cs
Creates an instance of this class for the given engine, specifying a tools version to use during builds of this project.
public:
Project(Microsoft::Build::BuildEngine::Engine ^ engine, System::String ^ toolsVersion);public Project (Microsoft.Build.BuildEngine.Engine engine, string toolsVersion);new Microsoft.Build.BuildEngine.Project : Microsoft.Build.BuildEngine.Engine * string -> Microsoft.Build.BuildEngine.ProjectPublic Sub New (engine As Engine, toolsVersion As String)Parameters
- engine
- Engine
Engine that will build this project. May be null if the global engine is expected.
- toolsVersion
- String
Tools version to use during builds of this project instance. May be null, in which case we will use the value in the Project's ToolsVersion attribute, or else the engine default value.