BuildProperty Class
.NET Framework 2.0
Note: This class is new in the .NET Framework version 2.0.
Represents a single property in an MSBuild project.
Namespace: Microsoft.Build.BuildEngine
Assembly: Microsoft.Build.Engine (in microsoft.build.engine.dll)
Assembly: Microsoft.Build.Engine (in microsoft.build.engine.dll)
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.
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"> ' <PropertyGroup> ' <Optimize>true</Optimize> ' <WarningLevel>4</WarningLevel> ' <MyNewProperty>MyNewValue</MyNewProperty> ' </PropertyGroup> ' <PropertyGroup> ' <OutputPath>bin\release</OutputPath> ' <MyNewProperty>MyNewValue</MyNewProperty> ' </PropertyGroup> ' </Project> Console.WriteLine(project.Xml) End Sub End Module
Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.
Community Additions
ADD
Show: