Musashi

Pour ce premier opus, d' une série ou nous étudierons le Databinding en WPF, j'ai choisi de présenter les différents moyens d' instancier et d' utiliser ses classes (du domaine par exemple) en XAML.

Nous verrons dans ce post les éléments suivants :

• La création d' objet en XAML à partir de classe C#
• L'objectDataProvider
  • Son utilisation,
  • Ses contextes d 'utilisations.

La classe de base que nous allons utiliser pour instancier nos objets en XAML est la classe "Contact" qui est représentée par la définition suivante:

public class Contact
{

public string Name { get; set; }
public string Surname { get; set; }

public Contact()
{
this.Name = "Test";
this.Surname = "Test";
} 

public Contact(string Name, string Surname)
{
this.Name = Name;
this.Surname = Surname;
}
}

Comme vous pouvez le constater cette classe, simple,  possède deux membres (le prénom et le nom) ainsi que deux constructeurs l' un qui par défaut instancie l' objet avec des valeurs de test et l' autre qui prends deux paramètres correspondant aux deux membres.

Notre but est d' afficher une instance de la classe contact dans une fenêtre contenant deux zones de texte qui affiche ses membres comme montré ci-dessous

c'est la grande classe cette fenêtre, une vrai fenêtre de développeur non :o)

Le code source de cette fenêtre est le suivant :

<Grid>
        <Grid.ColumnDefinitions>
            <ColumnDefinition Width="30*" />
            <ColumnDefinition Width="70*" />
        </Grid.ColumnDefinitions>
        <Grid Grid.Column="1">
            <Grid.ColumnDefinitions>
                <ColumnDefinition Width="30*" />
                <ColumnDefinition Width="70*" />
            </Grid.ColumnDefinitions>
            <Grid.RowDefinitions>
                <RowDefinition Height="25*" />
                <RowDefinition Height="25*" />
            </Grid.RowDefinitions>
            
            <TextBlock Text="Name : " Grid.Column="0" Grid.Row="0" />
            <TextBlock x:Name="txtName" Text="{Binding Source={StaticResource TotoObject}, Path=Name}" Grid.Column="1" Grid.Row="0" />
            <TextBlock Text="Surname : " Grid.Column="0" Grid.Row="1"/>
            <TextBlock x:Name="txtSurname" Text="{Binding Source={StaticResource TotoObject}, Path=Surname}" Grid.Column="1" Grid.Row="1" />
        </Grid>
    </Grid>

Vous noterez qu' il existe une expression de Binding au niveau des textBlocks que j' expliquerais dans un prochain Post sinon ce code n' a rien de complexe.

Des grilles pour créer un layout et des zones de texte pour afficher les informations relatives à notre instance.

maintenant entrons dans le vif su sujet: la création d' objets pour afficher des informations !

Instanciation des objets du domaine en XAML

En se basant sur la classe "Contact" présentée précédemment  :

• Référencer l'assembly contenant la classe Contact (wpfDataBinding_Part1 dans notre cas) dans votre fichier Xaml,

 xmlns:local="clr-namespace:WpfDatabinding_Part1"

• Créer une ressource correpondant à cette classe (et donc l' instancier) et affecter les valeurs des membres de notre objet afin de les afficher dans les textBlocks.,

<Window.Resources>
    <local:Contact x:Key="TotoObject" Name="Toto" Surname="Tata" />
</Window.Resources>

• Nous pouvons aussi utiliser cette syntaxe pour arriver au même but

<local:Contact x:Key="TotoObject">
        <local:Contact.Name>Test</local:Contact.Name>
        <local:Contact.Surname>Blablaa</local:Contact.Surname>
</local:Contact>

C'est ainsi qu' un objet C# peut être créé en XAML. La façon de lier cet objet a la zone de texte passe par la création d' une liaison de données (Databinding)

<TextBlock x:Name="txtName" Text="{Binding Source={StaticResource TotoObject}, Path=Name}" Grid.Column="1" Grid.Row="0" />

La source du Binding est une ressource (au niveau de la fenêtre) c'est la raison pour laquelle elle est référencée à l' aide d' une expression "StaticResource".

Gestion des listes d' objets 

je souhaiterais créer en XAML une liste de contact via ma classe Contacts qui hérite de List<Contact> comme présenté ci-dessous:

public class Contacts : List<Contact>
{
        
}

Pour ce faire vous devez écrire le code suivant:

<local:Contacts x:Key="ListTest">
       <local:Contact Name="Musa1" Surname="Bewise" />
       <local:Contact Name="Musa2" Surname="Bewise" />
</local:Contacts>

L'objectDataProvider:

La deuxième façon de créer un objet en XAML correspond à utiliser un fournisseur de données comme l'objectDataProvider.

L'objectDataProvider est une abstraction des données réel pour en créer une donnée "Bindable". Ainsi à partir d'une source, un objet ou encore une méthode, il crée un instance suivant ce qui est retournée par l' objet ou la méthode. la liste suivante résume ces possibilités:

• Créer un objet à partir de son instance en XAML,
• Créer un objet à l' aide d' un constructeur paramétré,
• Créer un objet à l' aide d' une méthode qui retourne une instance ou une collection.

Utilisation de l'objectDataProvider pour instancier un objet

Ci-dessous on crée un objet en local et l' on spécifie un objectDataProvider à partir de cet objet .

<Window.Resources>
    <local:Contact x:Key="bobObject" Name="Hiro" Surname="Nakamura" />
    <ObjectDataProvider x:Key="TotoObject" ObjectInstance="{StaticResource bobObject}" />
</Window.Resources>

Cela ne vous a pas échapper précédemment, j' en suis sur :) , mais l' instance d' un objet créé directement en XAML s' appuie sur son constructeur par défaut (sans paramètre). Pour créer un objet à partir d' un constructeur spécifique on peut s' appuyer sur l'objectDataProvider comme ci-dessous:

    <Window.Resources>
        <ObjectDataProvider x:Key="TotoObject" ObjectType="{x:Type local:Contact}">
            <ObjectDataProvider.ConstructorParameters>
                <sys:String>Hiro</sys:String>
                <sys:String>Nakamura</sys:String>
            </ObjectDataProvider.ConstructorParameters>
        </ObjectDataProvider>
    </Window.Resources>

Une autre possibilité, instancier un objet à partir d' une méthode statique (utile dans le cas d' une Factory) :

<ObjectDataProvider x:Key="TotoObject" ObjectType="{x:Type local:ContactManager}" MethodName="GetContactInstance">
         <ObjectDataProvider.MethodParameters>
              <sys:String>Hiro</sys:String>
              <sys:String>Nakamura</sys:String>
        </ObjectDataProvider.MethodParameters>
</ObjectDataProvider>

Le code de ContactManager est le suivant :

 public class ContactManager
    {
        public static Contact GetContactInstance()
        {
            return null;
        }

        public static Contact GetContactInstance(string Name, string Surname)
        {
            return new Contact(Name,Surname);
        }

        public static List<String> GetContactList()
        {
            List<String> liste = new List<string>();

            liste.Add("Yann");
            liste.Add("Fred");
            liste.Add("David");
            liste.Add("Sacha");
            
            return liste ;
        }
    }

Dans l' exemple ci-dessus, nous pouvons noter 2 éléments importants :

• La classe utiliser par l'objectDataProvider est ContactManager sur laquelle nous appelons la méthode "GetContactInstance" qui est statique,
• L' objet instancier et contenu par l'objectDataProvider, est une instance de Contact (Celle retournée par notre méthode).

Utilisation de l'objectDataProvider pour instancier une liste de contact

Souvent nos composants visuelles utilisent des Listes et nous voudrions alors que notre ObjectDataProvider contiennent une liste d' objet pour l' afficher dans une ListBox comme ci-dessous

De la même manière que pour une instance d' objet, une liste d' objet peut être la source d' un ObjectDataProvider, comme montré ci-dessous, notamment en s' appuyant sur la méthode GetContactList de la classe ContactManager

<Window.Resources>
        <ObjectDataProvider x:Key="TotoObject" ObjectType="{x:Type local:ContactManager}" MethodName="GetContactList" />
</Window.Resources>

<Grid>
     <ListBox ItemsSource="{Binding Source={StaticResource TotoObject}}"></ListBox>
</Grid>

Asynchronisme et ObjectDataProvider

L' objectDataProvider possède,  un attribut permettant de charger de manière asynchrone les objets. Cette propriété nommé "Asynchronous" s' utilise comme suit :

<ObjectDataProvider x:Key="TotoObject" ObjectType="{x:Type local:ContactManager}" MethodName="GetContactList" IsAsynchronous="True"/>

Ainsi vous pouvez lancer votre fenêtre, la manipuler pendant que les données se charge dans un thread différent (c'est le threadPool qui est sollicité pour réaliser cela) ce qui permet bien sur de ne pas bloquer l' interface durant de long chargements .

Alors en conclusion , dans quel contexte utilise-t-on un ObjectDataProvider  ?

• Vous ne souhaitez pas lier la source de données directement,
• Vos listes à Binder sont fournis par des classes tierces qui les exposent via des méthodes (Factory par exemple),
• Vous avez la nécessité d' instancier des objets en XAML via leurs constructeurs paramétrés,
• Vous souhaitez réaliser des chargements asynchrones de vos données (d'autres méthodes existent, bien sur, mais l'objectDataProvider est un moyen simple d' y parvenir).

Musa.