BuildPropertyGroup.AddNewProperty Method
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.
Adds a new BuildProperty to the BuildPropertyGroup.
Overloads
AddNewProperty(String, String) |
Adds a new BuildProperty with the specified Name and Value to the BuildPropertyGroup. |
AddNewProperty(String, String, Boolean) |
Adds a new BuildProperty with the specified Name and Value to the BuildPropertyGroup. |
Remarks
The following example creates a Project object and uses the LoadXml method to add content to the project. The BuildProperty, BuildPropertyGroup, and BuildPropertyGroupCollection 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 AddNewProperty
{
class Program
{
/// <summary>
/// This code demonstrates the use of the following methods:
/// Engine constructor
/// Project constructor
/// Project.LoadFromXml
/// Project.Xml
/// BuildPropertyGroupCollection.GetEnumerator
/// BuildPropertyGroup.GetEnumerator
/// BuildProperty.Name (get)
/// BuildProperty.Value (set)
/// BuildPropertyGroup.RemoveProperty
/// BuildPropertyGroup.AddNewProperty
/// </summary>
static void Main()
{
// 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 PropertyGroups.
project.LoadXml(@"
<Project xmlns='http://schemas.microsoft.com/developer/msbuild/2003'>
<PropertyGroup>
<Optimize>true</Optimize>
<WarningLevel>4</WarningLevel>
</PropertyGroup>
<PropertyGroup>
<OutputPath>bin\debug\</OutputPath>
<RemoveThisPropertyPlease>1</RemoveThisPropertyPlease>
</PropertyGroup>
</Project>
");
// Iterate through each PropertyGroup in the Project. There are two.
foreach (BuildPropertyGroup pg in project.PropertyGroups)
{
BuildProperty propertyToRemove = null;
// Iterate through each Property in the PropertyGroup.
foreach (BuildProperty property in pg)
{
// If the property's name is "RemoveThisPropertyPlease", then
// store a reference to this property in a local variable,
// so we can remove it later.
if (property.Name == "RemoveThisPropertyPlease")
{
propertyToRemove = property;
}
// If the property's name is "OutputPath", change its value
// from "bin\debug\" to "bin\release\".
if (property.Name == "OutputPath")
{
property.Value = @"bin\release\";
}
}
// Remove the property named "RemoveThisPropertyPlease" from the
// PropertyGroup
if (propertyToRemove != null)
{
pg.RemoveProperty(propertyToRemove);
}
// For each PropertyGroup that we found, add to the end of it
// a new property called "MyNewProperty".
pg.AddNewProperty("MyNewProperty", "MyNewValue");
}
// The project now looks like this:
//
// <?xml version="1.0" encoding="utf-16"?>
// <Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
// <Optimize>true</Optimize>
// <WarningLevel>4</WarningLevel>
// <MyNewProperty>MyNewValue</MyNewProperty>
// <OutputPath>bin\release</OutputPath>
// <MyNewProperty>MyNewValue</MyNewProperty>
Console.WriteLine(project.Xml);
}
}
}
Module Module1
''' <summary>
''' This code demonstrates the use of the following methods:
''' Engine constructor
''' Project constructor
''' Project.LoadFromXml
''' Project.Xml
''' BuildPropertyGroupCollection.GetEnumerator
''' BuildPropertyGroup.GetEnumerator
''' BuildProperty.Name (get)
''' BuildProperty.Value (set)
''' BuildPropertyGroup.RemoveProperty
''' BuildPropertyGroup.AddNewProperty
''' </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 PropertyGroups.
project.LoadXml( _
"<Project xmlns='http://schemas.microsoft.com/developer/msbuild/2003'>" & _
"<PropertyGroup>" & _
"<Optimize>true</Optimize>" & _
"<WarningLevel>4</WarningLevel>" & _
"</PropertyGroup>" & _
"<PropertyGroup>" & _
"<OutputPath>bin\debug\</OutputPath>" & _
"<RemoveThisPropertyPlease>1</RemoveThisPropertyPlease>" & _
"</PropertyGroup>" & _
"</Project>")
' Iterate through each PropertyGroup in the Project. There are two.
For Each pg As BuildPropertyGroup In project.PropertyGroups
Dim propertyToRemove As BuildProperty
propertyToRemove = Nothing
' Iterate through each Property in the PropertyGroup.
For Each buildProperty As BuildProperty In pg
' If the property's name is "RemoveThisPropertyPlease", then
' store a reference to this property in a local variable,
' so we can remove it later.
If buildProperty.Name = "RemoveThisPropertyPlease" Then
propertyToRemove = buildProperty
End If
' If the property's name is "OutputPath", change its value
' from "bin\debug\" to "bin\release\".
If buildProperty.Name = "OutputPath" Then
buildProperty.Value = "bin\release\"
End If
Next
' Remove the property named "RemoveThisPropertyPlease" from the
' PropertyGroup
If Not propertyToRemove Is Nothing Then
pg.RemoveProperty(propertyToRemove)
End If
' For each PropertyGroup that we found, add to the end of it
' a new property called "MyNewProperty".
pg.AddNewProperty("MyNewProperty", "MyNewValue")
Next
' The project now looks like this:
'
' <?xml version="1.0" encoding="utf-16"?>
' <Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
' <Optimize>true</Optimize>
' <WarningLevel>4</WarningLevel>
' <MyNewProperty>MyNewValue</MyNewProperty>
' <OutputPath>bin\release</OutputPath>
' <MyNewProperty>MyNewValue</MyNewProperty>
Console.WriteLine(project.Xml)
End Sub
End Module
AddNewProperty(String, String)
Adds a new BuildProperty with the specified Name and Value to the BuildPropertyGroup.
public:
Microsoft::Build::BuildEngine::BuildProperty ^ AddNewProperty(System::String ^ propertyName, System::String ^ propertyValue);
public Microsoft.Build.BuildEngine.BuildProperty AddNewProperty (string propertyName, string propertyValue);
member this.AddNewProperty : string * string -> Microsoft.Build.BuildEngine.BuildProperty
Public Function AddNewProperty (propertyName As String, propertyValue As String) As BuildProperty
Parameters
- propertyName
- String
The Name property value to assign the new BuildProperty.
- propertyValue
- String
The Value property value to assign the new BuildProperty.
Returns
The new BuildProperty.
Examples
The following example creates a Project object and uses the LoadXml method to add content to the project. The BuildProperty, BuildPropertyGroup, and BuildPropertyGroupCollection 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 AddNewProperty
{
class Program
{
/// <summary>
/// This code demonstrates the use of the following methods:
/// Engine constructor
/// Project constructor
/// Project.LoadFromXml
/// Project.Xml
/// BuildPropertyGroupCollection.GetEnumerator
/// BuildPropertyGroup.GetEnumerator
/// BuildProperty.Name (get)
/// BuildProperty.Value (set)
/// BuildPropertyGroup.RemoveProperty
/// BuildPropertyGroup.AddNewProperty
/// </summary>
static void Main()
{
// 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 PropertyGroups.
project.LoadXml(@"
<Project xmlns='http://schemas.microsoft.com/developer/msbuild/2003'>
<PropertyGroup>
<Optimize>true</Optimize>
<WarningLevel>4</WarningLevel>
</PropertyGroup>
<PropertyGroup>
<OutputPath>bin\debug\</OutputPath>
<RemoveThisPropertyPlease>1</RemoveThisPropertyPlease>
</PropertyGroup>
</Project>
");
// Iterate through each PropertyGroup in the Project. There are two.
foreach (BuildPropertyGroup pg in project.PropertyGroups)
{
BuildProperty propertyToRemove = null;
// Iterate through each Property in the PropertyGroup.
foreach (BuildProperty property in pg)
{
// If the property's name is "RemoveThisPropertyPlease", then
// store a reference to this property in a local variable,
// so we can remove it later.
if (property.Name == "RemoveThisPropertyPlease")
{
propertyToRemove = property;
}
// If the property's name is "OutputPath", change its value
// from "bin\debug\" to "bin\release\".
if (property.Name == "OutputPath")
{
property.Value = @"bin\release\";
}
}
// Remove the property named "RemoveThisPropertyPlease" from the
// PropertyGroup
if (propertyToRemove != null)
{
pg.RemoveProperty(propertyToRemove);
}
// For each PropertyGroup that we found, add to the end of it
// a new property called "MyNewProperty".
pg.AddNewProperty("MyNewProperty", "MyNewValue");
}
// The project now looks like this:
//
// <?xml version="1.0" encoding="utf-16"?>
// <Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
// <Optimize>true</Optimize>
// <WarningLevel>4</WarningLevel>
// <MyNewProperty>MyNewValue</MyNewProperty>
// <OutputPath>bin\release</OutputPath>
// <MyNewProperty>MyNewValue</MyNewProperty>
Console.WriteLine(project.Xml);
}
}
}
Module Module1
''' <summary>
''' This code demonstrates the use of the following methods:
''' Engine constructor
''' Project constructor
''' Project.LoadFromXml
''' Project.Xml
''' BuildPropertyGroupCollection.GetEnumerator
''' BuildPropertyGroup.GetEnumerator
''' BuildProperty.Name (get)
''' BuildProperty.Value (set)
''' BuildPropertyGroup.RemoveProperty
''' BuildPropertyGroup.AddNewProperty
''' </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 PropertyGroups.
project.LoadXml( _
"<Project xmlns='http://schemas.microsoft.com/developer/msbuild/2003'>" & _
"<PropertyGroup>" & _
"<Optimize>true</Optimize>" & _
"<WarningLevel>4</WarningLevel>" & _
"</PropertyGroup>" & _
"<PropertyGroup>" & _
"<OutputPath>bin\debug\</OutputPath>" & _
"<RemoveThisPropertyPlease>1</RemoveThisPropertyPlease>" & _
"</PropertyGroup>" & _
"</Project>")
' Iterate through each PropertyGroup in the Project. There are two.
For Each pg As BuildPropertyGroup In project.PropertyGroups
Dim propertyToRemove As BuildProperty
propertyToRemove = Nothing
' Iterate through each Property in the PropertyGroup.
For Each buildProperty As BuildProperty In pg
' If the property's name is "RemoveThisPropertyPlease", then
' store a reference to this property in a local variable,
' so we can remove it later.
If buildProperty.Name = "RemoveThisPropertyPlease" Then
propertyToRemove = buildProperty
End If
' If the property's name is "OutputPath", change its value
' from "bin\debug\" to "bin\release\".
If buildProperty.Name = "OutputPath" Then
buildProperty.Value = "bin\release\"
End If
Next
' Remove the property named "RemoveThisPropertyPlease" from the
' PropertyGroup
If Not propertyToRemove Is Nothing Then
pg.RemoveProperty(propertyToRemove)
End If
' For each PropertyGroup that we found, add to the end of it
' a new property called "MyNewProperty".
pg.AddNewProperty("MyNewProperty", "MyNewValue")
Next
' The project now looks like this:
'
' <?xml version="1.0" encoding="utf-16"?>
' <Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
' <Optimize>true</Optimize>
' <WarningLevel>4</WarningLevel>
' <MyNewProperty>MyNewValue</MyNewProperty>
' <OutputPath>bin\release</OutputPath>
' <MyNewProperty>MyNewValue</MyNewProperty>
Console.WriteLine(project.Xml)
End Sub
End Module
Applies to
AddNewProperty(String, String, Boolean)
Adds a new BuildProperty with the specified Name and Value to the BuildPropertyGroup.
public:
Microsoft::Build::BuildEngine::BuildProperty ^ AddNewProperty(System::String ^ propertyName, System::String ^ propertyValue, bool treatPropertyValueAsLiteral);
public Microsoft.Build.BuildEngine.BuildProperty AddNewProperty (string propertyName, string propertyValue, bool treatPropertyValueAsLiteral);
member this.AddNewProperty : string * string * bool -> Microsoft.Build.BuildEngine.BuildProperty
Public Function AddNewProperty (propertyName As String, propertyValue As String, treatPropertyValueAsLiteral As Boolean) As BuildProperty
Parameters
- propertyName
- String
The Name property value to assign the new BuildProperty.
- propertyValue
- String
The Value property value to assign the new BuildProperty.
- treatPropertyValueAsLiteral
- Boolean
true
to treat the propertyValue
parameter as a literal value; otherwise, false
.
Returns
The new BuildProperty.