BuildPropertyGroup.GetEnumerator Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Gets an enumerator that iterates through the BuildPropertyGroup.
public:
virtual System::Collections::IEnumerator ^ GetEnumerator();
public System.Collections.IEnumerator GetEnumerator ();
abstract member GetEnumerator : unit -> System.Collections.IEnumerator
override this.GetEnumerator : unit -> System.Collections.IEnumerator
Public Function GetEnumerator () As IEnumerator
Returns
An IEnumerator for the entire BuildPropertyGroup.
Implements
Examples
The following example creates a Project object and uses the BuildItem, BuildPropertyBuildItemGroup, and BuildPropertyGroup classes to list all the items and properties in the project.
using System;
using System.Collections.Generic;
using System.Text;
using Microsoft.Build.BuildEngine;
namespace ListItemAndPropertiesCS
{
class Program
{
static void Main(string[] args)
{
// SET THIS TO POINT TO THE RIGHT LOCATION
Engine.GlobalEngine.BinPath = @"C:\Windows\Microsoft.NET\Framework\v2.0.xxxxx";
// Create a new empty project
Project project = new Project();
// Load a project
project.Load(@"c:\temp\validate.proj");
Console.WriteLine("Project Properties");
Console.WriteLine("----------------------------------");
// Iterate through the various property groups and subsequently
// through the various properties
foreach (BuildPropertyGroup propertyGroup in project.PropertyGroups)
{
foreach (BuildProperty prop in propertyGroup)
{
Console.WriteLine("{0}:{1}", prop.Name, prop.Value);
}
}
Console.WriteLine();
Console.WriteLine("Project Items");
Console.WriteLine("----------------------------------");
// Iterate through the various itemgroups
// and subsequently through the items
foreach (BuildItemGroup itemGroup in project.ItemGroups)
{
foreach (BuildItem item in itemGroup)
{
Console.WriteLine("{0}:{1}", item.Name, item.Include);
}
}
}
}
}
Module Module1
'You need to add references to Microsoft.Build.BuildEngine and
'Microsoft.Build.Framework
Sub Main()
'Set this to point to the location where the 2.0 clr/tools are installed
Engine.GlobalEngine.BinPath = "C:\windows\microsoft.net\framework\v2.0.xxxxx"
'Create a new empty project
Dim project As New Project()
'Load a project
project.Load("c:\temp\validate.proj")
'Output a header
Console.WriteLine("Project Properties")
Console.WriteLine("----------------------------------")
'Iterate through the various property groups and subsequently
'through the various properties
For Each propertyGroup As BuildPropertyGroup In project.PropertyGroups
For Each prop As BuildProperty In propertyGroup
Console.WriteLine("{0}:{1}", prop.Name, prop.Value)
Next
Next
Console.WriteLine()
Console.WriteLine("Project Items")
Console.WriteLine("----------------------------------")
'Iterate through the various itemgroups
'and subsequently through the items
For Each itemGroup As BuildItemGroup In project.ItemGroups
For Each item As BuildItem In itemGroup
Console.WriteLine("{0}:{1}", item.Name, item.Include)
Next
Next
End Sub
End Module
Remarks
This method allows the caller to use the foreach
statement of the C# language (for each
in Visual Basic) to iterate through the individual BuildProperty objects in the BuildPropertyGroup.