Comment : effectuer une liaison à des données XML à l'aide d'un XMLDataProvider et de requêtes XPath

  • Article

Cet exemple montre comment lier des données XML à l’aide d’un XmlDataProvider.

Avec un XmlDataProvider, les données sous-jacentes accessibles via la liaison de données dans votre application peuvent être n’importe quelle arborescence de nœuds XML. En d’autres termes, un XmlDataProvider moyen pratique d’utiliser n’importe quelle arborescence de nœuds XML comme source de liaison.

Exemple

Dans l’exemple suivant, les données sont incorporées directement en tant qu’île de données XML dans la Resources section. Un îlot de données XML doit être encapsulé dans <x:XData> des balises et avoir toujours un nœud racine unique, qui est Inventory dans cet exemple.

Remarque

Le nœud racine des données XML a un attribut xmlns qui définit l’espace de noms XML sur une chaîne vide. Il s’agit d’une exigence pour l’application de requêtes XPath à un îlot de données inclus dans la page XAML. Dans ce cas inline, le code XAML, et donc l’île de données, hérite de l’espace System.Windows de noms. En raison de cela, vous devez définir l’espace de noms vide pour empêcher les requêtes XPath d’être qualifiées par l’espace System.Windows de noms, ce qui ferait mal passer les requêtes.

<StackPanel
  xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
  xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
  Background="Cornsilk">

  <StackPanel.Resources>
    <XmlDataProvider x:Key="InventoryData" XPath="Inventory/Books">
      <x:XData>
        <Inventory xmlns="">
          <Books>
            <Book ISBN="0-7356-0562-9" Stock="in" Number="9">
              <Title>XML in Action</Title>
              <Summary>XML Web Technology</Summary>
            </Book>
            <Book ISBN="0-7356-1370-2" Stock="in" Number="8">
              <Title>Programming Microsoft Windows With C#</Title>
              <Summary>C# Programming using the .NET Framework</Summary>
            </Book>
            <Book ISBN="0-7356-1288-9" Stock="out" Number="7">
              <Title>Inside C#</Title>
              <Summary>C# Language Programming</Summary>
            </Book>
            <Book ISBN="0-7356-1377-X" Stock="in" Number="5">
              <Title>Introducing Microsoft .NET</Title>
              <Summary>Overview of .NET Technology</Summary>
            </Book>
            <Book ISBN="0-7356-1448-2" Stock="out" Number="4">
              <Title>Microsoft C# Language Specifications</Title>
              <Summary>The C# language definition</Summary>
            </Book>
          </Books>
          <CDs>
            <CD Stock="in" Number="3">
              <Title>Classical Collection</Title>
              <Summary>Classical Music</Summary>
            </CD>
            <CD Stock="out" Number="9">
              <Title>Jazz Collection</Title>
              <Summary>Jazz Music</Summary>
            </CD>
          </CDs>
        </Inventory>
      </x:XData>
    </XmlDataProvider>
  </StackPanel.Resources>

  <TextBlock FontSize="18" FontWeight="Bold" Margin="10"
    HorizontalAlignment="Center">XML Data Source Sample</TextBlock>
  <ListBox
    Width="400" Height="300" Background="Honeydew">
    <ListBox.ItemsSource>
      <Binding Source="{StaticResource InventoryData}"
               XPath="*[@Stock='out'] | *[@Number>=8 or @Number=3]"/>
    </ListBox.ItemsSource>

    <!--Alternatively, you can do the following. -->
    <!--<ListBox Width="400" Height="300" Background="Honeydew"
      ItemsSource="{Binding Source={StaticResource InventoryData},
      XPath=*[@Stock\=\'out\'] | *[@Number>\=8 or @Number\=3]}">-->

    <ListBox.ItemTemplate>
      <DataTemplate>
        <TextBlock FontSize="12" Foreground="Red">
          <TextBlock.Text>
            <Binding XPath="Title"/>
          </TextBlock.Text>
        </TextBlock>
      </DataTemplate>
    </ListBox.ItemTemplate>
  </ListBox>
</StackPanel>

Comme indiqué dans cet exemple, pour créer la même déclaration de liaison dans la syntaxe d’attribut, vous devez échapper les caractères spéciaux correctement. Pour plus d’informations, consultez Entités de caractères XML et XAML.

Les ListBox éléments suivants s’affichent lorsque cet exemple est exécuté. Il s’agit de tous les objets Titles de tous les éléments sous Books ayant une valeur Stock de « out » ou une valeur Number de 3 ou supérieure ou égale à 8. Notez qu’aucun élément CD n’est retourné, car la XPath valeur définie sur le XmlDataProvider tableau indique que seuls les éléments Books doivent être exposés (en définissant essentiellement un filtre).

Screenshot of the XPath example showing the title of four books.

Dans cet exemple, les titres du livre sont affichés en raison XPath de la liaison dans l’objet TextBlockDataTemplate « Title ». Si vous souhaitez afficher la valeur d’un attribut, tel que l’ISBN, vous devez définir cette XPath valeur sur «@ISBN ».

Les propriétés XPath dans WPF sont gérées par la méthode XmlNode.SelectNodes. Vous pouvez modifier les requêtes XPath pour obtenir des résultats différents. Voici quelques exemples pour la XPath requête sur la liaison ListBox de l’exemple précédent :

  • XPath="Book[1]" retourne le premier élément d’ouvrage (« XML in Action »). Notez que les index XPath sont basés sur 1, et non sur 0.

  • XPath="Book[@*]" retourne tous les éléments d’ouvrage avec des attributs.

  • XPath="Book[last()-1]" retourne l’avant dernier élément d’ouvrage (« Introducing Microsoft .NET »).

  • XPath="*[position()>3]" retournera tous les éléments d’ouvrage, à l’exception des 3 premiers.

Lorsque vous exécutez une requête XPath , elle retourne une XmlNode ou une liste de XmlNodes. XmlNode est un objet CLR (Common Language Runtime), ce qui signifie que vous pouvez utiliser la propriété pour établir une Path liaison aux propriétés CLR (Common Language Runtime). Regardez de nouveau l’exemple précédent. Si le reste de l’exemple reste le même et que vous modifiez la TextBlock liaison en suivant, vous verrez les noms des XmlNodes retournés dans le ListBox. Dans ce cas, le nom de tous les nœuds retournés est « Book ».

<TextBlock FontSize="12" Foreground="Red">
  <TextBlock.Text>
    <Binding Path="Name"/>
  </TextBlock.Text>
</TextBlock>

Dans certaines applications, l’incorporation du code XML en tant qu’île de données dans la source de la page XAML peut être gênante, car le contenu exact des données doit être connu au moment de la compilation. Par conséquent, l’obtention des données à partir d’un fichier XML externe est également prise en charge, comme dans l’exemple suivant :

<XmlDataProvider x:Key="BookData" Source="data\bookdata.xml" XPath="Books"/>

Si les données XML résident dans un fichier XML distant, vous devez définir l’accès aux données en affectant une URL appropriée à l’attribut Source comme suit :

<XmlDataProvider x:Key="BookData" Source="http://MyUrl" XPath="Books"/>

Voir aussi