BuildItem Class

Represents a single item in an MSBuild project. 

System.Object
  Microsoft.Build.BuildEngine.BuildItem

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

[DebuggerDisplayAttribute("BuildItem (Name = { Name }, Include = { Include }, FinalItemSpec = { FinalItemSpec }, Condition = { Condition } )")]
public class BuildItem

The BuildItem type exposes the following members.

  NameDescription
Public methodBuildItem(String, ITaskItem)Initializes a new instance of the BuildItem class based on an ITaskItem object.
Public methodBuildItem(String, String)Initializes a new instance of the BuildItem class with the specified Name and Include property values.
Top

  NameDescription
Public propertyConditionGets or sets the Condition attribute value of the item.
Public propertyCustomMetadataCountGets the number of custom attributes that are set on this item.
Public propertyCustomMetadataNamesGets all user-defined or custom attribute names.
Public propertyExcludeGets or sets the Exclude attribute value of the item.
Public propertyFinalItemSpecGets the final specification of the item after all wildcards and properties have been evaluated.
Public propertyIncludeGets or sets the Include attribute that created the BuildItem.
Public propertyIsImportedGets a value indicating whether the item was imported into the project.
Public propertyMetadataCountGets the number of metadata set on the item
Public propertyMetadataNamesGets the names of metadata on the item, including pre-defined or reserved item-spec modifiers.
Public propertyNameGets or sets the name of the item collection to which the item belongs.
Top

  NameDescription
Public methodCloneCreates a shallow copy of the BuildItem.
Public methodCopyCustomMetadataToCopies all item metadata on this BuildItem to the specified BuildItem.
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 methodGetEvaluatedMetadataReturns the value of the specified item metadata after after all item and property references have been evaluated.
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetMetadataReturns the value of the specified item metadata.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodHasMetadataIndicates whether the item has the specified item metadata.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodRemoveMetadataRemoves the specified item metadata.
Public methodSetMetadata(String, String)Assigns the specified value to the specified item metadata.
Public methodSetMetadata(String, String, Boolean)Assigns the specified value to the specified item metadata, and optionally treats the metadata as a literal value.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

An Item element in a project can represent multiple items through the use of wildcards. Therefore, each BuildItem object does not necessarily represent an Item element in the project.

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.LoadXml(@"
                <Project xmlns='http://schemas.microsoft.com/developer/msbuild/2003'>

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

                    <ItemGroup>
                        <EmbeddedResource Include='Strings.resx'>
                            <LogicalName>Strings.resources</LogicalName>
                            <Culture>fr-fr</Culture>
                        </EmbeddedResource>
                    </ItemGroup>

                </Project>
                ");

            // 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 "FrenchStrings.fr.resx", 
                        // and add a new metadata Visiable="false".
                        item.Include = @"FrenchStrings.fr.resx";
                        item.SetMetadata("Visible", "false");
                    }
                }

                // Remove the item named "RemoveThisItemPlease" from the
                // ItemGroup 
                if (itemToRemove != null)
                {
                    ig.RemoveItem(itemToRemove);
                }

                // 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="http://schemas.microsoft.com/developer/msbuild/2003">
            //       <ItemGroup> 
            //         <Compile Include="Program.cs" />
            //         <Compile Include="Class1.cs" />
            //         <Content Include="SplashScreen.bmp" />
            //       </ItemGroup> 
            //       <ItemGroup> 
            //         <EmbeddedResource Include="FrenchStrings.fr.resx">
            //           <LogicalName>Strings.resources</LogicalName> 
            //           <Culture>fr-fr</Culture> 
            //           <Visible>false</Visible> 
            //         </EmbeddedResource> 
            //         <Content Include="SplashScreen.bmp" />
            //       </ItemGroup> 
            //     </Project> 
            //
            Console.WriteLine(project.Xml);
        }
    }
}

.NET Framework

Supported in: 4.6, 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