Trabajar con espacios de nombre globales (Visual Basic) (LINQ to XML)

Actualización: November 2007

Una de las características clave de los literales XML de Visual Basic 2008 es la capacidad de declarar espacios de nombres XML mediante la instrucción Imports. Mediante esta función puede declarar un espacio de nombres XML que usa un prefijo o bien puede declarar un espacio de nombres XML predeterminado.

Esta capacidad es útil en dos situaciones. En primer lugar, los espacios de nombres declarados en los literales XML no se mantienen en expresiones incrustadas. La declaración de espacios de nombres globales reduce la cantidad de trabajo que tiene que realizar para usar expresiones incrustadas con espacios de nombres. En segundo lugar, debe declarar espacios de nombres globales para usar espacios de nombres con propiedades XML.

Puede declarar espacios de nombres globales en el nivel del proyecto. También puede declarar espacios de nombres globales en el nivel del módulo, lo que invalida los espacios de nombres globales de nivel de proyecto. Finalmente, puede invalidad los espacios de nombres globales en un literal XML.

Cuando se utilizan literales XML o propiedades XML que están en espacios de nombres declarados globalmente, se puede ver el nombre expandido de las propiedades o los literales XML desplazándose sobre ellos en Visual Studio. Verá el nombre expandido en una información sobre herramientas.

Puede obtener un objeto XNamespace que se corresponde con un espacio de nombres global usando el método GetXmlNamespace.

Ejemplos de espacios de nombres globales

El siguiente ejemplo declara un espacio de nombres global predeterminado usando la instrucción Imports y después usa un literal XML para inicializar un objeto XElement en ese espacio de nombres:

Imports <xmlns="https://www.adventure-works.com">

Module Module1
    Sub Main()
        Dim root As XElement = <Root/>
        Console.WriteLine(root)
    End Sub
End Module

Este ejemplo genera el siguiente resultado:

<Root xmlns="https://www.adventure-works.com" />

El siguiente ejemplo declara un espacio de nombres global con un prefijo y después usa un literal XML para inicializar un elemento:

Imports <xmlns:aw="https://www.adventure-works.com">

Module Module1
    Sub Main()
        Dim root As XElement = <aw:Root/>
        Console.WriteLine(root)
    End Sub
End Module

Este ejemplo genera el siguiente resultado:

<aw:Root xmlns:aw="https://www.adventure-works.com" />

Espacios de nombres globales y expresiones incrustadas

Los espacios de nombres que se declaran en los literales XML no se mantienen en expresiones incrustadas. El siguiente ejemplo declara un espacio de nombres predeterminado. A continuación usa una expresión incrustada para el elemento Child.

Dim root As XElement = _
    <Root xmlns="https://www.adventure-works.com">
        <%= <Child/> %>
    </Root>
Console.WriteLine(root)

Este ejemplo genera el siguiente resultado:

<Root xmlns="https://www.adventure-works.com">
  <Child  />
</Root>

Como puede ver, el XML resultante incluye una declaración de un espacio de nombres predeterminado de forma que el elemento Child no esté en ningún espacio de nombres.

Puede volver a declarar el espacio de nombres en la expresión incrustada de ka siguiente manera:

Dim root As XElement = _
    <Root xmlns="https://www.adventure-works.com">
        <%= <Child xmlns="https://www.adventure-works.com"/> %>
    </Root>
Console.WriteLine(root)

Este ejemplo genera el siguiente resultado:

<Root xmlns="https://www.adventure-works.com">
  <Child xmlns="https://www.adventure-works.com" />
</Root>

Sin embargo, esto es más complicado que usar el espacio de nombres global predeterminado, que es un enfoque más adecuado. Con el espacio de nombres global predeterminado, puede utilizar literales XML sin declarar espacios de nombres. El XML resultante estará en el espacio de nombres predeterminado declarado globalmente.

Imports <xmlns="https://www.adventure-works.com">

Module Module1
    Sub Main()
        Dim root As XElement = <Root>
                                   <%= <Child/> %>
                               </Root>
        Console.WriteLine(root)
    End Sub
End Module

Este ejemplo genera el siguiente resultado:

<Root xmlns="https://www.adventure-works.com">
  <Child />
</Root>

Usar espacios de nombres con propiedades XML

Si está trabajando con un árbol XML que está en un espacio de nombres y utiliza propiedades XML, debe usar un espacio de nombres global para que las propiedades XML también estén en el espacio de nombres correcto. En el ejemplo siguiente se declara un árbol XML en un espacio de nombres. Después se muestra el número de elementos Child.

Dim root As XElement = _
    <Root xmlns="https://www.adventure-works.com">
        <Child>content</Child>
    </Root>
Console.WriteLine(root.<Child>.Count())

Este ejemplo indica que no hay elementos Child. Genera el siguiente resultado:

0

No obstante, si declara un espacio de nombres global predeterminado, el literal XML y la propiedad XML estarán en el espacio de nombres global predeterminado:

Imports <xmlns="https://www.adventure-works.com">

Module Module1
    Sub Main()
        Dim root As XElement = _
            <Root>
                <Child>content</Child>
            </Root>
        Console.WriteLine(root.<Child>.Count())
    End Sub
End Module

Este ejemplo indica que hay un elemento Child. Genera el siguiente resultado:

1

Si declara un espacio de nombres global que no tenga un prefijo, puede usar el prefijo para literales XML y propiedades XML:

Imports <xmlns:aw="https://www.adventure-works.com">

Module Module1
    Sub Main()
        Dim root As XElement = _
            <aw:Root>
                <aw:Child>content</aw:Child>
            </aw:Root>
        Console.WriteLine(root.<aw:Child>.Count())
    End Sub
End Module

XNamespace y espacios de nombres globales

Puede obtener un objeto XNamespace usando el método GetXmlNamespace:

Imports <xmlns:aw="https://www.adventure-works.com">

Module Module1
    Sub Main()
        Dim root As XElement = <aw:Root/>
        Dim xn As XNamespace = GetXmlNamespace(aw)
        Console.WriteLine(xn)
    End Sub
End Module

Este ejemplo genera el siguiente resultado:

https://www.adventure-works.com