ControlExtensions.AddListBox, méthode (ControlCollection, Range, Single, Single, String)
Ajoute un nouveau contrôle ListBox 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 AddListBox ( _
controls As ControlCollection, _
range As Range, _
width As Single, _
height As Single, _
name As String _
) As ListBox
public static ListBox AddListBox(
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.
- range
Type : Microsoft.Office.Interop.Word.Range
Emplacement du contrôle.
- width
Type : System.Single
Largeur du contrôle en points.
- height
Type : System.Single
Hauteur du contrôle en points.
- name
Type : System.String
Nom qui peut être utilisé pour indexer le contrôle dans l'instance ControlCollection.
Valeur de retour
Type : Microsoft.Office.Tools.Word.Controls.ListBox
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 ListBox à la fin de ControlCollection.
Pour supprimer un ListBox ajouté par programme, utilisez la méthode Remove.
Exemples
L'exemple de code suivant ajoute un contrôle ListBox au premier paragraphe du document, ajoute deux éléments à la zone de liste, puis sélectionne le premier élément. Pour utiliser cet exemple, exécutez-le à partir de la classe ThisDocument dans un projet au niveau du document.
Private Sub WordRangeAddListBox()
Me.Paragraphs(1).Range.InsertParagraphBefore()
Dim ListBox1 As Microsoft.Office.Tools.Word.Controls. _
ListBox = Me.Controls.AddListBox(Me.Paragraphs(1).Range, _
90, 71.25F, "LisBox1")
ListBox1.Items.Add("First Item")
ListBox1.Items.Add("Second Item")
ListBox1.SelectedIndex = 0
End Sub
private void WordRangeAddListBox()
{
this.Paragraphs[1].Range.InsertParagraphBefore();
Microsoft.Office.Tools.Word.Controls.ListBox
listBox1 = this.Controls.AddListBox(
this.Paragraphs[1].Range, 90, 71.25F, "lisBox1");
listBox1.Items.Add("First Item");
listBox1.Items.Add("Second Item");
listBox1.SelectedIndex = 0;
}
Sécurité .NET Framework
- Confiance totale accordée à l'appelant immédiat. Ce membre ne peut pas être utilisé par du code d'un niveau de confiance partiel. Pour plus d'informations, consultez Utilisation de bibliothèques à partir de code d'un niveau de confiance partiel.