ControlExtensions.AddLabel, méthode (ControlCollection, Range, Single, Single, String)
Ajoute un nouveau contrôle Label 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 AddLabel ( _
controls As ControlCollection, _
range As Range, _
width As Single, _
height As Single, _
name As String _
) As Label
public static Label AddLabel(
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.Label
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 Label à la fin de ControlCollection.
Pour supprimer un Label ajouté par programme, utilisez la méthode Remove.
Exemples
L'exemple de code suivant ajoute un contrôle Label au premier paragraphe du document, puis remplace le texte par First Name. Pour utiliser cet exemple, exécutez-le à partir de la classe ThisDocument dans un projet au niveau du document.
Private Sub WordRangeAddLabel()
Me.Paragraphs(1).Range.InsertParagraphBefore()
Dim Label1 As Microsoft.Office.Tools.Word.Controls.Label _
= Me.Controls.AddLabel(Me.Paragraphs(1).Range, 75, _
17.25F, "Label1")
Label1.Text = "First Name"
End Sub
private void WordRangeAddLabel()
{
this.Paragraphs[1].Range.InsertParagraphBefore();
Microsoft.Office.Tools.Word.Controls.Label
label1 = this.Controls.AddLabel(
this.Paragraphs[1].Range, 75, 17.25F, "label1");
label1.Text = "First Name";
}
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.