CustomTaskPaneCollection.Add Метод (UserControl, String) (2007 System)

Статья
11/16/2008

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

Создает новый объект CustomTaskPane и добавляет его в текущую коллекцию CustomTaskPaneCollection. Настраиваемая панель задач основана на указанном UserControl и имеет заданное имя.

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

Синтаксис

'Декларация
Public Function Add ( _
    control As UserControl, _
    title As String _
) As CustomTaskPane
'Применение
Dim instance As CustomTaskPaneCollection
Dim control As UserControl
Dim title As String
Dim returnValue As CustomTaskPane

returnValue = instance.Add(control, title)

public CustomTaskPane Add(
    UserControl control,
    string title
)

Параметры

control
Тип: System.Windows.Forms.UserControl
UserControl , который предоставляет пользовательский интерфейс для новой настраиваемой области задач.

title
Тип: System.String
Заголовок, который отображается в строке заголовка новой настраиваемой области задач.

Возвращаемое значение

Тип: Microsoft.Office.Tools.CustomTaskPane
CustomTaskPane , представляющая новую настраиваемую область задач.

Исключения

Исключение	Условие
ArgumentNullException	control или title имеет значение nullссылка null (Nothing в Visual Basic).
ObjectDisposedException	Метод Dispose уже вызван для CustomTaskPaneCollection.

Заметки

Этот метод используется для создания новой CustomTaskPane, которая связана с активным окном приложения the Microsoft Office.

Хотя класс CustomTaskPaneCollection является коллекцией объектов CustomTaskPane метод Add принимает объекты UserControl вместо объектов CustomTaskPane. Дополнительные сведения см. в разделе Общие сведения о настраиваемых областях задач.

Если необходимо связать настраиваемую область задач с заданным окном, используйте метод Add(UserControl, String, Object).

Примеры

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

Разрешения

Полное доверие для непосредственно вызывающего метода. Этот член не может быть использован частично доверенным кодом. Дополнительные сведения см. в разделе Использование библиотек из не вполне надежного кода.