WorkbookBase.XmlImportXml(String, XmlMap, Object, Object) メソッド

定義

名前空間:

Microsoft.Office.Tools.Excel

アセンブリ:

Microsoft.Office.Tools.Excel.v4.0.Utilities.dll

既にメモリに読み込まれている XML データ ストリームをインポートします。

public Microsoft.Office.Interop.Excel.XlXmlImportResult XmlImportXml (string data, out Microsoft.Office.Interop.Excel.XmlMap importMap, object overwrite, object destination);

member this.XmlImportXml : string * XmlMap * obj * obj -> Microsoft.Office.Interop.Excel.XlXmlImportResult

Public Function XmlImportXml (data As String, ByRef importMap As XmlMap, Optional overwrite As Object, Optional destination As Object) As XlXmlImportResult

パラメーター

data

String

インポートするデータです。

importMap

XmlMap

ファイルをインポートするときに適用するスキーマ マップです。

overwrite

Object

パラメーターに値が指定 Destination されていない場合、このパラメーターは、 パラメーターで ImportMap 指定されたスキーマ マップにマップされたデータを上書きするかどうかを指定します。 true に設定するとデータを上書きし、false に設定すると新しいデータを既存のデータに追加します。 既定値は true です。 パラメーターに値が指定されている Destination 場合、このパラメーターは既存のデータを上書きするかどうかを指定します。 true に設定すると既存のデータを上書きし、false に設定すると、インポートをキャンセルしてデータが上書きされないようにします。 既定値は true です。

destination

Object

指定されている Range にある新しい XML リストにデータがインポートされます。

戻り値

XlXmlImportResult

XlXmlImportResult 値のいずれか 1 つ。

例

次のコード例は、XML データをブックにインポートする方法を示しています。 この例では、顧客名の をDataSet作成し、 の XML スキーマDataSetに基づいて を現在のブックのコレクションにXmlMaps追加XmlMapします。 次に、 メソッドを XmlImportXml 呼び出して、ワークシート Sheet1にデータをインポートします。 メソッドが XmlImportXml 呼び出されると、 BeforeXmlImport イベント ハンドラーは、XML のインポートを続行するか取り消すかをユーザーに求め、 AfterXmlImport イベント ハンドラーは XML が正常にインポートされたかどうかを報告します。

この例は、ドキュメント レベルのカスタマイズ用です。

private void WorkbookXmlImportEvents()
{
    this.BeforeXmlImport +=
        new Excel.WorkbookEvents_BeforeXmlImportEventHandler(
        ThisWorkbook_BeforeXmlImport);

    this.AfterXmlImport += new
        Excel.WorkbookEvents_AfterXmlImportEventHandler(
        ThisWorkbook_AfterXmlImport);

    // Create a new DataTable.
    DataSet ds = new DataSet();
    DataTable dt = ds.Tables.Add("Customers");
    dt.Columns.Add(new DataColumn("LastName"));
    dt.Columns.Add(new DataColumn("FirstName"));

    // Add a new row to the DataTable.
    DataRow dr = dt.NewRow();
    dr["LastName"] = "Chan";
    dr["FirstName"] = "Gareth";
    dt.Rows.Add(dr);

    // Add a new XML map to the collection.
    Excel.XmlMap xmlMap1 = this.XmlMaps.Add(ds.GetXmlSchema(),
        "NewDataSet");

    // Import the data stream if the XmlMap was successfully created.
    if (xmlMap1 != null)
    {
        // This will raise the BeforeXmlImport and AfterXmlImport events.
        Excel.Range range1 = Globals.Sheet1.Range["A1"];
        this.XmlImportXml(ds.GetXml(), out xmlMap1, true,
            range1);
    }
    else
    {
        MessageBox.Show("The XmlMap could not be created");
    }
}

void ThisWorkbook_BeforeXmlImport(Excel.XmlMap Map,
    string Url, bool IsRefresh, ref bool Cancel)
{
    if (DialogResult.No == MessageBox.Show("Microsoft Excel is about" +
        " to import XML into the workbook. Continue with importing?",
        "Custom XML Import Dialog", MessageBoxButtons.YesNo))
    {
        Cancel = true;
    }
}

void ThisWorkbook_AfterXmlImport(Excel.XmlMap Map, bool IsRefresh,
    Excel.XlXmlImportResult Result)
{
    if (Result == Excel.XlXmlImportResult.xlXmlImportSuccess)
    {
        MessageBox.Show("XML import succeeded.");
    }
    else
    {
        MessageBox.Show("XML import failed.");
    }
}

Private Sub WorkbookXmlImportEvents()

    ' Create a new DataTable.
    Dim ds As New DataSet()
    Dim dt As DataTable = ds.Tables.Add("Customers")
    dt.Columns.Add(New DataColumn("LastName"))
    dt.Columns.Add(New DataColumn("FirstName"))

    ' Add a new row to the DataTable.
    Dim dr As DataRow = dt.NewRow()
    dr("LastName") = "Chan"
    dr("FirstName") = "Gareth"
    dt.Rows.Add(dr)

    ' Add a new XML map to the collection.
    Dim xmlMap1 As Excel.XmlMap = Me.XmlMaps.Add(ds.GetXmlSchema(), _
        "NewDataSet")

    ' Import the data stream if the XmlMap was successfully created.
    If Not (xmlMap1 Is Nothing) Then

        ' This will raise the BeforeXmlImport and AfterXmlImport events.
        Dim range1 As Excel.Range = Globals.Sheet1.Range("A1")
        Me.XmlImportXml(ds.GetXml(), xmlMap1, True, _
            range1)
    Else
        MsgBox("The XmlMap could not be created")
    End If
End Sub

Sub ThisWorkbook_BeforeXmlImport(ByVal Map As Excel.XmlMap, _
    ByVal Url As String, ByVal IsRefresh As Boolean, _
    ByRef Cancel As Boolean) Handles Me.BeforeXmlImport

    If DialogResult.No = MessageBox.Show("Microsoft Excel is about" & _
        " to import XML into the workbook. Continue with importing?", _
        "Custom XML Import Dialog", MessageBoxButtons.YesNo) Then
        Cancel = True
    End If
End Sub

Sub ThisWorkbook_AfterXmlImport(ByVal Map As Excel.XmlMap, _
    ByVal IsRefresh As Boolean, ByVal Result As Excel.XlXmlImportResult) _
    Handles Me.AfterXmlImport

    If Result = Excel.XlXmlImportResult.xlXmlImportSuccess Then
        MsgBox("XML import succeeded.")
    Else
        MsgBox("XML import failed.")
    End If
End Sub

注釈

既存の Destination マッピングにデータをインポートする場合は、 パラメーターの値を指定しないでください。

次の条件により、このメソッドによって実行時エラーが生成されます。

• 指定された XML データに構文エラーが含まれています。

• 指定したデータがワークシートに収まらないため、インポート プロセスが取り消されました。

メソッドを XmlImport 使用して、XML データ ファイルを現在のブックにインポートします。

省略可能のパラメーター

省略可能なパラメーターの詳細については、「 Office ソリューションの省略可能なパラメーター」を参照してください。