Partager via


ControlExtensions.AddTextBox, méthode (ControlCollection, Single, Single, Single, Single, String)

Ajoute un nouveau contrôle TextBox au document selon la taille et l'emplacement spécifiés.

Espace de noms :  Microsoft.Office.Tools.Word
Assembly :  Microsoft.Office.Tools.Word.v4.0.Utilities (dans Microsoft.Office.Tools.Word.v4.0.Utilities.dll)

Syntaxe

'Déclaration
<ExtensionAttribute> _
Public Shared Function AddTextBox ( _
    controls As ControlCollection, _
    left As Single, _
    top As Single, _
    width As Single, _
    height As Single, _
    name As String _
) As TextBox
public static TextBox AddTextBox(
    this ControlCollection controls,
    float left,
    float top,
    float width,
    float height,
    string name
)

Paramètres

  • controls
    Type : Microsoft.Office.Tools.Word.ControlCollection
    Collection à laquelle le contrôle doit être ajouté.Ne fournissez pas ce paramètre vous-même.Lorsque vous appelez cette méthode sur la collection retournée par la propriété Document.Controls (dans un projet au niveau de l'application) ou la propriété DocumentBase.Controls (dans un projet au niveau du document), ce paramètre est fourni automatiquement.
  • left
    Type : System.Single
    Distance, en points, entre le bord gauche du contrôle et le bord gauche du document.
  • top
    Type : System.Single
    Distance, en points, entre le bord supérieur du contrôle et le bord supérieur du document.

Valeur de retour

Type : Microsoft.Office.Tools.Word.Controls.TextBox
Contrôle qui a été ajouté au document.

Remarque sur l'utilisation

En Visual Basic et C#, vous pouvez appeler cette méthode comme une méthode d'instance sur n'importe quel objet de type ControlCollection. Lorsque vous utilisez la syntaxe des méthodes d'instance pour appeler cette méthode, omettez le premier paramètre. Pour plus d'informations, consultez Méthodes d'extension (Visual Basic) ou Méthodes d'extension (Guide de programmation C#).

Exceptions

Exception Condition
ArgumentNullException

L'argument name est nullune référence null (Nothing en Visual Basic) ou une longueur nulle.

ControlNameAlreadyExistsException

Un contrôle portant le même nom se trouve déjà dans l'instance de ControlCollection.

Notes

Cette méthode permet d'ajouter des objets TextBox à la fin de ControlCollection.

Pour supprimer un TextBox ajouté par programme, utilisez la méthode Remove.

Exemples

L'exemple de code suivant ajoute un contrôle TextBox au début du document, puis assigne un texte au contrôle. Pour utiliser cet exemple, exécutez-le à partir de la classe ThisDocument dans un projet au niveau du document.

Private Sub WordAddTextBox()
    Me.Paragraphs(1).Range.InsertParagraphBefore()
    Dim TextBox1 As Microsoft.Office.Tools.Word.Controls. _
        TextBox = Me.Controls.AddTextBox(0, 0, 75, 15, _
        "TextBox1")
    TextBox1.Text = "Sample text"
End Sub 
private void WordAddTextBox()
{
    this.Paragraphs[1].Range.InsertParagraphBefore();
    Microsoft.Office.Tools.Word.Controls.TextBox
         textBox1 = this.Controls.AddTextBox(
         0, 0, 75, 15, "textBox1");
    textBox1.Text = "Sample text";
}

Sécurité .NET Framework

Voir aussi

Référence

ControlExtensions Classe

AddTextBox, surcharge

Microsoft.Office.Tools.Word, espace de noms