This documentation is archived and is not being maintained.

BuildItemGroup Class

Represents a collection of BuildItem objects.


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

public class BuildItemGroup : IEnumerable

The BuildItemGroup type exposes the following members.

Public methodBuildItemGroupInitializes a new instance of the BuildItemGroup class.

Public propertyConditionGets or sets the Condition attribute value of the item group.
Public propertyCountGets a value indicating the number of BuildItem objects in the BuildItemGroup.
Public propertyIsImportedGets or sets a value indicating whether the item group was imported into the project.
Public propertyItemGets or sets a BuildItem object in this BuildItemGroup.

Public methodAddNewItem(String, String)Adds a new BuildItem with the specified Name and Include property values to the BuildItemGroup.
Public methodAddNewItem(String, String, Boolean)Adds a new BuildItem with the specified Name and Include property values to the BuildItemGroup, allowing you to specify whether the Include property value is treated as a literal.
Public methodClearRemoves the Condition property value and all BuildItem objects from the BuildItemGroup.
Public methodCloneCreates a deep or shallow copy of the BuildItemGroup.
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 BuildItemGroup.
Public methodGetHashCodeServes as a hash function for a particular type. (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 methodRemoveItemRemoves the specified BuildItem from the BuildItemGroup.
Public methodRemoveItemAtRemoves the BuildItem at the specified index from the BuildItemGroup.
Public methodToArrayCopies the BuildItem objects in the BuildItemGroup to a new array.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

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>Converts 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.)

A BuildItemGroup object can represent an ItemGroup element in the project, or a virtual collection of items, containing the items created after evaluating wildcards in the Include and Exclude attributes of an Item element.

The following example creates a Project object and uses the LoadXml method to add content to the project. The BuildItem, BuildItemGroup, and BuildItemGroupCollection 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 AddNewItem
    class Program
        /// <summary>
        /// This code demonstrates the use of the following methods:
        ///     Engine constructor
        ///     Project constructor
        ///     Project.LoadFromXml
        ///     Project.Xml
        ///     BuildItemGroupCollection.GetEnumerator
        ///     BuildItemGroup.GetEnumerator
        ///     BuildItem.Name (get)
        ///     BuildItem.Include (set)
        ///     BuildItem.GetMetadata
        ///     BuildItem.SetMetadata
        ///     BuildItemGroup.RemoveItem
        ///     BuildItemGroup.AddNewItem
        /// </summary>
        /// <param name="args"></param>
        static void Main(string[] args)
            // 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 ItemGroups.
                <Project xmlns=''>

                        <Compile Include='Program.cs'/>
                        <Compile Include='Class1.cs'/>
                        <RemoveThisItemPlease Include='readme.txt'/>

                        <EmbeddedResource Include='Strings.resx'>


            // Iterate through each ItemGroup in the Project.  There are two.
            foreach (BuildItemGroup ig in project.ItemGroups)
                BuildItem itemToRemove = null;

                // Iterate through each Item in the ItemGroup.
                foreach (BuildItem item in ig)
                    // If the item's name is "RemoveThisItemPlease", then
                    // store a reference to this item in a local variable,
                    // so we can remove it later.
                    if (item.Name == "RemoveThisItemPlease")
                        itemToRemove = item;

                    // If the item's name is "EmbeddedResource" and it has a metadata Culture
                    // set to "fr-fr", then ...
                    if ((item.Name == "EmbeddedResource") && (item.GetMetadata("Culture") == "fr-fr"))
                        // Change the item's Include path to "", 
                        // and add a new metadata Visiable="false".
                        item.Include = @"";
                        item.SetMetadata("Visible", "false");

                // Remove the item named "RemoveThisItemPlease" from the
                // ItemGroup
                if (itemToRemove != null)

                // For each ItemGroup that we found, add to the end of it
                // a new item Content with Include="SplashScreen.bmp".
                ig.AddNewItem("Content", "SplashScreen.bmp");

            // The project now looks like this:
            //     <?xml version="1.0" encoding="utf-16"?>
            //     <Project xmlns="">
            //       <ItemGroup>
            //         <Compile Include="Program.cs" />
            //         <Compile Include="Class1.cs" />
            //         <Content Include="SplashScreen.bmp" />
            //       </ItemGroup>
            //       <ItemGroup>
            //         <EmbeddedResource Include="">
            //           <LogicalName>Strings.resources</LogicalName>
            //           <Culture>fr-fr</Culture>
            //           <Visible>false</Visible>
            //         </EmbeddedResource>
            //         <Content Include="SplashScreen.bmp" />
            //       </ItemGroup>
            //     </Project>

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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.