為 Web 組件或應用程式頁面建立可重複使用的控制項
Visual Studio 可讓您為在 SharePoint 中執行的應用程式頁面和 Web 組件,建立可供其利用之自訂、可重複使用的控制項。 這些控制項被稱為使用者控制項 (User Control)。 如需使用者控制項的詳細資訊,請參閱ASP.NET 使用者控制項。
建立使用者控制項
若要建立使用者控制項,請將 [使用者控制項] 加入至 [空的 SharePoint 專案]。 如需詳細資訊,請參閱 HOW TO:為 SharePoint 應用程式頁面或 Web 組件建立使用者控制項。
加入 [使用者控制項] 項目時,Visual Studio 會在您的專案中建立一個資料夾,然後在其中加入數個檔案。 下表將針對各個檔案進行說明。
檔案 |
說明 |
---|---|
使用者控制項檔案 |
可定義使用者控制項, 並藉由在這個檔案中加入控制項和標記的方式來設計使用者控制項。 |
程式碼檔 |
包含使用者控制項的程式碼。 您可以在這個檔案中加入事件處理程式碼。 |
設計工具程式碼檔案 |
包含設計工具產生的程式碼,您不能直接編輯這些程式碼。 |
設計使用者控制項
您可以使用 Visual Studio 中的 Visual Web Developer 設計工具,設計使用者控制項。 按兩下專案中的使用者控制項檔案,這個設計工具就會出現。 如需使用這個設計工具的詳細資訊,請參閱Visual Web Developer 內容對應。
運用使用者控制項
在您將使用者控制項納入應用程式頁面或 Web 組件之前,這些控制項並不會出現在 SharePoint 中。
若要在應用程式頁面中包含使用者控制項,請將 @ Register 指示詞加入至應用程式頁面,然後在頁面上的一個或多個內容預留位置內宣告此使用者控制項。 如需如何在標準 ASP.NET 網頁上完成此工作的範例,請參閱 HOW TO:在 ASP.NET Web 網頁中包含使用者控制項。
若要在 Web 組件中納入使用者控制項,請將使用者控制項加入至 Web 組件程式碼檔案中的 Web 組件 Controls 集合。 下列範例會將使用者控制項加入至 Web 組件的 Controls 集合。
<ToolboxItemAttribute(false)> _
Public Class VisualWebPart1
Inherits WebPart
Private Const _ascxPath As String = "~/_CONTROLTEMPLATES/VB/VisualWebPart1/VisualWebPart1UserControl.ascx"
Public Sub New()
End Sub
Protected Overrides Sub CreateChildControls()
Dim control As Control = Page.LoadControl(_ascxPath)
Controls.Add(control)
MyBase.CreateChildControls()
End Sub
Protected Overrides Sub RenderContents(ByVal writer As HtmlTextWriter)
MyBase.RenderContents(writer)
End Sub
End Class
[ToolboxItemAttribute(false)]
public class VisualWebPart1 : WebPart
{
private const string _ascxPath = @"~/_CONTROLTEMPLATES/CS/VisualWebPart1/VisualWebPart1UserControl.ascx";
public VisualWebPart1()
{
}
protected override void CreateChildControls()
{
Control control = this.Page.LoadControl(_ascxPath);
Controls.Add(control);
base.CreateChildControls();
}
protected override void RenderContents(HtmlTextWriter writer)
{
base.RenderContents(writer);
}
}
偵錯使用者控制項
若要偵錯使用者控制項,請確認使用者控制項已納入 SharePoint 專案中的應用程式頁面或 Web 組件中。 接著,您就能偵錯使用者控制項中的程式碼,其方式就像偵錯任何 Visual Studio 專案中的程式碼一樣。
當您啟動 Visual Studio 偵錯工具時,Visual Studio 就會開啟 SharePoint 網站。
在 SharePoint 中,開啟包含使用者控制項的應用程式頁面。 如果使用者控制項包含在 Web 組件中,請將該 Web 組件加入至 SharePoint 中的 [網頁組件頁面]。
如需偵錯 SharePoint 專案的詳細資訊,請參閱SharePoint 方案疑難排解。
相關主題
標題 |
說明 |
---|---|
示範如何為在 SharePoint 中執行的應用程式頁面和 Web 組件,建立可供其利用之自訂、可重複使用的控制項。 |
|
說明如何使用開啟專案中的網頁時出現的設計工具。 |