CustomTaskPaneCollection Класс (2007 System)

Статья
11/16/2008

Обновлен: Ноябрь 2007

Представляет коллекцию настраиваемых областей задач в приложении Microsoft Office.

Пространство имен: Microsoft.Office.Tools
Сборка: Microsoft.Office.Tools.Common.v9.0 (в Microsoft.Office.Tools.Common.v9.0.dll)

Синтаксис

'Декларация
Public NotInheritable Class CustomTaskPaneCollection _
    Implements IEnumerable(Of CustomTaskPane), IEnumerable,  _
    ISupportInitialize, IDisposable
'Применение
Dim instance As CustomTaskPaneCollection

public sealed class CustomTaskPaneCollection : IEnumerable<CustomTaskPane>, 
    IEnumerable, ISupportInitialize, IDisposable

Заметки

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

Не следует создавать собственный экземпляр класса CustomTaskPaneCollection. Вместо этого используйте поле CustomTaskPanes класса ThisAddIn в проекте надстройки. Дополнительные сведения о классе ThisAddIn см. в разделах Программирование надстроек уровня приложения и Ведущий элемент AddIn.

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

Примеры

В следующем примере кода показано, как создать настраиваемую область задач с помощью метода 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);
}

Иерархия наследования

System.Object
Microsoft.Office.Tools.CustomTaskPaneCollection

Потокобезопасность

Любые открытые члены этого типа, объявленные как static (Shared в Visual Basic), являются потокобезопасными. Потокобезопасность членов экземпляров не гарантируется.