BuildProperty.Name Property
Gets the property name.
MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0.
Namespace: Microsoft.Build.BuildEngine
Assembly: Microsoft.Build.Engine (in Microsoft.Build.Engine.dll)
Syntax
'Declaration
Public ReadOnly Property Name As String
public string Name { get; }
public:
property String^ Name {
String^ get ();
}
member Name : string with get
function get Name () : String
Property Value
Type: System.String
The property name.
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.
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='https://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="https://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
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='https://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="https://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);
}
}
}
.NET Framework Security
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see dd66cd4c-b087-415f-9c3e-94e3a1835f74.