Share via


ControlExtensions.AddLinkLabel Method (ControlCollection, Double, Double, Double, Double, String)

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

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 AddLinkLabel ( _
    controls As ControlCollection, _
    left As Double, _
    top As Double, _
    width As Double, _
    height As Double, _
    name As String _
) As LinkLabel
public static LinkLabel AddLinkLabel(
    this ControlCollection controls,
    double left,
    double top,
    double width,
    double height,
    string name
)

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.
  • height
    Type: System.Double
    The height of the control in points.

Return Value

Type: Microsoft.Office.Tools.Excel.Controls.LinkLabel
The LinkLabel 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 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 AddLinkLabel method enables you to add LinkLabel objects to the end of the ControlCollection. To remove a LinkLabel control that was previously added programmatically, use the Remove method.

Examples

The following code example adds a LinkLabel control to the top of the worksheet, and then changes the text to First Name. The code then changes the color of the link to blue and sets the LinkBehavior to HoverUnderline. To use this example, run it from the Sheet1 class in a document-level project.

    Private Sub ExcelRangeAddListBox()

        Dim ListBox1 As Microsoft.Office.Tools.Excel. _
            Controls.ListBox = Me.Controls.AddListBox( _
            Me.Range("A1", "B6"), "ListBox1")

        ListBox1.Items.Add("First Item")
        ListBox1.Items.Add("Second Item")
        ListBox1.SelectedIndex = 0

    End Sub

private void ExcelRangeAddListBox()
{

    Microsoft.Office.Tools.Excel.Controls.ListBox
         listBox1 = this.Controls.AddListBox(
         this.Range["A1", "B6"], "lisBox1");
    listBox1.Items.Add("First Item");
    listBox1.Items.Add("Second Item");
    listBox1.SelectedIndex = 0;
}

.NET Framework Security

See Also

Reference

ControlExtensions Class

AddLinkLabel Overload

Microsoft.Office.Tools.Excel Namespace