XDocument.Load Método
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
Cria um novo XDocument de um arquivo especificado por um URI, de um TextReaderou de um XmlReader.
Sobrecargas
| Nome | Description |
|---|---|
| Load(Stream) |
Cria uma nova XDocument instância usando o fluxo especificado. |
| Load(TextReader) |
Cria um novo XDocument de um TextReader. |
| Load(String) |
Cria um novo XDocument de um arquivo. |
| Load(XmlReader) | |
| Load(Stream, LoadOptions) |
Cria uma nova XDocument instância usando o fluxo especificado, preservando opcionalmente o espaço em branco, definindo o URI base e retendo informações de linha. |
| Load(TextReader, LoadOptions) |
Cria um novo XDocument de um TextReader, opcionalmente preservando o espaço em branco, definindo o URI base e retendo informações de linha. |
| Load(String, LoadOptions) |
Cria um novo XDocument de um arquivo, preservando opcionalmente o espaço em branco, definindo o URI base e retendo informações de linha. |
| Load(XmlReader, LoadOptions) |
Carrega um XDocument de um XmlReader, opcionalmente, definindo o URI base e retendo informações de linha. |
Comentários
Usando uma das sobrecargas desse método, você pode carregar um XDocument de um arquivo, um TextReaderou um XmlReader.
Para criar uma cadeia XDocument de caracteres que contém XML, use Parse.
Load(Stream)
Cria uma nova XDocument instância usando o fluxo especificado.
public:
static System::Xml::Linq::XDocument ^ Load(System::IO::Stream ^ stream);
public static System.Xml.Linq.XDocument Load(System.IO.Stream stream);
static member Load : System.IO.Stream -> System.Xml.Linq.XDocument
Public Shared Function Load (stream As Stream) As XDocument
Parâmetros
- stream
- Stream
O fluxo que contém os dados XML.
Retornos
Um XDocument objeto que lê os dados contidos no fluxo.
Comentários
Se você quiser controlar as opções de carga, use a Load sobrecarga que usa LoadOptions como parâmetro.
A funcionalidade de carregamento do LINQ to XML é criada.XmlReader Portanto, você pode capturar quaisquer exceções geradas pelos XmlReader.Create métodos de sobrecarga e pelos XmlReader métodos que leem e analisam o documento.
Se você precisar modificar XmlReaderSettings, siga estas etapas:
Crie um XmlReader chamando uma das Create sobrecargas que tomam XmlReaderSettings como parâmetro.
Passe para XmlReader uma das Load sobrecargas que XDocument usa XmlReader como parâmetro.
Aplica-se a
Load(TextReader)
Cria um novo XDocument de um TextReader.
public:
static System::Xml::Linq::XDocument ^ Load(System::IO::TextReader ^ textReader);
public static System.Xml.Linq.XDocument Load(System.IO.TextReader textReader);
static member Load : System.IO.TextReader -> System.Xml.Linq.XDocument
Public Shared Function Load (textReader As TextReader) As XDocument
Parâmetros
- textReader
- TextReader
Um TextReader que contém o conteúdo do XDocument.
Retornos
Um XDocument que contém o conteúdo do especificado TextReader.
Exemplos
O exemplo a seguir cria um documento de um StringReader.
TextReader tr = new StringReader("<Root>Content</Root>");
XDocument doc = XDocument.Load(tr);
Console.WriteLine(doc);
Dim tr As TextReader = New StringReader("<Root>Content</Root>")
Dim doc As XDocument = XDocument.Load(tr)
Console.WriteLine(doc)
Este exemplo produz a seguinte saída:
<Root>Content</Root>
Comentários
A funcionalidade de carregamento do LINQ to XML é criada.XmlReader Portanto, você pode capturar quaisquer exceções geradas pelos XmlReader.Create métodos de sobrecarga e pelos XmlReader métodos que leem e analisam o documento.
Confira também
- Parse
- Save
- WriteTo(XmlWriter)
- Visão geral de LINQ to XML
- Consultar um XDocument vs. consultar um XElement
Aplica-se a
Load(String)
Cria um novo XDocument de um arquivo.
public:
static System::Xml::Linq::XDocument ^ Load(System::String ^ uri);
public static System.Xml.Linq.XDocument Load(string uri);
static member Load : string -> System.Xml.Linq.XDocument
Public Shared Function Load (uri As String) As XDocument
Parâmetros
- uri
- String
Uma cadeia de caracteres de URI que faz referência ao arquivo a ser carregado em um novo XDocument.
Retornos
Um XDocument que contém o conteúdo do arquivo especificado.
Exemplos
O exemplo a seguir mostra como carregar um XDocument de um arquivo.
Este exemplo usa o seguinte documento XML:
Arquivo XML de exemplo: ordem de compra típica (LINQ to XML)
XDocument doc = XDocument.Load("PurchaseOrder.xml");
Console.WriteLine(doc);
Dim doc As XDocument = XDocument.Load("PurchaseOrder.xml")
Console.WriteLine(doc)
Este exemplo produz a seguinte saída:
<PurchaseOrder PurchaseOrderNumber="99503" OrderDate="1999-10-20">
<Address Type="Shipping">
<Name>Ellen Adams</Name>
<Street>123 Maple Street</Street>
<City>Mill Valley</City>
<State>CA</State>
<Zip>10999</Zip>
<Country>USA</Country>
</Address>
<Address Type="Billing">
<Name>Tai Yee</Name>
<Street>8 Oak Avenue</Street>
<City>Old Town</City>
<State>PA</State>
<Zip>95819</Zip>
<Country>USA</Country>
</Address>
<DeliveryNotes>Please leave packages in shed by driveway.</DeliveryNotes>
<Items>
<Item PartNumber="872-AA">
<ProductName>Lawnmower</ProductName>
<Quantity>1</Quantity>
<USPrice>148.95</USPrice>
<Comment>Confirm this is electric</Comment>
</Item>
<Item PartNumber="926-AA">
<ProductName>Baby Monitor</ProductName>
<Quantity>2</Quantity>
<USPrice>39.98</USPrice>
<ShipDate>1999-05-21</ShipDate>
</Item>
</Items>
</PurchaseOrder>
Comentários
Esse método usa um subjacente XmlReader para ler o XML em uma árvore XML.
Use Parse para criar uma cadeia XDocument de caracteres que contenha XML.
A funcionalidade de carregamento do LINQ to XML é criada.XmlReader Portanto, você pode capturar quaisquer exceções geradas pelos XmlReader.Create métodos de sobrecarga e pelos XmlReader métodos que leem e analisam o documento.
Confira também
- Parse
- Save
- WriteTo(XmlWriter)
- Visão geral de LINQ to XML
- Consultar um XDocument vs. consultar um XElement
Aplica-se a
Load(XmlReader)
public:
static System::Xml::Linq::XDocument ^ Load(System::Xml::XmlReader ^ reader);
public static System.Xml.Linq.XDocument Load(System.Xml.XmlReader reader);
static member Load : System.Xml.XmlReader -> System.Xml.Linq.XDocument
Public Shared Function Load (reader As XmlReader) As XDocument
Parâmetros
Retornos
Um XDocument que contém o conteúdo do especificado XmlReader.
Exemplos
O exemplo a seguir cria um documento DOM, cria um XmlNodeReader documento do DOM, cria um XDocument uso do XmlNodeReader.
// Create a DOM document with some content.
XmlDocument doc = new XmlDocument();
XmlElement child = doc.CreateElement("Child");
child.InnerText = "child contents";
XmlElement root = doc.CreateElement("Root");
root.AppendChild(child);
doc.AppendChild(root);
// create a reader and move to the content
using (XmlNodeReader nodeReader = new XmlNodeReader(doc)) {
// the reader must be in the Interactive state in order to
// create a LINQ to XML tree from it.
nodeReader.MoveToContent();
XDocument xRoot = XDocument.Load(nodeReader);
Console.WriteLine(xRoot);
}
' Create a DOM document with some content.
Dim doc As XmlDocument = New XmlDocument()
Dim child As XmlElement = doc.CreateElement("Child")
child.InnerText = "child contents"
Dim root As XmlElement = doc.CreateElement("Root")
root.AppendChild(child)
doc.AppendChild(root)
' create a reader and move to the content
Using nodeReader = New XmlNodeReader(doc)
' the reader must be in the Interactive state in order to
' create a LINQ to XML tree from it.
nodeReader.MoveToContent()
Dim xRoot As XDocument = XDocument.Load(nodeReader)
Console.WriteLine(xRoot)
End Using
Este exemplo produz a seguinte saída:
<Root>
<Child>child contents</Child>
</Root>
Comentários
Um possível uso para esse método é criar uma cópia de um documento DOM em uma árvore LINQ to XML. Para fazer isso, você cria um XmlNodeReader documento do DOM e, em seguida, usa o XmlNodeReader para criar um XDocument.
A funcionalidade de carregamento do LINQ to XML é criada.XmlReader Portanto, você pode capturar quaisquer exceções geradas pelos XmlReader.Create métodos de sobrecarga e pelos XmlReader métodos que leem e analisam o documento.
Confira também
- Parse
- Save
- WriteTo(XmlWriter)
- Visão geral de LINQ to XML
- Consultar um XDocument vs. consultar um XElement
Aplica-se a
Load(Stream, LoadOptions)
Cria uma nova XDocument instância usando o fluxo especificado, preservando opcionalmente o espaço em branco, definindo o URI base e retendo informações de linha.
public:
static System::Xml::Linq::XDocument ^ Load(System::IO::Stream ^ stream, System::Xml::Linq::LoadOptions options);
public static System.Xml.Linq.XDocument Load(System.IO.Stream stream, System.Xml.Linq.LoadOptions options);
static member Load : System.IO.Stream * System.Xml.Linq.LoadOptions -> System.Xml.Linq.XDocument
Public Shared Function Load (stream As Stream, options As LoadOptions) As XDocument
Parâmetros
- stream
- Stream
O fluxo que contém os dados XML.
- options
- LoadOptions
Um LoadOptions que especifica se as informações de linha e URI base devem ser carregadas.
Retornos
Um XDocument objeto que lê os dados contidos no fluxo.
Comentários
A funcionalidade de carregamento do LINQ to XML é criada.XmlReader Portanto, você pode capturar quaisquer exceções geradas pelos XmlReader.Create métodos de sobrecarga e pelos XmlReader métodos que leem e analisam o documento.
Se você precisar modificar XmlReaderSettings, siga estas etapas:
Crie um XmlReader chamando uma das Create sobrecargas que usa XmlReaderSettings como parâmetro.
Passe para XmlReader uma das Load sobrecargas que XDocument usa XmlReader como parâmetro.
Aplica-se a
Load(TextReader, LoadOptions)
Cria um novo XDocument de um TextReader, opcionalmente preservando o espaço em branco, definindo o URI base e retendo informações de linha.
public:
static System::Xml::Linq::XDocument ^ Load(System::IO::TextReader ^ textReader, System::Xml::Linq::LoadOptions options);
public static System.Xml.Linq.XDocument Load(System.IO.TextReader textReader, System.Xml.Linq.LoadOptions options);
static member Load : System.IO.TextReader * System.Xml.Linq.LoadOptions -> System.Xml.Linq.XDocument
Public Shared Function Load (textReader As TextReader, options As LoadOptions) As XDocument
Parâmetros
- textReader
- TextReader
Um TextReader que contém o conteúdo do XDocument.
- options
- LoadOptions
Um LoadOptions que especifica o comportamento do espaço em branco e se as informações de linha e URI base devem ser carregadas.
Retornos
Um XDocument que contém o XML que foi lido do especificado TextReader.
Exemplos
O exemplo a seguir cria um documento de um StringReader.
TextReader sr;
int whiteSpaceNodes;
sr = new StringReader("<Root> <Child> </Child> </Root>");
XDocument xmlTree1 = XDocument.Load(sr, LoadOptions.None);
sr.Close();
whiteSpaceNodes = xmlTree1
.Element("Root")
.DescendantNodesAndSelf()
.OfType<XText>()
.Where(tNode => tNode.ToString().Trim().Length == 0)
.Count();
Console.WriteLine("Count of white space nodes (not preserving whitespace): {0}", whiteSpaceNodes);
sr = new StringReader("<Root> <Child> </Child> </Root>");
XDocument xmlTree2 = XDocument.Load(sr, LoadOptions.PreserveWhitespace);
sr.Close();
whiteSpaceNodes = xmlTree2
.Element("Root")
.DescendantNodesAndSelf()
.OfType<XText>()
.Where(tNode => tNode.ToString().Trim().Length == 0)
.Count();
Console.WriteLine("Count of white space nodes (preserving whitespace): {0}", whiteSpaceNodes);
Dim sr As TextReader
Dim whiteSpaceNodes As Integer
sr = New StringReader("<Root> <Child> </Child> </Root>")
Dim xmlTree1 As XDocument = XDocument.Load(sr, LoadOptions.None)
sr.Close()
whiteSpaceNodes = xmlTree1 _
.Element("Root") _
.DescendantNodesAndSelf() _
.OfType(Of XText)() _
.Where(Function(ByVal tNode As XNode) tNode. _
ToString().Trim().Length = 0).Count()
Console.WriteLine("Count of white space nodes (not preserving whitespace): {0}", whiteSpaceNodes)
sr = New StringReader("<Root> <Child> </Child> </Root>")
Dim xmlTree2 As XDocument = XDocument.Load(sr, LoadOptions.PreserveWhitespace)
sr.Close()
whiteSpaceNodes = xmlTree2 _
.Element("Root") _
.DescendantNodesAndSelf() _
.OfType(Of XText)() _
.Where(Function(ByVal tNode As XNode) tNode. _
ToString().Trim().Length = 0).Count()
Console.WriteLine("Count of white space nodes (preserving whitespace): {0}", whiteSpaceNodes)
Este exemplo produz a seguinte saída:
Count of white space nodes (not preserving whitespace): 0
Count of white space nodes (preserving whitespace): 3
Comentários
Se o XML de origem estiver recuado, definir o PreserveWhitespace sinalizador options fará com que o leitor leia todo o espaço em branco no XML de origem. Nós de tipo XText são criados para espaço em branco significativo e insignificante.
Se o XML de origem estiver recuado, não definir o PreserveWhitespace sinalizador options fará com que o leitor ignore todo o espaço em branco insignificante no XML de origem. A árvore XML é criada sem nenhum nó de texto para espaço em branco insignificante.
Se o XML de origem não estiver recuado, a definição do PreserveWhitespace sinalizador options não terá efeito. Espaço em branco significativo ainda é preservado e não há intervalos de espaço em branco insignificante que possam causar a criação de mais nós de texto de espaço em branco.
Para obter mais informações, consulte Preservar o espaço em branco ao carregar ou analisar XML e preservar o espaço em branco durante a serialização.
Use Parse para criar uma cadeia XElement de caracteres que contenha XML.
A configuração SetBaseUri não é válida ao carregar de um TextReader.
Há uma penalidade de desempenho se você definir o SetLineInfo sinalizador.
As informações de linha são precisas imediatamente após o carregamento do documento XML. Se você modificar a árvore XML depois de carregar o documento, as informações de linha poderão ficar sem sentido.
A funcionalidade de carregamento do LINQ to XML é criada.XmlReader Portanto, você pode capturar quaisquer exceções geradas pelos XmlReader.Create métodos de sobrecarga e pelos XmlReader métodos que leem e analisam o documento.
Confira também
- Parse
- Save
- WriteTo(XmlWriter)
- Visão geral de LINQ to XML
- Consultar um XDocument vs. consultar um XElement
Aplica-se a
Load(String, LoadOptions)
Cria um novo XDocument de um arquivo, preservando opcionalmente o espaço em branco, definindo o URI base e retendo informações de linha.
public:
static System::Xml::Linq::XDocument ^ Load(System::String ^ uri, System::Xml::Linq::LoadOptions options);
public static System.Xml.Linq.XDocument Load(string uri, System.Xml.Linq.LoadOptions options);
static member Load : string * System.Xml.Linq.LoadOptions -> System.Xml.Linq.XDocument
Public Shared Function Load (uri As String, options As LoadOptions) As XDocument
Parâmetros
- uri
- String
Uma cadeia de caracteres de URI que faz referência ao arquivo a ser carregado em um novo XDocument.
- options
- LoadOptions
Um LoadOptions que especifica o comportamento do espaço em branco e se as informações de linha e URI base devem ser carregadas.
Retornos
Um XDocument que contém o conteúdo do arquivo especificado.
Exemplos
O exemplo a seguir mostra como carregar um XDocument de um arquivo.
Este exemplo usa o seguinte documento XML:
Arquivo XML de exemplo: ordem de compra típica (LINQ to XML)
XDocument doc1 = XDocument.Load("PurchaseOrder.xml", LoadOptions.None);
Console.WriteLine("nodes if not preserving whitespace: {0}", doc1.DescendantNodes().Count());
XDocument doc2 = XDocument.Load("PurchaseOrder.xml", LoadOptions.PreserveWhitespace);
Console.WriteLine("nodes if preserving whitespace: {0}", doc2.DescendantNodes().Count());
Dim doc1 As XDocument = XDocument.Load("PurchaseOrder.xml", LoadOptions.None)
Console.WriteLine("nodes if not preserving whitespace: {0}", doc1.DescendantNodes().Count())
Dim doc2 As XDocument = XDocument.Load("PurchaseOrder.xml", LoadOptions.PreserveWhitespace)
Console.WriteLine("nodes if preserving whitespace: {0}", doc2.DescendantNodes().Count())
Este exemplo produz a seguinte saída:
nodes if not preserving whitespace: 48
nodes if preserving whitespace: 82
Comentários
Se o XML de origem estiver recuado, definir o PreserveWhitespace sinalizador options fará com que o leitor leia todo o espaço em branco no XML de origem. Nós de tipo XText são criados para espaço em branco significativo e insignificante.
Se o XML de origem estiver recuado, não definir o PreserveWhitespace sinalizador options fará com que o leitor ignore todo o espaço em branco insignificante no XML de origem. A árvore XML é criada sem nenhum nó de texto para espaço em branco insignificante.
Se o XML de origem não estiver recuado, a definição do PreserveWhitespace sinalizador options não terá efeito. Espaço em branco significativo ainda é preservado e não há intervalos de espaço em branco insignificante que possam causar a criação de mais nós de texto de espaço em branco.
Para obter mais informações, consulte Preservar o espaço em branco ao carregar ou analisar XML e preservar o espaço em branco durante a serialização.
Use Parse para criar uma cadeia XDocument de caracteres que contenha XML.
Há uma penalidade de desempenho se você definir o SetBaseUri e os SetLineInfo sinalizadores.
O URI base e as informações de linha são precisos imediatamente após o carregamento do documento XML. Se você modificar a árvore XML depois de carregar o documento, o URI base e as informações de linha poderão ficar sem sentido.
A funcionalidade de carregamento do LINQ to XML é criada.XmlReader Portanto, você pode capturar quaisquer exceções geradas pelos XmlReader.Create métodos de sobrecarga e pelos XmlReader métodos que leem e analisam o documento.
Confira também
- Parse
- Save
- WriteTo(XmlWriter)
- Visão geral de LINQ to XML
- Consultar um XDocument vs. consultar um XElement
Aplica-se a
Load(XmlReader, LoadOptions)
public:
static System::Xml::Linq::XDocument ^ Load(System::Xml::XmlReader ^ reader, System::Xml::Linq::LoadOptions options);
public static System.Xml.Linq.XDocument Load(System.Xml.XmlReader reader, System.Xml.Linq.LoadOptions options);
static member Load : System.Xml.XmlReader * System.Xml.Linq.LoadOptions -> System.Xml.Linq.XDocument
Public Shared Function Load (reader As XmlReader, options As LoadOptions) As XDocument
Parâmetros
- options
- LoadOptions
Um LoadOptions que especifica se as informações de linha e URI base devem ser carregadas.
Retornos
Um XDocument que contém o XML que foi lido do especificado XmlReader.
Exemplos
O exemplo a seguir carrega as informações de linha que ela carrega da XmlReader. Em seguida, ele imprime as informações de linha.
string markup =
@"<Root>
<Child>
<GrandChild/>
</Child>
</Root>";
// Create a reader and move to the content.
using (XmlReader nodeReader = XmlReader.Create(new StringReader(markup)))
{
// the reader must be in the Interactive state in order to
// Create a LINQ to XML tree from it.
nodeReader.MoveToContent();
XDocument xRoot = XDocument.Load(nodeReader, LoadOptions.SetLineInfo);
Console.WriteLine("{0}{1}{2}",
"Element Name".PadRight(20),
"Line".PadRight(5),
"Position");
Console.WriteLine("{0}{1}{2}",
"------------".PadRight(20),
"----".PadRight(5),
"--------");
foreach (XElement e in xRoot.Elements("Root").DescendantsAndSelf())
Console.WriteLine("{0}{1}{2}",
("".PadRight(e.Ancestors().Count() * 2) + e.Name).PadRight(20),
((IXmlLineInfo)e).LineNumber.ToString().PadRight(5),
((IXmlLineInfo)e).LinePosition);
}
Dim markup As String = _
"<Root>" & Environment.NewLine & _
" <Child>" & Environment.NewLine & _
" <GrandChild/>" & Environment.NewLine & _
" </Child>" & Environment.NewLine & _
"</Root>"
' Create a reader and move to the content.
Using nodeReader As XmlReader = XmlReader.Create(New StringReader(markup))
' The reader must be in the Interactive state in order to
' create a LINQ to XML tree from it.
nodeReader.MoveToContent()
Dim xRoot As XDocument = XDocument.Load(nodeReader, LoadOptions.SetLineInfo)
Console.WriteLine("{0}{1}{2}", _
"Element Name".PadRight(20), _
"Line".PadRight(5), _
"Position")
Console.WriteLine("{0}{1}{2}", _
"------------".PadRight(20), _
"----".PadRight(5), _
"--------")
For Each e As XElement In xRoot.Elements("Root").DescendantsAndSelf()
Console.WriteLine("{0}{1}{2}", _
("".PadRight(e.Ancestors().Count() * 2) & e.Name.ToString()).PadRight(20), _
(DirectCast(e, IXmlLineInfo)).LineNumber.ToString().PadRight(5), _
(DirectCast(e, IXmlLineInfo)).LinePosition)
Next
End Using
Este exemplo produz a seguinte saída:
Element Name Line Position
------------ ---- --------
Root 1 2
Child 2 6
GrandChild 3 10
Comentários
Criando um XmlNodeReader documento do DOM e, em seguida, usando o XmlNodeReader para criar um XElement, esse método pode ser usado para criar uma cópia de um documento DOM em uma árvore LINQ to XML.
Use Parse para criar uma cadeia XDocument de caracteres que contenha XML.
A configuração PreserveWhitespace não é válida ao carregar de um XmlReader. O XmlReader será configurado para ler o espaço em branco ou não. A árvore LINQ to XML será preenchida com os nós de espaço em branco que o leitor apresenta. Esse será o comportamento, independentemente de estar PreserveWhitespace definido ou não.
Pode XmlReader ter um URI de base válido ou não. Se você definir SetBaseUri, o URI base será definido na árvore XML do URI base que é relatado pelo XmlReader.
Pode XmlReader ter uma informação de linha válida ou não. Se você definir SetLineInfo, as informações de linha serão definidas na árvore XML a partir das informações de linha relatadas pelo XmlReader.
Há uma penalidade de desempenho se você definir o SetLineInfo sinalizador.
As informações de linha são precisas imediatamente após o carregamento do documento XML. Se você modificar a árvore XML depois de carregar o documento, as informações de linha poderão ficar sem sentido.
A funcionalidade de carregamento do LINQ to XML é criada.XmlReader Portanto, você pode capturar quaisquer exceções geradas pelos XmlReader.Create métodos de sobrecarga e pelos XmlReader métodos que leem e analisam o documento.