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

Article
08/10/2011

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, _
    left As Single, _
    top As Single, _
    width As Single, _
    height As Single, _
    name As String _
) As Label

public static Label AddLabel(
    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.

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 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 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 début 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 WordAddLabel()
    Me.Paragraphs(1).Range.InsertParagraphBefore()
    Dim Label1 As Microsoft.Office.Tools.Word.Controls.Label _
        = Me.Controls.AddLabel(0, 0, 75, 17.25F, "Label1")
    Label1.Text = "First Name"
End Sub

private void WordAddLabel()
{
    this.Paragraphs[1].Range.InsertParagraphBefore();
    Microsoft.Office.Tools.Word.Controls.Label
        label1 = this.Controls.AddLabel(
        0, 0, 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.

Voir aussi

Référence

ControlExtensions Classe

AddLabel, surcharge

Microsoft.Office.Tools.Word, espace de noms

Partager via