BuildPropertyGroup Class

Represents a collection of BuildProperty objects.

System.Object
  Microsoft.Build.BuildEngine.BuildPropertyGroup

Namespace:  Microsoft.Build.BuildEngine
Assembly:  Microsoft.Build.Engine (in Microsoft.Build.Engine.dll)

public class BuildPropertyGroup : IEnumerable

The BuildPropertyGroup type exposes the following members.

  NameDescription
Public methodBuildPropertyGroup()Initializes a new instance of the BuildPropertyGroup class.
Public methodBuildPropertyGroup(Project)Initializes a new PropertyGroup element in the specified project.
Top

  NameDescription
Public propertyConditionGets or sets the Condition attribute value of the property group.
Public propertyCountGets a value indicating the number of BuildProperty objects in the BuildPropertyGroup.
Public propertyIsImportedGets or sets a value indicating whether the property group was imported into the project.
Public propertyItemGets or sets a BuildProperty object in this BuildPropertyGroup.
Top

  NameDescription
Public methodAddNewProperty(String, String)Adds a new BuildProperty with the specified Name and Value to the BuildPropertyGroup.
Public methodAddNewProperty(String, String, Boolean)Adds a new BuildProperty with the specified Name and Value to the BuildPropertyGroup.
Public methodClearRemoves the Condition property value and all BuildProperty objects from the BuildPropertyGroup.
Public methodCloneCreates a deep or shallow copy of the BuildPropertyGroup.
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetEnumeratorGets an enumerator that iterates through the BuildPropertyGroup.
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodRemoveProperty(BuildProperty)Removes the specified BuildProperty from the BuildPropertyGroup.
Public methodRemoveProperty(String)Removes the BuildProperty with the specified Name from the BuildPropertyGroup.
Public methodSetImportedPropertyGroupConditionSets the condition for imported property groups. Changes are not persisted.
Public methodSetProperty(String, String)Sets the Value of the BuildProperty with the specified Name.
Public methodSetProperty(String, String, Boolean)Sets the Value of the BuildProperty with the specified Name.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Public Extension MethodAsParallelEnables parallelization of a query. (Defined by ParallelEnumerable.)
Public Extension MethodAsQueryableConverts an IEnumerable to an IQueryable. (Defined by Queryable.)
Public Extension MethodCast<TResult>Casts the elements of an IEnumerable to the specified type. (Defined by Enumerable.)
Public Extension MethodOfType<TResult>Filters the elements of an IEnumerable based on a specified type. (Defined by Enumerable.)
Top

A BuildPropertyGroup object can represent a PropertyGroup element in the project, or a virtual collection of properties, such as global properties or environment variable properties.

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">
            //       <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

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft