ControlCollection.AddControl-Methode (Control, Single, Single, Single, Single, String)

Artikel
01/03/2014

Fügt der ControlCollection das angegebene Steuerelement mit der angegebenen Größe an der angegebenen Position hinzu.

Namespace: Microsoft.Office.Tools.Word
Assemblys: Microsoft.Office.Tools.Word (in Microsoft.Office.Tools.Word.dll)
Microsoft.Office.Tools.Word.v4.0.Utilities (in Microsoft.Office.Tools.Word.v4.0.Utilities.dll)

Syntax

'Declaration
Function AddControl ( _
    control As Control, _
    left As Single, _
    top As Single, _
    width As Single, _
    height As Single, _
    name As String _
) As ControlSite

ControlSite AddControl(
    Control control,
    float left,
    float top,
    float width,
    float height,
    string name
)

Parameter

control
Typ: System.Windows.Forms.Control
Das der ControlCollection-Instanz hinzuzufügende Steuerelement.

left
Typ: System.Single
Die Entfernung zwischen dem linken Rand des Steuerelements und dem linken Rand des Dokuments in Punkt.

top
Typ: System.Single
Die Entfernung zwischen dem oberen Rand des Steuerelements und dem oberen Rand des Dokuments in Punkt.

width
Typ: System.Single
Die Breite des Steuerelements in Punkt.

height
Typ: System.Single
Die Höhe des Steuerelements in Punkt.

name
Typ: System.String
Der Name des Steuerelements.

Rückgabewert

Typ: Microsoft.Office.Tools.Word.ControlSite
Ein Objekt, das das Steuerelement mit dem angegebenen Steuerelement im Dokument darstellt.

Ausnahmen

Ausnahme	Bedingung
ArgumentNullException	Das name-Argument ist nullein Nullverweis (Nothing in Visual Basic) oder das ist name-Argument hat die Länge 0 (null).
ControlNameAlreadyExistsException	Ein Steuerelement mit dem gleichen Namen ist bereits in der ControlCollection-Instanz vorhanden.
ControlCouldNotBeInitializedException	Das control-Argument ist nullein Nullverweis (Nothing in Visual Basic).

Hinweise

Mit dieser Methode können Sie der ControlCollection zur Laufzeit ein beliebiges Steuerelement hinzufügen. Weitere Informationen finden Sie unter Hinzufügen von Steuerelementen zu Office-Dokumenten zur Laufzeit.

Beispiele

Im folgenden Codebeispiel werden dem Dokument mithilfe der AddControl-Methode zwei benutzerdefinierte Benutzersteuerelemente hinzugefügt. Das erste Steuerelement wird einem Range hinzugefügt. Das zweite Steuerelement wird an einer bestimmten Position eingefügt. Die Top-Eigenschaft des ersten benutzerdefinierten Steuerelements wird durch den Code geändert, wodurch das Steuerelement nur im Verhältnis zu dem ControlSite verschoben wird, das das Steuerelement im Dokument enthält. Anschließend wird im Code die Top-Eigenschaft des vom zweiten Benutzersteuerelement zurückgegebenen ControlSite festgelegt, um die korrekte Vorgehensweise zum Festlegen der Top-Eigenschaft des Steuerelements zu veranschaulichen.

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-Sicherheit

Volle Vertrauenswürdigkeit für den unmittelbaren Aufrufer. Dieser Member kann von nur teilweise vertrauenswürdigem Code nicht verwendet werden. Weitere Informationen finden Sie unter Verwenden von Bibliotheken aus teilweise vertrauenswürdigem Code.