ControlCollection.AddLabel Method (Single, Single, Single, Single, String) (2003 System)
Adds a new Label control to the document in the specified size and location.
Namespace: Microsoft.Office.Tools.Word
Assembly: Microsoft.Office.Tools.Word (in Microsoft.Office.Tools.Word.dll)
Syntax
'Declaration
Public Function AddLabel ( _
left As Single, _
top As Single, _
width As Single, _
height As Single, _
name As String _
) As Label
'Usage
Dim instance As ControlCollection
Dim left As Single
Dim top As Single
Dim width As Single
Dim height As Single
Dim name As String
Dim returnValue As Label
returnValue = instance.AddLabel(left, _
top, width, height, name)
public Label AddLabel(
float left,
float top,
float width,
float height,
string name
)
Parameters
- left
Type: System.Single
The distance in pixels between the left edge of the control and the left edge of the document.
- top
Type: System.Single
The distance in pixels between the top edge of the control and the top edge of the document.
- width
Type: System.Single
The width of the control in pixels.
- height
Type: System.Single
The height of the control in pixels.
- name
Type: System.String
The name of the control 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 argument is nulla null reference (Nothing in Visual Basic) or has zero length. |
| ControlNameAlreadyExistsException | A control with the same name is already in the ControlCollection instance. |
Remarks
This method enables you to add Label objects to the end of the ControlCollection. To remove a Label that was previously added programmatically, use the Remove method.
Examples
The following code example adds a Label control to the start of the document, and then changes the text to First Name.
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";
}
Permissions
- 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.