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

Article
07/25/2011

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

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

Syntax

'Declaration
<ExtensionAttribute> _
Public Shared Function AddLinkLabel ( _
    controls As ControlCollection, _
    range As Range, _
    width As Single, _
    height As Single, _
    name As String _
) As LinkLabel

public static LinkLabel AddLinkLabel(
    this ControlCollection controls,
    Range range,
    float width,
    float height,
    string name
)

Parameters

controls
Type: Microsoft.Office.Tools.Word.ControlCollection
The collection to add the control to. Do not supply this parameter yourself. When you call this method on the collection returned by the Document.Controls property (in an application-level project) or the DocumentBase.Controls property (in a document-level project), this parameter is supplied automatically.

range
Type: Microsoft.Office.Interop.Word.Range
The location of the control.

width
Type: System.Single
The width of the control in points.

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

name
Type: System.String
The name of the control that can be used to index the control in the ControlCollection instance.

Return Value

Type: Microsoft.Office.Tools.Word.Controls.LinkLabel
The control that was added to the document.

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.

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 property to the HoverUnderline value of the LinkBehavior enumeration. To use this example, run it from the ThisDocument class in a document-level project.

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

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