Método WorkbookBase.XmlImportXml
Importa um fluxo de dados XML que foi previamente carregado na memória.
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 XmlImportXml ( _
data As String, _
<OutAttribute> ByRef importMap As XmlMap, _
overwrite As Object, _
destination As Object _
) As XlXmlImportResult
public XlXmlImportResult XmlImportXml(
string data,
out XmlMap importMap,
Object overwrite,
Object destination
)
Parâmetros
- data
Tipo: System.String
Os dados a serem importados.
- importMap
Tipo: Microsoft.Office.Interop.Excel.XmlMap%
O mapa de esquema para aplicar ao importar o arquivo.
- overwrite
Tipo: System.Object
Se não for especificado um valor para o Destination parâmetro e, em seguida, este parâmetro especifica se deve ou não sobrescrever os dados que foi mapeados para o mapa de esquema especificado na ImportMap parâmetro.Definido como true para sobrescrever os dados ou false para acrescentar novos dados para os dados existentes.O valor padrão é true.Se um valor for especificado para o Destination parâmetro, e em seguida, este parâmetro especifica se ou não substituir dados existentes.Definido como true para substituir dados existentes ou false para cancelar a importação, se os dados precisarem ser substituídos.O valor padrão é true.
- destination
Tipo: System.Object
Os dados serão importados para uma nova lista XML na Range especificado.
Valor de retorno
Tipo: Microsoft.Office.Interop.Excel.XlXmlImportResult
Dentre as XlXmlImportResult valores.
Comentários
Não especificar um valor para o Destination parâmetro se desejar importar dados de um mapeamento existente.
As seguintes condições fará com que esse método para 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 cabem na planilha.
Use o XmlImport método para importar um arquivo de dados XML na pasta de trabalho atual.
Optional Parameters
Para obter informações sobre os parâmetros opcionais, consulte Parâmetros opcionais em soluções do Office.
Exemplos
O exemplo de código a seguir demonstra como importar dados XML para uma pasta de trabalho. O exemplo cria um DataSet de cliente nomeia e adiciona um XmlMap com base no esquema XML para o DataSet para o XmlMaps coleção de pasta de trabalho atual. O exemplo, em seguida, chama o XmlImportXml método para importar os dados de planilha Sheet1. Quando o XmlImportXml método é chamado, o BeforeXmlImport manipulador de eventos solicita ao usuário para continuar ou cancelar a importação de XML e o AfterXmlImport manipulador de eventos que indica se o XML foi importado com êxito.
Este exemplo é para uma personalização em nível de documento.
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
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", missing];
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.");
}
}
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áveis.