CustomTaskPaneCollection - интерфейс

Статья
08/11/2011

Представляет коллекцию настраиваемых областей задач в приложении 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 предоставляет следующие члены.

Свойства

	Имя	Описание
	Count	Возвращает число объектов CustomTaskPane в текущей CustomTaskPaneCollection.
	Item	Получает объект CustomTaskPane по указанному индексу.

В начало страницы

Методы

	Имя	Описание
	Add(UserControl, String)	Создает новый объект CustomTaskPane и добавляет его в текущую коллекцию CustomTaskPaneCollection.Настраиваемая панель задач основана на указанном UserControl и имеет заданное имя.
	Add(UserControl, String, Object)	Создает новый объект CustomTaskPane и добавляет его в текущую коллекцию CustomTaskPaneCollection.Настраиваемая область задач основана на указанном UserControl, имеет заданный заголовок и связано с указанным окном приложения.
	BeginInit	Инфраструктура.
	Dispose	Выполняет определяемые приложением задачи, связанные с высвобождением или сбросом неуправляемых ресурсов. (Унаследовано от IDisposable.)
	EndInit	Инфраструктура.
	GetEnumerator()	Возвращает перечислитель, выполняющий перебор элементов в коллекции. (Унаследовано от IEnumerable<CustomTaskPane>.)
	GetEnumerator()	Возвращает перечислитель, который выполняет итерацию по элементам коллекции. (Унаследовано от IEnumerable.)
	Remove	Удаляет заданный объект CustomTaskPane из CustomTaskPaneCollection.
	RemoveAt	Удаляет элемент CustomTaskPane по указанному индексу CustomTaskPaneCollection.

В начало страницы

Заметки

Используйте объект CustomTaskPaneCollection в надстройке уровня приложения для добавления в приложение настраиваемой области задач, ее удаления или доступа к существующей настраиваемой области задач. Для доступа к объекту CustomTaskPaneCollection используйте поле CustomTaskPanes класса ThisAddIn в проекте надстройки. Дополнительные сведения см. в разделе Программирование надстроек уровня приложения.

Области задач — это области пользовательского интерфейса, которые обычно закрепляются у одного края окна приложения. Дополнительные сведения о создании настраиваемых областей задач см. в разделе Общие сведения о настраиваемых областях задач.

Примечание

Данный интерфейс реализован средствами Visual Studio Tools для среды выполнения Office. Он не предназначен для реализации в пользовательском коде. Дополнительные сведения см. в разделе Общие сведения об инструментах Visual Studio для среды выполнения Office.

Использование

В настоящей документации описывается версия данного типа, которая используется в проектах Office, предназначенных для платформы .NET Framework 4. В проектах, предназначенных для платформы .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);
}