方法 : 特定の種類のプロジェクトの構成プロパティにアクセスする

[アーティクル]
09/17/2008

更新 : 2007 年 11 月

Visual Studio の一般的なオートメーションモデルには、Properties コレクションが用意されています。このコレクションを使用して、Visual Studio のすべてのプロジェクトの種類の Properties コレクションにアクセスできます。特に、プロジェクトプロパティを使用すると、セキュリティ設定、ビルド構成、およびデバッグ構成を制御できるようになります。

プロジェクトプロパティを手動で設定および調査するには、Visual Studio 統合開発環境 (IDE: Integrated Development Environment) でプロジェクトを開きます。[プロジェクト] メニューの [プロパティ] をクリックします。[プロパティ] ウィンドウには複数のタブがあり、各ペインには、プロジェクトの動作を定義および制御する際に使用するプロパティの一覧が表示されます。オートメーションモデルを使用すると、これらの設定をプログラムで制御できます。具体的には、CSharpProjectConfigurationProperties4、VBProjectConfigurationProperties4、JSharpProjectConfigurationProperties3、および ProjectConfigurationProperties3 に示されているプロパティを使用すると、現在アクティブな構成の [プロパティ] ページの [ビルド] (Visual Basic プロジェクトの場合は [コンパイル]) ウィンドウペインおよび [デバッグ] プロパティウィンドウペインにあるプロジェクトのプロパティを制御できます。

また、ConfigurationManager オブジェクトにアクセスして、現在アクティブになっていない別の構成を選択することもできます。詳細については、「方法 : ソリューションとプロジェクトのビルド構成を作成する」を参照してください。

Visual C# プロジェクトおよび Visual J# プロジェクトの構成プロパティは、それぞれ CSharpProjectConfigurationProperties4 および JSharpProjectConfigurationProperties3 で定義されています。CodePage、DisableLangXtns、JCPA、および SecureScoping の各プロパティは、Visual J# プロジェクトのみに固有のプロパティです。ErrorReport プロパティおよび LanguageVersion プロパティは、Visual C# プロジェクトのみに固有のプロパティです。CSharpProjectConfigurationProperties3 および JSharpProjectConfigurationProperties3 内の残りのプロパティは、ProjectConfigurationProperties3 内のプロパティと同じです。

これらの構成プロパティは、Property オブジェクトを CSharpProjectConfigurationProperties3、JSharpProjectConfigurationProperties3、または ProjectConfigurationProperties3 の各オブジェクトに直接キャストしてもアクセスできません。その代わり、次に示すように、構成項目の名前を文字列として渡すことにより、これらのプロパティにアクセスできます。

    EnvDTE.Project proj;
    EnvDTE.Configuration config;
    EnvDTE.Properties configProps;
    EnvDTE.Property prop;
    proj = DTE.Solution.Projects.Item(1);
    config = proj.ConfigurationManager.ActiveConfiguration;
    configProps = config.Properties;
    prop = configProps.Item("EnableSQLServerDebugging")

このコードは、proj 変数で Visual C#、Visual J#、または Visual Basic のうちどのプロジェクトが定義されているかに応じて、CSharpProjectConfigurationProperties3.EnableSQLServerDebugging、JSharpProjectConfigurationProperties3.EnableSQLServerDebugging、または ProjectConfigurationProperties3.EnableSQLServerDebugging のいずれかのプロパティにアクセスします。

実際には、CSharpProjectConfigurationProperties3、JSharpProjectConfigurationProperties3、または ProjectConfigurationProperties3 で定義された構成プロパティは、特定のプロジェクトに使用できる構成プロパティの参照一覧です。特定のプロジェクトとは、Properties コレクションを使用してプロジェクトの構成プロパティ項目としてアクセスできるプロジェクトです。

次の手順では、Visual Studio アドインで現在アクティブな構成の構成プロパティにプログラムでアクセスする方法を説明します。

メモ :
使用している設定またはエディションによっては、表示されるダイアログボックスやメニューコマンドがヘルプに記載されている内容と異なる場合があります。ここに記載されている手順は、全般的な開発設定が適用されているものとして記述されています。設定を変更するには、[ツール] メニューの [設定のインポートとエクスポート] をクリックします。詳細については、「Visual Studio の設定」を参照してください。

使用している設定またはエディションによっては、表示されるダイアログボックスやメニューコマンドがヘルプに記載されている内容と異なる場合があります。ここに記載されている手順は、全般的な開発設定が適用されているものとして記述されています。設定を変更するには、[ツール] メニューの [設定のインポートとエクスポート] をクリックします。詳細については、「Visual Studio の設定」を参照してください。

特定の種類のプロジェクトの構成プロパティにアクセスするには

Visual C# を使用して、Visual Studio アドインプロジェクトを作成します。
[プロジェクト] メニューの [参照の追加] をクリックし、[.NET] タブを選択します。[System.Windows.Forms]、[VSLangProj]、[VSLangProj2]、および [VSLangProj80] を選択し、[OK] をクリックします。

次の using ステートメントを Connect.cs ファイルの先頭に追加します。

using VSLangProj;
using VSLangProj2;
using VSLangProj80;
using VSLangProj90;
using System.Windows.Forms;

次の関数呼び出しを OnConnection 関数に追加します。

_applicationObject = (DTE2)application;
_addInInstance = (AddIn)addInInst;
VSProjectConfigProperties(_applicationObject);

VSProjectConfigProperties メソッドを OnConnection メソッドの直後に追加します。

public void VSProjectConfigProperties(DTE2 dte)
{
    try
    {
        // Open a Visual C#, Visual J#, or Visual Basic project
        // before running this add-in.
        Project project;
        Configuration config;
        Properties configProps;
        Property prop;
        project = _applicationObject.Solution.Projects.Item(1);
        config = project.ConfigurationManager.ActiveConfiguration;
        configProps = config.Properties;
        prop = configProps.Item("PlatformTarget");
        MessageBox.Show("The platform target for this project is: "
 + prop.Value.ToString());
        prop = configProps.Item("WarningLevel");
        MessageBox.Show
("The warning level for this project is set to: " 
+ prop.Value.ToString());
        MessageBox.Show("Changing the warning level to 3...");
        prop.Value = "3";
        MessageBox.Show
("The warning level for this project is now set to: " 
+ prop.Value.ToString());
        if (project.Kind == PrjKind.prjKindCSharpProject)
        {
            MessageBox.Show("The project is a Visual C# Project");
            prop = configProps.Item("LanguageVersion");
            MessageBox.Show("The language version value is : " 
+ prop.Value.ToString());
            MessageBox.Show("Setting the language version to 
ISO-1");
            prop.Value = "ISO-1";
            MessageBox.Show("The language version value is now: " 
+ prop.Value.ToString());
        }
        if (project.Kind == PrjKind2.prjKindVJSharpProject)
        {
            MessageBox.Show("The project is a Visual J# Project");
            prop = configProps.Item("CodePage");
            MessageBox.Show("The code page value is : " 
+ prop.Value.ToString());
            MessageBox.Show
("Setting the code page value to my code page");
            prop.Value = "my code page";
            MessageBox.Show("The code page value is now: " 
+ prop.Value.ToString());
        }
    }
    catch(Exception ex)
    {
        MessageBox.Show(ex.Message);
    }
}

VSProjectConfigProperties メソッドは、PlatformTarget プロパティ値を取得して表示します。このメソッドは、WarningLevel プロパティの設定および取得の両方を行います。プロジェクトが Visual C# プロジェクトの場合、VSProjectConfigProperties メソッドは、LanguageVersion プロパティの設定および取得を行います。プロジェクトが Visual J# プロジェクトの場合、このメソッドは、CodePage プロパティの設定および取得を行います。

[ビルド] メニューの [ソリューションのビルド] をクリックし、アドインをビルドします。
Visual Studio IDE で、Visual C#、Visual J#、または Visual Basic のプロジェクトを開きます。
[ツール] メニューの [アドインマネージャ] をクリックし、[アドインマネージャ] ダイアログボックスからアドインを選択します。[OK] をクリックしてアドインを実行します。
[プロジェクト] メニューの [プロパティ] をクリックし、[プロパティ] ウィンドウの [ビルド] タブを選択して、警告レベルが変更されたことを確認します。

[警告レベル] フィールドには、プログラムで加えた変更が反映されます。
Visual C# プロジェクトの言語バージョンの設定を確認するには、[プロパティ] ウィンドウの [ビルド] ペインで、[詳細設定] をクリックします。

[ビルドの詳細設定] ダイアログボックスの [言語バージョン] フィールドには、アドインによる変更が反映されます。
Visual J# プロジェクトのコードページ設定への変更を確認するには、[プロパティ] ウィンドウの [ビルド] ペインで、[詳細設定] をクリックします。

[ビルドの詳細設定] ダイアログボックスの [コードページ] フィールドには、このプロパティに対する変更が反映されます。

使用例

基本的な Visual Studio アドインの例を次に示します。この例では、Visual Studio のオートメーションを使用して、特定の種類のプロジェクトのプロパティにアクセスする方法について説明します。

using System;
using Extensibility;
using EnvDTE;
using EnvDTE80;
using System.Windows.Forms;
using VSLangProj;
using VSLangProj2;
using VSLangProj80;
public void OnConnection(object application, 
ext_ConnectMode connectMode, object addInInst, ref Array custom)
{
    _applicationObject = (DTE2)application;
    _addInInstance = (AddIn)addInInst;
    VSProjectConfigProperties(_applicationObject);
}
public void VSProjectConfigProperties(DTE2 dte)
{
    try
    {
        // Open a Visual C#, Visual J#, or Visual Basic project
        // before running this add-in.
        Project project;
        Configuration config;
        Properties configProps;
        Property prop;
        project = _applicationObject.Solution.Projects.Item(1);
        config = project.ConfigurationManager.ActiveConfiguration;
        configProps = config.Properties;
        prop = configProps.Item("PlatformTarget");
        MessageBox.Show("The platform target for this project is: 
" + prop.Value.ToString());
        prop = configProps.Item("WarningLevel");
        MessageBox.Show
("The warning level for this project is set to: " 
+ prop.Value.ToString());
        MessageBox.Show("Changing the warning level to 3...");
        prop.Value = "3";
        MessageBox.Show
("The warning level for this project is now set to: " 
+ prop.Value.ToString());
        if (project.Kind == PrjKind.prjKindCSharpProject)
        {
            MessageBox.Show("The project is a Visual C# Project");
            prop = configProps.Item("LanguageVersion");
            MessageBox.Show("The language version value is : " 
+ prop.Value.ToString());
            MessageBox.Show("Setting the language version to ISO-1");
            prop.Value = "ISO-1";
            MessageBox.Show("The language version value is now: " 
+ prop.Value.ToString());
        }
        if (project.Kind == PrjKind2.prjKindVJSharpProject)
        {
            MessageBox.Show("The project is a Visual J# Project");
            prop = configProps.Item("CodePage");
            MessageBox.Show("The code page value is : " 
+ prop.Value.ToString());
            MessageBox.Show
("Setting the code page value to my code page");
            prop.Value = "my code page";
            MessageBox.Show("The code page value is now: " 
+ prop.Value.ToString());
        }
    }
    catch(Exception ex)
    {
        MessageBox.Show(ex.Message);
    }
}

Imports System
Imports Microsoft.VisualStudio.CommandBars
Imports Extensibility
Imports EnvDTE
Imports EnvDTE80
Imports VSLangProj
Imports VSLangProj2
Imports VSLangProj80
Public Sub OnConnection(ByVal application As Object, _
 ByVal connectMode As ext_ConnectMode, ByVal addInInst As Object, _
 ByRef custom As Array) Implements IDTExtensibility2.OnConnection
    _applicationObject = CType(application, DTE2)
    _addInInstance = CType(addInInst, AddIn)
    VSProjectConfigProperties(_applicationObject)
End Sub
Sub VSProjectConfigProperties(ByVal dte As DTE2)
    ' Open a Visual C#, Visual J#, or Visual Basic project
    ' before running this add-in.
    Try
        Dim project As Project
        Dim config As Configuration
        Dim configProps As Properties
        Dim prop As [Property]
        project = _applicationObject.Solution.Projects.Item(1)
        config = project.ConfigurationManager.ActiveConfiguration
        configProps = config.Properties
        prop = configProps.Item("PlatformTarget")
        MsgBox("The platform target for this project is: "  _
        & prop.Value.ToString())
        prop = configProps.Item("WarningLevel")
        MsgBox("The warning level for this project is set to: "  _
        & prop.Value.ToString())
        MsgBox("Changing the warning level to 3...")
        prop.Value = "3"
        MsgBox("The warning level for this project is now set to: " _
        & prop.Value.ToString())
        If project.Kind = PrjKind.prjKindCSharpProject Then
            MsgBox("The project is a Visual C# Project")
            prop = configProps.Item("LanguageVersion")
            MsgBox("The language version value is : "  _
            & prop.Value.ToString())
            MsgBox("Setting the language version to ISO-1")
            prop.Value = "ISO-1"
            MsgBox("The language version value is now: "  _
            & prop.Value.ToString())
        End If
        If project.Kind = PrjKind2.prjKindVJSharpProject Then
            MsgBox("The project is a Visual J# Project")
            prop = configProps.Item("CodePage")
            MsgBox("The code page value is : "  _
            & prop.Value.ToString())
            MsgBox("Setting the code page value to my code page")
            prop.Value = "my code page"
            MsgBox("The code page value is now: "  _
            & prop.Value.ToString())
        End If
    Catch ex As System.Exception
        MsgBox(ex.ToString)
    End Try
End Sub

コードのコンパイル方法

このコードをコンパイルするには、新しい Visual Studio アドインプロジェクトを作成し、OnConnection メソッドのコードをこの例のコードで置き換えます。アドインの実行方法については、「方法 : アドインマネージャを使用してアドインを制御する」を参照してください。

参照

概念

プロジェクトプロパティ

その他の技術情報

プロジェクトの種類に固有のプロジェクト、プロジェクト項目、および構成プロパティへのアクセス

次の方法で共有

方法 : 特定の種類のプロジェクトの構成プロパティにアクセスする

特定の種類のプロジェクトの構成プロパティにアクセスするには

使用例

コードのコンパイル方法

参照

概念

その他の技術情報

その他のリソース