WorkbookEvents_BeforeXmlImportEventHandler Delegate 

A Delegate type used to add an event handler for the BeforeXmlImport event. The BeforeXmlImport event occurs before an existing XML data connection is refreshed or before new XML data is imported into a Microsoft Excel workbook.

Namespace: Microsoft.Office.Interop.Excel
Assembly: Microsoft.Office.Interop.Excel (in microsoft.office.interop.excel.dll)

Usage

Sub Sub1(Map As XmlMap, _
    Url As String, _
    IsRefresh As Boolean, _
    Cancel As Boolean)
End Sub
Dim workbookEvents_BeforeXmlImportEventHandler1 As New WorkbookEvents_BeforeXmlImportEventHandler(AddressOf Sub1)

Syntax

Public Delegate Sub WorkbookEvents_BeforeXmlImportEventHandler( _
    <InAttribute()> ByVal Map As XmlMap, _
    <InAttribute()> ByVal Url As String, _
    <InAttribute()> ByVal IsRefresh As Boolean, _
    <InAttribute(), OutAttribute()> ByRef Cancel As Boolean _
)
public delegate void WorkbookEvents_BeforeXmlImportEventHandler(
    [In] XmlMap Map, 
    [In] string Url, 
    [In] bool IsRefresh, 
    [In, Out] ref bool Cancel
);
public delegate Void WorkbookEvents_BeforeXmlImportEventHandler(
    XmlMap^ Map, 
    String^ Url, 
    Boolean IsRefresh, 
    &Boolean Cancel
);
public delegate void WorkbookEvents_BeforeXmlImportEventHandler(
    /*in*/XmlMap Map, 
    /*in*/System.String Url, 
    /*in*/boolean IsRefresh, 
    /*in*/boolean Cancel
);
In JScript, you can use the delegates in the .NET Framework, but you cannot define your own.

Parameters

  • Map
    Required XmlMap object. The XML map that will be used to import data.
  • Url
    Required String. The location of the XML file to be imported.
  • IsRefresh
    Required Boolean. True if the event was triggered by refreshing an existing connection to XML data; False if the event was triggered by importing from a different data source.
  • Cancel
    Required Boolean. Set to True to cancel the import or refresh operation.

Remarks

XML features, except for saving files in the XML Spreadsheet format, are available only in Microsoft Office Professional Edition 2003 and Microsoft Office Excel 2003.

Platforms

Development Platforms

Windows XP Home Edition, Windows XP Professional, Windows Server 2003, and Windows 2000

Target Platforms

See Also

Reference

Microsoft.Office.Interop.Excel Namespace