BuildPropertyGroup

.NET Framework クラス ライブラリ リファレンス

BuildPropertyGroup クラス

メモ : このクラスは、.NET Framework version 2.0 で新しく追加されたものです。

BuildProperty オブジェクトのコレクションを表します。

名前空間: Microsoft.Build.BuildEngine
アセンブリ: Microsoft.Build.Engine (microsoft.build.engine.dll 内)
構文

Visual Basic (宣言)

Public Class BuildPropertyGroup
    Implements IEnumerable

Visual Basic (使用法)

Dim instance As BuildPropertyGroup

C#

public class BuildPropertyGroup : IEnumerable

C++

public ref class BuildPropertyGroup : IEnumerable

J#

public class BuildPropertyGroup implements
 IEnumerable

JScript

public class BuildPropertyGroup implements
 IEnumerable

解説

BuildPropertyGroup オブジェクトは、プロジェクト内の PropertyGroup 要素を表したり、グローバル プロパティや環境変数プロパティなどのプロパティの仮想的なコレクションを表したりできます。

使用例

Project オブジェクトを作成し、LoadXml メソッドを使用して内容をプロジェクトに追加する例を次に示します。プロジェクト内の項目を追加、削除、および変更するために、BuildProperty クラス、BuildPropertyGroup クラス、および BuildPropertyGroupCollection クラスが使用されています。

Visual Basic

Module Module1

    ''' <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>
    ''' <remarks></remarks>
    Sub Main()

        ' Create a new Engine object.
        Dim engine As New
 Engine(Environment.CurrentDirectory)

        ' Create a new Project object.
        Dim project As 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.
        For Each pg As BuildPropertyGroup
 In project.PropertyGroups

            Dim propertyToRemove As BuildProperty
            propertyToRemove = Nothing

            ' Iterate through each Property in the PropertyGroup.
            For Each buildProperty As
 BuildProperty 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 buildProperty.Name = "RemoveThisPropertyPlease"
 Then
                    propertyToRemove = buildProperty
                End If

                ' If the property's name is "OutputPath",
 change its value
                ' from "bin\debug\" to "bin\release\".
                If buildProperty.Name = "OutputPath"
 Then
                    buildProperty.Value = "bin\release\"
                End If

            Next

            ' Remove the property named "RemoveThisPropertyPlease"
 from the
            ' PropertyGroup
            If Not propertyToRemove Is
 Nothing Then
                pg.RemoveProperty(propertyToRemove)
            End If

            ' For each PropertyGroup that we found, add to the end of
 it
            ' a new property called "MyNewProperty".
            pg.AddNewProperty("MyNewProperty", "MyNewValue")

        Next

        '  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)

    End Sub

End Module

C#

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);
        }
    }
}

継承階層

System.Object
  Microsoft.Build.BuildEngine.BuildPropertyGroup

スレッド セーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
BuildPropertyGroup メンバ
Microsoft.Build.BuildEngine 名前空間

BuildPropertyGroup コンストラクタ

メモ : このコンストラクタは、.NET Framework version 2.0 で新しく追加されたものです。

BuildPropertyGroup クラスの新しいインスタンスを初期化します。

名前空間: Microsoft.Build.BuildEngine
アセンブリ: Microsoft.Build.Engine (microsoft.build.engine.dll 内)
構文

Visual Basic (宣言)

Public Sub New

Visual Basic (使用法)

Dim instance As New BuildPropertyGroup

C#

public BuildPropertyGroup ()

C++

public:
BuildPropertyGroup ()

J#

public BuildPropertyGroup ()

JScript

public function BuildPropertyGroup ()

.NET Framework のセキュリティ

• 直前の呼び出し元に対する完全な信頼。このメンバは、部分的に信頼されているコードから使用することはできません。詳細については、「」を参照してください。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
BuildPropertyGroup クラス
BuildPropertyGroup メンバ
Microsoft.Build.BuildEngine 名前空間

BuildPropertyGroup プロパティ

パブリック プロパティ

	名前	説明
	Condition	プロパティ グループの Condition 属性の値を取得または設定します。
	Count	BuildPropertyGroup 内の BuildProperty オブジェクトの数を示す値を取得します。
	IsImported	プロパティ グループがプロジェクトにインポートされたかどうかを示す値を取得または設定します。
	Item	この BuildPropertyGroup 内の BuildProperty オブジェクトを取得または設定します。

参照

関連項目

BuildPropertyGroup クラス
Microsoft.Build.BuildEngine 名前空間

BuildPropertyGroup メソッド

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	AddNewProperty	オーバーロードされます。 新しい BuildProperty を BuildPropertyGroup に追加します。
	Clear	Condition プロパティ値およびすべての BuildProperty オブジェクトを BuildPropertyGroup から削除します。
	Clone	BuildPropertyGroup の詳細コピーまたは簡易コピーを作成します。
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 ( Object から継承されます。)
	GetEnumerator	BuildPropertyGroup を反復処理する列挙子を取得します。
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 ( Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	RemoveProperty	オーバーロードされます。 指定した BuildProperty を BuildPropertyGroup から削除します。
	SetProperty	オーバーロードされます。 指定した Name を持つ BuildProperty の Value を設定します。
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 ( Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 ( Object から継承されます。)

参照

関連項目

BuildPropertyGroup クラス
Microsoft.Build.BuildEngine 名前空間

BuildPropertyGroup メンバ

BuildProperty オブジェクトのコレクションを表します。

BuildPropertyGroup データ型で公開されるメンバを以下の表に示します。

パブリック コンストラクタ

	名前	説明
	BuildPropertyGroup	BuildPropertyGroup クラスの新しいインスタンスを初期化します。

パブリック プロパティ

	名前	説明
	Condition	プロパティ グループの Condition 属性の値を取得または設定します。
	Count	BuildPropertyGroup 内の BuildProperty オブジェクトの数を示す値を取得します。
	IsImported	プロパティ グループがプロジェクトにインポートされたかどうかを示す値を取得または設定します。
	Item	この BuildPropertyGroup 内の BuildProperty オブジェクトを取得または設定します。

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	AddNewProperty	オーバーロードされます。 新しい BuildProperty を BuildPropertyGroup に追加します。
	Clear	Condition プロパティ値およびすべての BuildProperty オブジェクトを BuildPropertyGroup から削除します。
	Clone	BuildPropertyGroup の詳細コピーまたは簡易コピーを作成します。
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 (Object から継承されます。)
	GetEnumerator	BuildPropertyGroup を反復処理する列挙子を取得します。
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 (Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	RemoveProperty	オーバーロードされます。 指定した BuildProperty を BuildPropertyGroup から削除します。
	SetProperty	オーバーロードされます。 指定した Name を持つ BuildProperty の Value を設定します。
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 (Object から継承されます。)

参照

関連項目

BuildPropertyGroup クラス
Microsoft.Build.BuildEngine 名前空間