Share via


ControlExtensions.AddCheckBox, méthode (ControlCollection, Range, Single, Single, String)

Ajoute un nouveau contrôle CheckBox 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 AddCheckBox ( _
    controls As ControlCollection, _
    range As Range, _
    width As Single, _
    height As Single, _
    name As String _
) As CheckBox
public static CheckBox AddCheckBox(
    this ControlCollection controls,
    Range range,
    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.

Valeur de retour

Type : Microsoft.Office.Tools.Word.Controls.CheckBox
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 ou range est nullune référence null (Nothing en Visual Basic) ou l'argument name a une longueur nulle.

ControlNameAlreadyExistsException

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

InvalidRangeException

La plage spécifiée n'est pas valide.

Notes

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

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

Exemples

L'exemple de code suivant ajoute un contrôle CheckBox au premier paragraphe du document, puis ajoute un texte à la case à cocher. Pour utiliser cet exemple, exécutez-le à partir de la classe ThisDocument dans un projet au niveau du document.

Private Sub WordRangeAddCheckBox()
    Me.Paragraphs(1).Range.InsertParagraphBefore()
    Dim CheckBox1 As Microsoft.Office.Tools.Word.Controls. _
        CheckBox = Me.Controls.AddCheckBox(Me.Paragraphs(1). _
        Range, 78, 18, "CheckBox1")
    CheckBox1.Text = "Underline"
End Sub 
private void WordRangeAddCheckBox()
{
    this.Paragraphs[1].Range.InsertParagraphBefore();
    Microsoft.Office.Tools.Word.Controls.CheckBox checkBox1 =
        this.Controls.AddCheckBox(this.Paragraphs[1].Range,
        78, 18, "checkBox1");
    checkBox1.Text = "Underline";
}

Sécurité .NET Framework

Voir aussi

Référence

ControlExtensions Classe

AddCheckBox, surcharge

Microsoft.Office.Tools.Word, espace de noms