CustomTaskPaneCollection 介面
表示 Microsoft Office 應用程式中的自訂工作窗格集合。
命名空間： Microsoft.Office.Tools
組件： Microsoft.Office.Tools.Common (在 Microsoft.Office.Tools.Common.dll 中)
語法
'宣告
<GuidAttribute("c3a84bf1-e95b-4d23-952d-59e35673958e")> _
Public Interface CustomTaskPaneCollection _
Inherits IEnumerable(Of CustomTaskPane), IEnumerable, IDisposable
[GuidAttribute("c3a84bf1-e95b-4d23-952d-59e35673958e")]
public interface CustomTaskPaneCollection : IEnumerable<CustomTaskPane>,
IEnumerable, IDisposable
CustomTaskPaneCollection 型別會公開下列成員。
屬性
| 名稱 | 說明 | |
|---|---|---|
.gif "公用屬性") |
Count | 取得目前 CustomTaskPaneCollection 中的 CustomTaskPane 物件數目。 |
|
Item | 取得在指定之索引中的 CustomTaskPane。 |
回頁首
方法
| 名稱 | 說明 | |
|---|---|---|
.gif "公用方法") |
Add(UserControl, String) | 建立新的 CustomTaskPane，並將它加入至目前的 CustomTaskPaneCollection。自訂工作窗格是以指定的 UserControl 做為基礎，並具有指定的標題。 |
|
Add(UserControl, String, Object) | 建立新的 CustomTaskPane，並將它加入至目前的 CustomTaskPaneCollection。自訂工作窗格是以指定的 UserControl 做為基礎，具有指定的標題，並與指定的應用程式視窗相關聯。 |
|
BeginInit | 基礎架構。 |
|
Dispose | 執行與釋放 (Free)、釋放 (Release) 或重設 Unmanaged 資源相關聯之應用程式定義的工作。 (繼承自 IDisposable)。 |
|
EndInit | 基礎架構。 |
|
GetEnumerator() | 傳回可逐一查看集合的列舉程式。 (繼承自 IEnumerable<CustomTaskPane>)。 |
|
GetEnumerator() | 傳回會逐一查看集合的列舉程式。 (繼承自 IEnumerable)。 |
|
Remove | 將指定的 CustomTaskPane 從 CustomTaskPaneCollection 中移除。 |
|
RemoveAt | 移除 CustomTaskPaneCollection 之指定索引中的 CustomTaskPane。 |
回頁首
備註
您可使用應用程式層級增益集中的 CustomTaskPaneCollection 物件，將自訂工作窗格加入至應用程式、移除自訂工作窗格，或存取現有的自訂工作窗格。 若要存取 CustomTaskPaneCollection 物件，請使用增益集專案中 ThisAddIn 類別的 CustomTaskPanes 欄位。 如需詳細資訊，請參閱應用程式層級增益集程式設計。
工作窗格係指通常停駐在應用程式視窗一側的使用者介面面板。 如需如何建立自訂工作窗格的詳細資訊，請參閱自訂工作窗格概觀。
.gif "注意事項") 注意事項 |
|---|
此介面是由 Visual Studio Tools for Office Runtime 所實作， 並不能實作於您的程式碼中。 如需詳細資訊，請參閱 Visual Studio Tools for Office Runtime 概觀。 |
使用方式
本文件說明此型別用於以 .NET Framework 4 為目標之 Office 專案的版本。在以 .NET Framework 3.5 為目標的專案中，此型別可能會有不同的成員，而為此型別提供的程式碼範例可能無法運作。 如需此型別在以 .NET Framework 3.5 為目標之專案中的相關文件，請參閱下列 Visual Studio 2008 文件中的參考章節：https://go.microsoft.com/fwlink/?LinkId=160658 (英文)。
範例
下列程式碼範例示範如何使用 Add(UserControl, String) 方法建立自訂工作窗格。 此範例也使用 CustomTaskPane 物件的屬性來修改自訂工作窗格的預設外觀。 這個程式碼範例是 CustomTaskPane 的完整範例的一部分。
Private myUserControl1 As MyUserControl
Private WithEvents myCustomTaskPane As Microsoft.Office.Tools.CustomTaskPane
Private Sub ThisAddIn_Startup(ByVal sender As Object, ByVal e As System.EventArgs) _
Handles Me.Startup
myUserControl1 = New MyUserControl()
myCustomTaskPane = Me.CustomTaskPanes.Add(myUserControl1, "New Task Pane")
With myCustomTaskPane
.DockPosition = Office.MsoCTPDockPosition.msoCTPDockPositionFloating
.Height = 500
.Width = 500
.DockPosition = Office.MsoCTPDockPosition.msoCTPDockPositionRight
.Width = 300
.Visible = True
End With
End Sub
private MyUserControl myUserControl1;
private Microsoft.Office.Tools.CustomTaskPane myCustomTaskPane;
private void ThisAddIn_Startup(object sender, System.EventArgs e)
{
myUserControl1 = new MyUserControl();
myCustomTaskPane = this.CustomTaskPanes.Add(myUserControl1,
"New Task Pane");
myCustomTaskPane.DockPosition =
Office.MsoCTPDockPosition.msoCTPDockPositionFloating;
myCustomTaskPane.Height = 500;
myCustomTaskPane.Width = 500;
myCustomTaskPane.DockPosition =
Office.MsoCTPDockPosition.msoCTPDockPositionRight;
myCustomTaskPane.Width = 300;
myCustomTaskPane.Visible = true;
myCustomTaskPane.DockPositionChanged +=
new EventHandler(myCustomTaskPane_DockPositionChanged);
}