BuildPropertyGroup.RemoveProperty 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.
Removes the specified BuildProperty from the BuildPropertyGroup.
Overloads
| RemoveProperty(BuildProperty) |
This method (and the whole namespace) is deprecated. Please use the classes in these namespaces instead: Microsoft.Build.ConstructionMicrosoft.Build.EvaluationMicrosoft.Build.Execution Removes the given BuildProperty object from either a persisted or a virtual BuildPropertyGroup. |
| RemoveProperty(String) |
This method (and the whole namespace) is deprecated. Please use the classes in these namespaces instead: Microsoft.Build.ConstructionMicrosoft.Build.EvaluationMicrosoft.Build.Execution Removes all properties with the given name from either a persisted or a virtual BuildPropertyGroup. For persisted PropertyGroups, there could be multiple. For a virtual BuildPropertyGroup, there can be only one. |
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
RemoveProperty(BuildProperty)
- Source:
- BuildPropertyGroup.cs
This method (and the whole namespace) is deprecated. Please use the classes in these namespaces instead: Microsoft.Build.ConstructionMicrosoft.Build.EvaluationMicrosoft.Build.Execution
Removes the given BuildProperty object from either a persisted or a virtual BuildPropertyGroup.
public:
void RemoveProperty(Microsoft::Build::BuildEngine::BuildProperty ^ property);public void RemoveProperty (Microsoft.Build.BuildEngine.BuildProperty property);member this.RemoveProperty : Microsoft.Build.BuildEngine.BuildProperty -> unitPublic Sub RemoveProperty (property As BuildProperty)Parameters
- property
- BuildProperty
Remarks
Warning
This method (and the whole namespace) is deprecated. Please use the classes in these namespaces instead: Microsoft.Build.Construction Microsoft.Build.Evaluation Microsoft.Build.Execution
Applies to
RemoveProperty(String)
- Source:
- BuildPropertyGroup.cs
This method (and the whole namespace) is deprecated. Please use the classes in these namespaces instead: Microsoft.Build.ConstructionMicrosoft.Build.EvaluationMicrosoft.Build.Execution
Removes all properties with the given name from either a persisted or a virtual BuildPropertyGroup. For persisted PropertyGroups, there could be multiple. For a virtual BuildPropertyGroup, there can be only one.
public:
void RemoveProperty(System::String ^ propertyName);public void RemoveProperty (string propertyName);member this.RemoveProperty : string -> unitPublic Sub RemoveProperty (propertyName As String)Parameters
- propertyName
- String
Remarks
Warning
This method (and the whole namespace) is deprecated. Please use the classes in these namespaces instead: Microsoft.Build.Construction Microsoft.Build.Evaluation Microsoft.Build.Execution