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

Article
09/25/2012

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

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

Syntax

'Declaration
Public Function AddLabel ( _
    left As Double, _
    top As Double, _
    width As Double, _
    height As Double, _
    name As String _
) As Label

'Usage
Dim instance As ControlCollection 
Dim left As Double 
Dim top As Double 
Dim width As Double 
Dim height As Double 
Dim name As String 
Dim returnValue As Label 

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

public Label AddLabel(
    double left,
    double top,
    double width,
    double height,
    string name
)

public:
Label^ AddLabel(
    double left, 
    double top, 
    double width, 
    double height, 
    String^ name
)

public function AddLabel(
    left : double, 
    top : double, 
    width : double, 
    height : double, 
    name : String
) : Label

Parameters

left
Type: System.Double

The distance in points between the left edge of the control and the left edge of the worksheet.

top
Type: System.Double

The distance in points between the top edge of the control and the top edge of the worksheet.

width
Type: System.Double

The width of the control in points.

height
Type: System.Double

The height of the control in points.

name
Type: System.String

The name of the control.

Return Value

Type: Microsoft.Office.Tools.Excel.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

The AddLabel method enables you to add Label objects to the end of the ControlCollection. To remove a Label control that was previously added programmatically, use the Remove method.

Examples

The following code example adds a Label control to the top of the worksheet, and then changes the text to First Name.

Private Sub ExcelAddLabel()

    Dim Label1 As Microsoft.Office.Tools.Excel. _
        Controls.Label = Me.Controls.AddLabel( _
        0, 0, 75, 17.25, "Label1")
    Label1.Text = "First Name" 

End Sub

private void ExcelAddLabel()
{

    Microsoft.Office.Tools.Excel.Controls.Label
        label1 = this.Controls.AddLabel(
        0, 0, 75, 17.25, "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