Share via


ControlExtensions.AddLabel Method (ControlCollection, Range, String)

Adds a new Label control to the worksheet at the range specified.

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

Syntax

'Declaration
<ExtensionAttribute> _
Public Shared Function AddLabel ( _
    controls As ControlCollection, _
    range As Range, _
    name As String _
) As Label
public static Label AddLabel(
    this ControlCollection controls,
    Range range,
    string name
)

Parameters

Return Value

Type: Microsoft.Office.Tools.Excel.Controls.Label
The Label control that was added to the ControlCollection instance.

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. Multi-area ranges cannot be used. The range should be on the same worksheet as the ControlCollection instance.

Remarks

The AddLabel 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.

The control automatically resizes when the range is resized.

Examples

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

    Private Sub ExcelRangeAddLabel()

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

    End Sub

private void ExcelRangeAddLabel()
{

    Microsoft.Office.Tools.Excel.Controls.Label
        label1 = this.Controls.AddLabel(
        this.Range["A1", missing], "label1");
    label1.Text = "First Name";
}

.NET Framework Security

See Also

Reference

ControlExtensions Class

AddLabel Overload

Microsoft.Office.Tools.Excel Namespace