Literal de elemento XML (Visual Basic)
Literal que representa un objeto XElement.
<name [ attributeList ] />
-or-
<name [ attributeList ] > [ elementContents ] </[ name ]>
Elementos
Término |
Definición |
< |
Obligatorio.Abre la etiqueta del elemento de inicio. |
name |
Obligatorio.Nombre del elemento.Tiene uno de los siguientes formatos:
ParteDescripción
ePrefix Opcional.Prefijo de espacio de nombres XML del elemento.Debe ser un espacio de nombres XML global que se define con una instrucción Imports en el archivo o en el nivel del proyecto; o bien, un espacio de nombres XML local que se define en este elemento o en un elemento primario.
eName Obligatorio.Nombre del elemento.Tiene uno de los siguientes formatos:
|
attributeList |
Opcional.Lista de atributos declarados en el literal. attribute [ attribute ... ] Cada attribute tiene una de las sintaxis siguientes:
ParteDescripción
aPrefix Opcional.Prefijo de espacio de nombres XML del atributo.Debe ser un espacio de nombres XML global que se define con una instrucción Imports o un espacio de nombres XML local que se define en este elemento o un elemento primario.
aName Obligatorio.Nombre del atributo.Tiene uno de los siguientes formatos:
aValue Opcional.Valor del atributo.Tiene uno de los siguientes formatos:
|
/> |
Opcional.Indica que el elemento es un elemento vacío, sin contenido. |
> |
Obligatorio.Finaliza la etiqueta del elemento inicial o vacío. |
elementContents |
Opcional.Contenido del elemento. content [ content ... ] Cada content puede ser uno de los siguientes:
|
</[name]> |
Opcional.Representa la etiqueta de cierre del elemento.No se permite el parámetro name opcional cuando es el resultado de una expresión incrustada. |
Valor devuelto
Un objeto XElement.
Comentarios
Puede utilizar la sintaxis del literal de elemento XML para crear objetos XElement en el código.
[!NOTA]
Un literal XML puede abarcar varias líneas sin usar caracteres de continuación de línea.Esta característica permite copiar el contenido de un documento XML y pegarlo directamente en un programa de Visual Basic.
Las expresiones incrustadas con el formato <%= exp %> permiten agregar información dinámica a un literal de elemento XML.Para obtener más información, vea Expresiones incrustadas (Visual Basic).
El compilador de Visual Basic convierte el literal del elemento XML en llamadas al constructor XElement y, si es necesario, al constructor XAttribute.
Espacios de nombres XML
Los prefijos de espacio de nombres XML son útiles cuando se deben crear literales XML con elementos desde el mismo espacio de nombres muchas veces en código.Puede utilizar los prefijos del espacio de nombres XML globales, que se definen utilizando la instrucción Imports o los prefijos locales, que se definen mediante la sintaxis de atributo xmlns:xmlPrefix= "xmlNamespace".Para obtener más información, vea Imports (Instrucción, Espacio de nombres XML).
De acuerdo con las reglas del ámbito para espacios de nombres XML, tienen prioridad los prefijos local sobre los globales.Sin embargo, si un literal XML define un espacio de nombres XML, ese espacio de nombres no está disponible para las expresiones que aparecen en una expresión incrustada.La expresión incrustada puede tener acceso a sólo el espacio de nombres XML global.
El compilador de Visual Basic convierte cada espacio de nombres XML global que usa un literal XML en una definición de espacio de nombres local en el código generado.Los espacios de nombres XML globales que no se usan no aparecen en el código generado.
Ejemplo
El ejemplo siguiente muestra cómo crear un elemento XML simple que tiene dos elementos vacíos anidados.
Dim test1 As XElement =
<outer>
<inner1></inner1>
<inner2/>
</outer>
Console.WriteLine(test1)
El ejemplo muestra el texto siguiente.Observe que el literal conserva la estructura de los elementos vacíos.
<outer>
<inner1></inner1>
<inner2 />
</outer>
El ejemplo siguiente muestra cómo utilizar las expresiones incrustadas para asignar un nombre a un elemento y crear atributos.
Dim elementType = "book"
Dim authorName = "My Author"
Dim attributeName1 = "year"
Dim attributeValue1 = 1999
Dim attributeName2 = "title"
Dim attributeValue2 = "My Book"
Dim book As XElement =
<<%= elementType %>
isbn="1234"
author=<%= authorName %>
<%= attributeName1 %>=<%= attributeValue1 %>
<%= New XAttribute(attributeName2, attributeValue2) %>
/>
Console.WriteLine(book)
Este código muestra el texto siguiente:
<book isbn="1234" author="My Author" year="1999" title="My Book" />
En el ejemplo siguiente se declara ns como prefijo de espacio de nombres XML.Después usa el prefijo del espacio de nombres para crear un literal XML y muestra el formato final del elemento.
' Place Imports statements at the top of your program.
Imports <xmlns:ns="http://SomeNamespace">
Class TestClass1
Shared Sub TestPrefix()
' Create test using a global XML namespace prefix.
Dim inner2 = <ns:inner2/>
Dim test =
<ns:outer>
<ns:middle xmlns:ns="http://NewNamespace">
<ns:inner1/>
<%= inner2 %>
</ns:middle>
</ns:outer>
' Display test to see its final form.
Console.WriteLine(test)
End Sub
End Class
Este código muestra el texto siguiente:
<ns:outer xmlns:ns="http://SomeNamespace">
<ns:middle xmlns:ns="http://NewNamespace">
<ns:inner1 />
<inner2 xmlns="http://SomeNamespace" />
</ns:middle>
</ns:outer>
Observe que el compilador convirtió el prefijo del espacio de nombres XML global en una definición de prefijo del espacio de nombres XML.El elemento <ns:middle> vuelve a definir el prefijo del espacio de nombres XML para el elemento <ns:inner1>.Sin embargo, el elemento < ns:inner2 > usa el espacio de nombres definido por la instrucción Imports.
Vea también
Referencia
Literal de comentario XML (Visual Basic)
Literal de CDATA XML (Visual Basic)
Imports (Instrucción, Espacio de nombres XML)
Conceptos
Nombres de atributos y elementos XML declarados (Visual Basic)
Expresiones incrustadas (Visual Basic)