This documentation is archived and is not being maintained.

Workbook.SetLinkOnData Method (2007 System)

Sets the name of a procedure that runs whenever a DDE link is updated.

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

public void SetLinkOnData(
	string Name,
	Object Procedure
)

Parameters

Name
Type: System.String

The name of the DDE/OLE link, as returned from the LinkSources method.

Procedure
Type: System.Object

The name of the procedure to be run when the link is updated. This can be either a Microsoft Office Excel 4.0 macro or a Visual Basic procedure. Set this argument to an empty string ("") to indicate that no procedure should run when the link is updated.

Optional Parameters

For information on optional parameters, see The Variable missing and Optional Parameters in Office Solutions.

The following code example gets the collection of all DDE links in the current workbook and then uses the SetLinkOnData method to run a macro named UPDATE_MACRO whenever one of the links is updated.

This example is for a document-level customization.

private void WorkbookSetLinkOnData()
{
    Array links = (Array)this.LinkSources(Excel.XlLink.xlOLELinks);

    if (links != null)
    {
        for (int i = 1; i <= links.Length; i++)
        {
            this.SetLinkOnData((string)links.GetValue(i), "UPDATE_MACR0");
        }
    }
    else
    {
        MessageBox.Show("The workbook contains no DDE/OLE links.");
    }
}

Show: