HOW TO：管理 Visual Basic 和 C# 專案和 VSProject2 物件
更新：2007 年 11 月
VSProject2 介面可以用來存取 Visual C#、Visual Basic 和 Visual J# 專案特有的方法和屬性，此外，VSProject2 也可以透過 DTE 和 Project 屬性存取一般環境模型的 DTE 和 Project 物件。
大多數的 VSProject2 方法和屬性都可一致適用於 Visual C#、Visual Basic 和 Visual J# 專案，唯一的例外是 Imports 屬性，此屬性適用於 Visual Basic，可用來存取 Imports 物件。如需詳細資訊，請參閱 HOW TO：管理 Visual Basic 專案的 Imports 屬性。Events 屬性用來存取專案特定事件，例如 VSLangProjWebReferencesEvents 和 ReferencesEvents。事件處理工作將涵蓋在其他主題中。如需詳細資訊，請參閱回應事件 (Visual Basic 和 Visual C# 專案)。
在下列步驟中，會說明如何使用一般 Automation 模型，以程式設計方式建立 Visual C# Windows 應用程式，並且利用 VSProject2 的方法和屬性，以程式設計方式控制建立的專案。
.gif "注意事項") 注意事項： |
|---|
根據目前使用的設定與版本，您所看到的對話方塊與功能表命令可能會與 [說明] 中所描述的不同。使用 [一般開發設定] 開發了這些程序。若要變更設定，請從 [工具] 功能表中選擇 [匯入和匯出設定]。如需詳細資訊，請參閱 Visual Studio 設定。 |
若要使用 VSProject2 物件控制 C# 和 J# 專案
使用 Visual C# 建立 Visual Studio 增益集專案。
在 [專案] 功能表上按一下 [加入參考]，再按一下 [.NET] 索引標籤，選取 [VSLangProj]、[VSLangProj2] 和 [VSLangProj80]，然後再按 [確定]。
在電腦上建立兩個資料夾：
<Installation Root>\UserFiles\MyProjects\MyTestProject。
<Installation Root>\UserFiles\MyKeyFiles。
在此範例中，<Installation Root> 為 "C:"。
將下列 using 陳述式加入至 Connect.cs 檔的頂端。
using VSLangProj; using VSLangProj2; using VSLangProj80;將下列方法呼叫加入至 OnConnection 方法。
public void OnConnection(object application, ext_ConnectMode connectMode, object addInInst, ref Array custom) { _applicationObject = (DTE2)application; _addInInstance = (AddIn)addInInst; CSVSProj2Manip(_applicationObject); }緊接在 OnConnection 方法的下面加入 CSVSProj2Manip 方法宣告。
public void CSVSProj2Manip(DTE2 dte) { }將下列宣告加入至方法的最上方。
Solution2 soln = (Solution2)_applicationObject.Solution; String csTemplatePath; String csPrjPath; Project proj; VSProject2 vsproj; String webServiceRef; BuildManager bldMgr;使用 AddFromTemplate 建立 Visual C# 專案。
取得範本的語法為 EnvDTE80.Solution2.GetProjectTemplate("WindowsApplication.zip", "CSharp")，其中 " WindowsApplication.zip " 這個名稱是根據位於 <Installation Root>\Program Files\Microsoft Visual Studio 8\Common7\IDE\ProjectTemplates\CSharp\Windows\1033 資料夾中的 WindowsApplication.zip 檔案而來。對於所有 Visual Studio 專案類型來說，這些檔案都可以在 <Installation Root>\Program Files\Microsoft Visual Studio 8\Common7\IDE\ProjectTemplates\Language 資料夾中找到。"CSharp" 則是指定這個專案為 Visual C# 專案。
如果是 Visual Basic Windows 應用程式專案，語法為 EnvDTE80.Solution2.GetProjectTemplate("WindowsApplication.zip", "VisualBasic")。Visual Basic 專案的 Windows 應用程式 zip 檔案範本可以在 <Installation Root>\ Program Files\Microsoft Visual Studio 8\Common7\IDE\ProjectTemplates\VisualBasic\Windows\1033 資料夾中找到。
如果是 Visual J# Windows 應用程式專案，語法為 EnvDTE80.Solution2.GetProjectTemplate("WindowsApplication.zip", "JSharp")。Visual J# 專案的 Windows 應用程式 zip 檔案範本可以在 <Installation Root>\Program Files\Microsoft Visual Studio 8\Common7\IDE\ProjectTemplates\JSharp\Windows\1033 資料夾中找到。
// Make sure you create the folders that // make up the file path // on your computer. You can replace // this with your own file path. csPrjPath = "C:\\UserFiles\\MyProjects\\MyTestProject"; // Get the project template path for a C# windows // application. csTemplatePath = soln.GetProjectTemplate("WindowsApplication.zip", "CSharp"); // Create a new windows application by using the // template obtained above. soln.AddFromTemplate(csTemplatePath, csPrjPath, "Test2CSProj", false);加入下列程式碼，示範 VSProject2 方法的使用方式。
若要以程式設計方式將 Web 服務加入至專案中，必須以實際 Web 服務的 URL 取代程式碼中的預留位置文字 <web service>。若要找到 Web 服務的 URL，請在 Visual Studio 整合式開發環境 (IDE) 中開啟專案。在 [專案] 功能表上，按一下 [加入 Web 參考]。在 [加入參考] 對話方塊中，按一下 [UDDI 目錄] 連結，然後利用該目錄尋找 Web 服務。
proj = soln.Projects.Item(1); // Cast the project as a VSProject2 object. vsproj = (VSProject2)proj.Object; // Add a reference to System.Security.dll. MessageBox.Show("Adding a reference to System.Security.dll"); // Remove the <version number> in the following path // and replace it with one of the version // number folders that appear // in <installation root>\WINDOWS\Microsoft.NET\Framework // folder vsproj.References.Add ("C:\\WINDOWS\\Microsoft.NET\\Framework\\<version number>\\System.Security.dll"); // Create a Web references folder. MessageBox.Show("Creating a Web references folder."); vsproj.CreateWebReferencesFolder(); // Add a Web reference to the folder. MessageBox.Show("Adding a Web reference."); // Replace the placeholder, <web service>, with a // Web service URL. webServiceRef = "<web service>"; vsproj.AddWebReference(webServiceRef); bldMgr = vsproj.BuildManager; Array monikers = null; // String moniker = null; String msg = null; Object obj = bldMgr.DesignTimeOutputMonikers; if (obj != null) { try { monikers = (System.Array)obj; foreach(String tempmoniker in monikers) { msg += bldMgr.BuildDesignTimeOutput (tempmoniker) + "\n"; } } catch(Exception ex) { MessageBox.Show(ex.Message); } MessageBox.Show("The build design-time output is:" + "\n" + msg); } // Change the MyHTML file name by using GetUniqueFilename. MessageBox.Show("Adding an HTML page named 'MyHTML'..."); String itemTemplatePath = soln.GetProjectItemTemplate("HTMLPage", "CSharp"); proj.ProjectItems.AddFromTemplate (itemTemplatePath, "MyHtml"); MessageBox.Show("Renaming MyHtml' to 'MyTesthtml.htm'..."); vsproj.Project.ProjectItems.Item("MyHtml").Name = vsproj.GetUniqueFilename(proj, "MyTesthtml", "htm"); // Generate a key-pair file. MessageBox.Show("Generating a key-file..."); vsproj.GenerateKeyPairFiles("C:\\UserFiles\\MyKeyFiles \\MyKeyText2.bin", "0");CSVSProj2Manip 方法使用 VSProject2 物件的目的：
使用 References 加入 System.Security.dll 的參考。
使用 CreateWebReferencesFolder 建立 Web 參考資料夾。
使用 AddWebReference 加入 Web 參考。
使用透過 BuildManager 屬性取得的方法，顯示建置 (Build) 設計階段的 Moniker。
使用 GetUniqueFilename 方法重新命名新的專案項目。CSVSProj2Manip 方法會使用 AddFromTemplate 加入專案項目。
使用 GenerateKeyPairFiles 方法產生金鑰組檔案。
範例部分會列出完整的程式碼，包括整個方法的 try-catch 區塊。
若要建置增益集，請按一下 [建置] 功能表上的 [建置方案]。
在 Visual Studio IDE 中，開啟 Visual C#、Visual J# 或 Visual Basic 專案。
按一下 [工具] 功能表上的 [增益集管理員]，然後從 [增益集管理員] 對話方塊中選取增益集。按一下 [確定]，執行您的增益集。
使用強式名稱工具 (Sn.exe) 檢視您在 <Installation Root>\UserFiles\MyKeyFiles 資料夾中產生的金鑰組檔案。
範例
下列是基本 Visual Studio 增益集的範例，在此範例中會建立 Visual C# 專案並且使用 VSProject2 物件的屬性和方法來管理該專案。
using System;
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;
CSVSProj2Manip(_applicationObject);
}
public void CSVSProj2Manip(DTE2 dte)
{
try
{
Solution2 soln = (Solution2)_applicationObject.Solution;
String csTemplatePath;
String csPrjPath;
Project proj;
VSProject2 vsproj;
String webServiceRef;
BuildManager bldMgr;
// Make sure you create the folders that make up the file path
// on your computer.
// You can replace this with your own file path.
csPrjPath = "C:\\UserFiles\\MyProjects\\MyTestProject";
// Get the project template path for a C# windows application.
csTemplatePath = soln.GetProjectTemplate
("WindowsApplication.zip", "CSharp");
// Create a new Windows application by using the template
// obtained above.
soln.AddFromTemplate(csTemplatePath, csPrjPath,
"Test2CSProj", false);
proj = soln.Projects.Item(1);
// Get a reference to the VSProject2 object.
vsproj = (VSProject2)proj.Object;
// Add a reference to System.Security.dll.
MessageBox.Show("Adding a reference to System.Security.dll");
// Remove the <version number> in the following path
// and replace it with one of the version
// number folders that appear
// in <installation root>\WINDOWS\Microsoft.NET\Framework
// folder
vsproj.References.Add
("C:\\WINDOWS\\Microsoft.NET\\Framework\\<version number>\\System.Security.dll");
// Create a Web references folder.
MessageBox.Show("Creating a Web references folder.");
vsproj.CreateWebReferencesFolder();
// Replace the placeholder, <web service>, with a
// Web service URL.
MessageBox.Show("Adding a Web reference.");
// Replace the placeholder, <web service>, with a
// Web service URL.
webServiceRef = "<web service>";
vsproj.AddWebReference(webServiceRef);
bldMgr = vsproj.BuildManager;
Array monikers = null;
// String moniker = null;
String msg = null;
Object obj = bldMgr.DesignTimeOutputMonikers;
if (obj != null)
{
try
{
monikers = (System.Array)obj;
foreach(String tempmoniker in monikers)
{
msg += bldMgr.BuildDesignTimeOutput(tempmoniker)
+ "\n";
}
}
catch(Exception ex)
{
MessageBox.Show(ex.Message);
}
MessageBox.Show("The build design-time output is:" + "\n"
+ msg);
}
// Change the MyHTML file name by using GetUniqueFilename.
MessageBox.Show("Adding an HTML page named 'MyHTML'...");
String itemTemplatePath =
soln.GetProjectItemTemplate("HTMLPage", "CSharp");
proj.ProjectItems.AddFromTemplate(itemTemplatePath, "MyHtml");
MessageBox.Show("Renaming MyHtml' to 'MyTesthtml.htm'...");
vsproj.Project.ProjectItems.Item("MyHtml").Name =
vsproj.GetUniqueFilename(proj, "MyTesthtml", "htm");
// Generate a key-pair file.
MessageBox.Show("Generating a key-file...");
vsproj.GenerateKeyPairFiles
("C:\\UserFiles\\MyKeyFiles\\MyKeyText2.bin", "0");
}
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)
CSVSProj2Manip(_applicationObject)
End Sub
Sub CSVSProj2Manip(ByVal dte As DTE2)
Try
Dim soln As Solution2 = CType(_applicationObject.Solution, _
Solution2)
Dim csTemplatePath As String
Dim csPrjPath As String
Dim proj As Project
Dim vsproj As VSProject2
Dim webServiceRef As String
Dim bldMgr As BuildManager
' Create this or your own file path on your computer.
' The file path must exist before you run this add-in.
csPrjPath = "C:\UserFiles\MyProjects\MyTestProject"
' Get the project template path for a C# windows application.
csTemplatePath = soln.GetProjectTemplate _
("WindowsApplication.zip","CSharp")
' Create a new Windows Application
' using the template obtained above.
soln.AddFromTemplate(csTemplatePath, csPrjPath _
, "Test2CSProj", False)
proj = soln.Projects.Item(1)
' Cast the project to a VSProject2.
vsproj = CType(proj.Object, VSProject2)
' Add a reference to System.Security.dll.
MsgBox("Adding a reference to System.Security.dll")
' Remove the <version number> in the following path
' and replace it with one of the version
' number folders that appear
' in <installation root>\WINDOWS\Microsoft.NET\Framework
' folder
vsproj.References.Add _
("C:\WINDOWS\Microsoft.NET\Framework\<version number>\System.Security.dll")
' Create a Web references folder.
MsgBox("Creating a Web references folder.")
vsproj.CreateWebReferencesFolder()
' Replace the placeholder, <web service>, with a
' web service URL.
webServiceRef = "<web service>"
MsgBox("Adding a Web reference.")
vsproj.AddWebReference(webServiceRef)
bldMgr = vsproj.BuildManager
Dim monikers As String() = Nothing
Dim moniker As String = Nothing
Dim msg As String = ""
Dim obj As Object = bldMgr.DesignTimeOutputMonikers
If Not obj Is Nothing Then
Try
monikers = CType(obj, String())
For Each moniker In monikers
msg &= bldMgr.BuildDesignTimeOutput(moniker) + vbCr
Next
Catch ex As System.Exception
MsgBox(ex.ToString)
End Try
MsgBox("The build design-time output is:" + vbCr + msg)
End If
' Use the UniqueFilename to rename a new project item.
MsgBox("Adding an HTML page called 'MyHTML'...")
Dim itemTemplatePath As String = _
soln.GetProjectItemTemplate("HTMLPage", "CSharp")
proj.ProjectItems.AddFromTemplate(itemTemplatePath, "MyHtml")
MsgBox("Renaming MyHtml' to 'MyTesthtml.htm'...")
vsproj.Project.ProjectItems.Item("MyHtml").Name = _
vsproj.GetUniqueFilename(proj, "MyTesthtml", "htm")
' Generate a key-pair file.
vsproj.GenerateKeyPairFiles _
("C:\UserFiles\MyKeyFiles\MyKeyText2.bin", "0")
Catch ex As System.Exception
MsgBox(ex.ToString)
End Try
End Sub
編譯程式碼
若要編譯這個程式碼，請建立新的 Visual Studio 增益集專案，並以範例中的程式碼取代 OnConnection 方法的程式碼。如需如何執行增益集的詳細資訊，請參閱 HOW TO：以增益集管理員控制增益集。