BuildPropertyGroup Class

BuildPropertyGroup Class

 

Represents a collection of BuildProperty objects.

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

System.Object
  Microsoft.Build.BuildEngine.BuildPropertyGroup

public class BuildPropertyGroup : IEnumerable

NameDescription
System_CAPS_pubmethodBuildPropertyGroup()

Initializes a new instance of the BuildPropertyGroup class.

System_CAPS_pubmethodBuildPropertyGroup(Project)

Initializes a new PropertyGroup element in the specified project.

NameDescription
System_CAPS_pubpropertyCondition

Gets or sets the Condition attribute value of the property group.

System_CAPS_pubpropertyCount

Gets a value indicating the number of BuildProperty objects in the BuildPropertyGroup.

System_CAPS_pubpropertyIsImported

Gets or sets a value indicating whether the property group was imported into the project.

System_CAPS_pubpropertyItem[String]

Gets or sets a BuildProperty object in this BuildPropertyGroup.

NameDescription
System_CAPS_pubmethodAddNewProperty(String, String)

Adds a new BuildProperty with the specified Name and Value to the BuildPropertyGroup.

System_CAPS_pubmethodAddNewProperty(String, String, Boolean)

Adds a new BuildProperty with the specified Name and Value to the BuildPropertyGroup.

System_CAPS_pubmethodClear()

Removes the Condition property value and all BuildProperty objects from the BuildPropertyGroup.

System_CAPS_pubmethodClone(Boolean)

Creates a deep or shallow copy of the BuildPropertyGroup.

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetEnumerator()

Gets an enumerator that iterates through the BuildPropertyGroup.

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodRemoveProperty(BuildProperty)

Removes the specified BuildProperty from the BuildPropertyGroup.

System_CAPS_pubmethodRemoveProperty(String)

Removes the BuildProperty with the specified Name from the BuildPropertyGroup.

System_CAPS_pubmethodSetImportedPropertyGroupCondition(String)

Sets the condition for imported property groups. Changes are not persisted.

System_CAPS_pubmethodSetProperty(String, String)

Sets the Value of the BuildProperty with the specified Name.

System_CAPS_pubmethodSetProperty(String, String, Boolean)

Sets the Value of the BuildProperty with the specified Name.

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

NameDescription
System_CAPS_pubmethodAsParallel()

Overloaded. Enables parallelization of a query.(Defined by ParallelEnumerable.)

System_CAPS_pubmethodAsQueryable()

Overloaded. Converts an IEnumerable to an IQueryable.(Defined by Queryable.)

System_CAPS_pubmethodCast<TResult>()

Casts the elements of an IEnumerable to the specified type.(Defined by Enumerable.)

System_CAPS_pubmethodOfType<TResult>()

Filters the elements of an IEnumerable based on a specified type.(Defined by Enumerable.)

A BuildPropertyGroup object can represent a 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
Available since 2.0

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show:
© 2016 Microsoft