ControlExtensions.AddLabel Method (ControlCollection, Range, Single, Single, String)

Article
06/14/2013

Adds a new Label control to the document in the specified size and location.

Namespace: Microsoft.Office.Tools.Word
Assembly: Microsoft.Office.Tools.Word.v4.0.Utilities (in Microsoft.Office.Tools.Word.v4.0.Utilities.dll)

Syntax

'Declaration
<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
)

Parameters

controls
Type: Microsoft.Office.Tools.Word.ControlCollection

The collection to add the control to. Do not supply this parameter yourself. When you call this method on the collection returned by the Document.Controls property (in an application-level project) or the DocumentBase.Controls property (in a document-level project), this parameter is supplied automatically.

range
Type: Range

The location of the control.

width
Type: System.Single

The width of the control in points.

height
Type: System.Single

The height of the control in points.

name
Type: System.String

The name that can be used to index the control in the ControlCollection instance.

Return Value

Type: Microsoft.Office.Tools.Word.Controls.Label
The control that was added to the document.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type ControlCollection. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Exceptions

Exception	Condition
ArgumentNullException	The name or range argument is nulla null reference (Nothing in Visual Basic), or the name argument has zero length.
ControlNameAlreadyExistsException	A control with the same name is already in the ControlCollection instance.
InvalidRangeException	The range that was specified is not valid.

Remarks

This method enables you to add Label objects to the end of the ControlCollection.

To remove a Label that was added programmatically, use the Remove method.

Examples

The following code example adds a Label control to the first paragraph in the document, and then changes the text to First Name. To use this example, run it from the ThisDocument class in a document-level project.

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";
}

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Share via