ControlCollection.AddControl - метод (Control, Range, Single, Single, String)

Статья
08/11/2011

Добавляет в коллекцию ControlCollection указанный элемент управления с заданным диапазоном и размером.

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

Синтаксис

'Декларация
Function AddControl ( _
    control As Control, _
    range As Range, _
    width As Single, _
    height As Single, _
    name As String _
) As ControlSite

ControlSite AddControl(
    Control control,
    Range range,
    float width,
    float height,
    string name
)

Параметры

control
Тип: System.Windows.Forms.Control
Элемент управления, добавляемый в экземпляр коллекции ControlCollection.

range
Тип: Microsoft.Office.Interop.Word.Range
Объект Range, предоставляющий местоположение элемента управления.

width
Тип: System.Single
Ширина элемента управления в пунктах.

height
Тип: System.Single
Высота элемента управления в пунктах.

name
Тип: System.String
Имя, которое можно использовать для индексации элемента управления в экземпляре класса ControlCollection.

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

Тип: Microsoft.Office.Tools.Word.ControlSite
Объект, представляющий элемент управления, который содержит указанный элемент управления в документе.

Исключения

Исключение	Условие
ArgumentNullException	Аргумент control, name, range имеет значение nullпустая ссылка (Nothing в Visual Basic), либо аргумент name имеет нулевую длину.
ControlNameAlreadyExistsException	Элемент управления с таким именем уже имеется в данном экземпляре класса ControlCollection.
InvalidRangeException	Указанный диапазон не существует.

Заметки

Этот метод используется для добавления во время выполнения любого элемента управления в коллекцию ControlCollection. Дополнительные сведения см. в разделе Добавление элементов управления в документы Office во время выполнения.

Примеры

В приведенном ниже примере кода с помощью метода AddControl в документ добавляются два настраиваемых пользовательских элемента управления. Первый элемент управления добавляется в объект Range. Второй элемент управления добавляется в указанное расположение. В коде изменяется свойство Top первого настраиваемого пользовательского элемента управления, что приводит к перемещению элемента управления относительно объекта ControlSite, в котором содержится элемент управления в документе. Затем в коде присваивается значение свойству Top объекта ControlSite, возвращаемого вторым пользовательским элементом управления с целью демонстрации правильного способа задания свойства Top элемента управления.

Private Sub WordRangeAddControl()
    Me.Paragraphs(1).Range.InsertParagraphBefore()
    Dim CustomUserControl As New UserControl1()
    Dim CustomUserControl2 As New UserControl2()

    Dim DynamicControl As Microsoft.Office.Tools.Word.ControlSite = _
        Me.Controls.AddControl(CustomUserControl, _
        Me.Paragraphs(1).Range, 150, 150, "DynamicControl")

    Dim DynamicControl2 As Microsoft.Office.Tools.Word.ControlSite = _
        Me.Controls.AddControl(CustomUserControl2, _
        200, 0, 150, 150, "DynamicControl2")

    CustomUserControl.BackColor = Color.Blue
    CustomUserControl2.BackColor = Color.Green

    CustomUserControl.Top = 100
    dynamicControl2.Top = 100
End Sub

private void WordRangeAddControl()
{
    this.Paragraphs[1].Range.InsertParagraphBefore();
    UserControl1 customUserControl = new UserControl1();
    UserControl2 customUserControl2 = new UserControl2();

    Microsoft.Office.Tools.Word.ControlSite dynamicControl =
        this.Controls.AddControl(customUserControl, 
        this.Paragraphs[1].Range, 150, 150, "dynamicControl");

    Microsoft.Office.Tools.Word.ControlSite dynamicControl2 =
        this.Controls.AddControl(customUserControl2, 200, 0,
        150, 150, "dynamicControl2");

    customUserControl.BackColor = Color.Blue;
    customUserControl2.BackColor = Color.Green;

    customUserControl.Top = 100;
    dynamicControl2.Top = 100;
}

Безопасность платформы .NET Framework

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