ControlCollection.AddLinkLabel Method (Range, Single, Single, String)

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

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

Syntax

'Declaration
Public Function AddLinkLabel ( _
    range As Range, _
    width As Single, _
    height As Single, _
    name As String _
) As LinkLabel
'Usage
Dim instance As ControlCollection
Dim range As Range
Dim width As Single
Dim height As Single
Dim name As String
Dim returnValue As LinkLabel

returnValue = instance.AddLinkLabel(range, _
    width, height, name)
public LinkLabel AddLinkLabel(
    Range range,
    float width,
    float height,
    string name
)

Parameters

  • height
    Type: System.Single
    The height of the control in points.

Return Value

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

Remarks

This method enables you to add LinkLabel objects to the end of the ControlCollection.

To remove a LinkLabel that was added programmatically, use the Remove method.

Examples

The following code example adds a LinkLabel control to the first paragraph in the document, 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 WordRangeAddLinkLabel()
        Me.Paragraphs(1).Range.InsertParagraphBefore()
        Dim LinkLabel1 As Microsoft.Office.Tools.Word.Controls. _
            LinkLabel = Me.Controls.AddLinkLabel(Me.Paragraphs(1). _
            Range, 75, 17.25F, "LinkLabel1")
        LinkLabel1.Text = "First Name"
        LinkLabel1.LinkColor = Color.Blue
        LinkLabel1.LinkBehavior = LinkBehavior.HoverUnderline

    End Sub 

private void WordRangeAddLinkLabel()
{
    this.Paragraphs[1].Range.InsertParagraphBefore();
    Microsoft.Office.Tools.Word.Controls.LinkLabel
         linkLabel1 = this.Controls.AddLinkLabel(
         this.Paragraphs[1].Range, 75, 17.25F, "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.Word Namespace