ControlCollection.AddLabel Method (, Single, Single, String) (2007 System)

Article
09/25/2012

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

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

Syntax

'Declaration
Public Function AddLabel ( _
    range As Range, _
    width As Single, _
    height As Single, _
    name As String _
) As Label

'Usage
Dim instance As ControlCollection 
Dim range As Range 
Dim width As Single 
Dim height As Single 
Dim name As String 
Dim returnValue As Label 

returnValue = instance.AddLabel(range, _
    width, height, name)

public Label AddLabel(
    Range range,
    float width,
    float height,
    string name
)

public:
Label^ AddLabel(
    Range^ range, 
    float width, 
    float height, 
    String^ name
)

public function AddLabel(
    range : Range, 
    width : float, 
    height : float, 
    name : String
) : Label

Parameters

range
Type: Range

A Range that provides the location for 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 Label control that was added to the ControlCollection instance.

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.

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