Workbook..::.UpdateLink Method

Article
01/07/2014

Updates a Microsoft Office Excel, DDE, or OLE link (or links).

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

Syntax

Sub UpdateLink ( _
    Name As Object, _
    Type As Object _
)

void UpdateLink(
    Object Name,
    Object Type
)

Parameters

Name
Type: System..::.Object

The name of the Excel or DDE/OLE link to be updated, as returned from the LinkSources method.

Type
Type: System..::.Object

One of the XlLinkType values.

Remarks

When this method is called without any parameters, Excel defaults to updating all worksheet links.

Optional Parameters

For information on optional parameters, see Optional Parameters in Office Solutions.

Examples

The following code example creates an external link to an Excel workbook and then uses the UpdateLink method to update the link. This example assumes that workbook Book2.xlsx exists at the root of the C directory.

Private Sub WorkbookUpdateLink()
    Dim Links As Array = _
        CType(Me.LinkSources(Excel.XlLink.xlExcelLinks),  _
        Array)
    If Links IsNot Nothing Then 
        Dim i As Integer 
        For i = 1 To Links.Length
            Me.UpdateLink(Links(i), _
                Excel.XlLinkType.xlLinkTypeExcelLinks)
        Next i
    Else
        MsgBox("The workbook contains no links to " & _
            "other workbooks.")
    End If 
End Sub

private void WorkbookUpdateLink()
{
    Array links = (Array)this.LinkSources(Excel.XlLink.xlExcelLinks);

    if (links != null)
    {
        for (int i = 1; i <= links.Length; i++)
        {
            this.UpdateLink((string)links.GetValue(i),
                Excel.XlLinkType.xlLinkTypeExcelLinks);
        }
    }
    else
    {
        MessageBox.Show("The workbook contains no links to " +
            "other workbooks.");
    }
}

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