ControlCollection.AddLinkLabel Method (, String) (2007 System)

  • Article

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

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

Syntax

'Declaration
Public Function AddLinkLabel ( _
    range As Range, _
    name As String _
) As LinkLabel

'Usage
Dim instance As ControlCollection 
Dim range As Range 
Dim name As String 
Dim returnValue As LinkLabel 

returnValue = instance.AddLinkLabel(range, _
    name)

public LinkLabel AddLinkLabel(
    Range range,
    string name
)

public:
LinkLabel^ AddLinkLabel(
    Range^ range, 
    String^ name
)

public function AddLinkLabel(
    range : Range, 
    name : String
) : LinkLabel

Parameters

  • range
    Type: Range

    A Range that provides the bounds for the control.

Return Value

Type: Microsoft.Office.Tools.Excel.Controls.LinkLabel
The LinkLabel 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. Multi-area ranges cannot be used. The range should be on the same worksheet as the ControlCollection instance.

Remarks

The AddLinkLabel method enables you to add LinkLabel objects to the end of the ControlCollection. To remove a LinkLabel 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 LinkLabel control to cell A1, 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.

Private Sub ExcelAddLinkLabel()

    Dim LinkLabel1 As Microsoft.Office.Tools.Excel. _
        Controls.LinkLabel = Me.Controls.AddLinkLabel( _
        0, 0, 75, 17.25, "LinkLabel1")
    LinkLabel1.Text = "First Name"
    LinkLabel1.LinkColor = Color.Blue
    LinkLabel1.LinkBehavior = LinkBehavior.HoverUnderline

End Sub

private void ExcelAddLinkLabel()
{

    Microsoft.Office.Tools.Excel.Controls.LinkLabel
         linkLabel1 = this.Controls.AddLinkLabel(
         0, 0, 75, 17.25, "linkLabel1");
    linkLabel1.Text = "First Name";
    linkLabel1.LinkColor = Color.Blue;
    linkLabel1.LinkBehavior = LinkBehavior.HoverUnderline;
}

.NET Framework Security

See Also

Reference

ControlCollection Class

ControlCollection Members

AddLinkLabel Overload

Microsoft.Office.Tools.Excel Namespace