Método WorkbookBase.XmlImport

Artigo
01/09/2014

Importa um arquivo de dados XML na pasta de trabalho atual.

Namespace: Microsoft.Office.Tools.Excel
Assembly: Microsoft.Office.Tools.Excel.v4.0.Utilities (em Microsoft.Office.Tools.Excel.v4.0.Utilities.dll)

Sintaxe

'Declaração
Public Function XmlImport ( _
    url As String, _
    <OutAttribute> ByRef importMap As XmlMap, _
    overwrite As Object, _
    destination As Object _
) As XlXmlImportResult

public XlXmlImportResult XmlImport(
    string url,
    out XmlMap importMap,
    Object overwrite,
    Object destination
)

Parâmetros

url
Tipo: System.String
Um localizador recursos uniforme (URL) ou um caminho de (UNC) a convenção de nomenclatura de uniforme para um arquivo de dados XML.

importMap
Tipo: Microsoft.Office.Interop.Excel.XmlMap%
O mapa de esquema a ser aplicado durante a importação do arquivo.

overwrite
Tipo: System.Object
Caso um valor não seja especificado para o parâmetro Destination, esse parâmetro especifica se é necessário substituir dados que foram mapeados para o mapa de esquema especificado no parâmetro ImportMap.Defina como true para substituir os dados ou false para anexar os novos dados aos dados existentes.O valor padrão é true.Caso um valor seja especificado para o parâmetro Destination, esse parâmetro especifica se é necessário substituir os dados existentes.Defina como true para substituir dados existentes ou false para cancelar a importação caso os dados precisem ser substituídos.O valor padrão é true.

destination
Tipo: System.Object
Os dados serão importados em uma nova lista XML em Range especificado.

Valor de retorno

Tipo: Microsoft.Office.Interop.Excel.XlXmlImportResult
Um dos valores de XlXmlImportResult.

Comentários

Não especifique um valor para o parâmetro Destination caso você queira importar dados para um mapeamento existente.

As seguintes condições farão esse método gerar erros de tempo de execução:

Os dados XML especificados contêm erros de sintaxe.
O processo de importação foi cancelado porque os dados especificados não podem caber na planilha.

Use o método de XmlImportXml para importar os dados XML que foram previamente carregados na memória.

Parâmetros Opcionais

Para obter informações sobre parâmetros opcionais, consulte Parâmetros opcionais em soluções do Office.

Exemplos

O exemplo de código a seguir cria XmlMap baseado em um esquema gerado de DataSet, grava DataSet a um arquivo XML, e usa o método de XmlImport para gravar os dados no arquivo XML a um intervalo na planilha Sheet1.

Este exemplo destina-se a uma personalização no nível de documento.

Private Sub WorkbookXmlImport()

    ' 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 and write the XML to a file.
    Dim xmlMap1 As Excel.XmlMap = Me.XmlMaps.Add(ds.GetXmlSchema(), _
        "NewDataSet")
    ds.WriteXml("C:\Customers.xml")

    ' Import the XML from the file.
    Dim range1 As Excel.Range = Globals.Sheet1.Range("A1")
    Me.XmlImport("C:\Customers.xml", xmlMap1, True, _
        range1)
End Sub

private void WorkbookXmlImport()
{
    // 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 and write the XML to a file.
    Excel.XmlMap xmlMap1 = this.XmlMaps.Add(ds.GetXmlSchema(),
        "NewDataSet");
    ds.WriteXml(@"C:\Customers.xml");

    // Import the XML from the file.
    Excel.Range range1 = Globals.Sheet1.Range["A1"];
    this.XmlImport(@"C:\Customers.xml", out xmlMap1, true, range1);
}

Segurança do .NET Framework

Confiança total para o chamador imediato. O membro não pode ser usado por código parcialmente confiável. Para obter mais informações, consulte Usando bibliotecas de código parcialmente confiável.

Consulte também

Referência

WorkbookBase Classe

Namespace Microsoft.Office.Tools.Excel

Compartilhar via