Pour afficher l’article en anglais, activez la case d’option Anglais. Vous pouvez aussi afficher la version anglaise dans une fenêtre contextuelle en faisant glisser le pointeur de la souris sur le texte.
Traduction
Anglais

Comment : implémenter ICommandSource

 

Publication: juin 2016

Cet exemple indique comment créer une source de commande en implémentant ICommandSource. Une source de commande est un objet qui sait comment appeler une commande. L'interface ICommandSource expose trois membres : Command, CommandParameter et CommandTarget. Command est la commande qui sera invoquée. CommandParameter est un type de données défini par l'utilisateur qui est transmis de la source de commande à la méthode qui gère la commande. CommandTarget est l'objet sur lequel est exécutée la commande.

Dans cet exemple, une classe qui sous-classe le contrôle Slider et implémente ICommandSource est créée.

Exemple

WPF fournit plusieurs classes qui implémentent ICommandSource, comme Button, MenuItem et ListBoxItem. Une source de commande définit comment appeler une commande. Button et MenuItem invoquent une commande lorsque vous cliquez dessus. ListBoxItem appelle une commande lorsque l'utilisateur double-clique dessus. Ces classes ne deviennent une source de commande que lorsque leur propriété Command est définie.

Dans cet exemple, nous appellerons la commande lorsque le curseur sera déplacé, ou plus précisément lorsque la propriété Value sera modifiée.

Les éléments suivants composent la définition de classe.

public class CommandSlider : Slider, ICommandSource
{
    public CommandSlider() : base()
    {

    }

L'étape suivante consiste à implémenter les membres ICommandSource. Dans cet exemple, les propriétés sont implémentées en tant qu'objets DependencyProperty. Cela permet aux propriétés d'utiliser la liaison de données. Pour plus d'informations sur la classe DependencyProperty, consultez Vue d'ensemble des propriétés de dépendance. Pour plus d'informations sur la liaison de données, consultez Vue d'ensemble de la liaison de données.

Seule la propriété Command est illustrée ici.

// Make Command a dependency property so it can use databinding.
public static readonly DependencyProperty CommandProperty =
    DependencyProperty.Register(
        "Command",
        typeof(ICommand),
        typeof(CommandSlider),
        new PropertyMetadata((ICommand)null,
        new PropertyChangedCallback(CommandChanged)));

public ICommand Command
{
    get 
    {
        return (ICommand)GetValue(CommandProperty);
    }
    set 
    {
        SetValue(CommandProperty, value);
    }
}

Les éléments suivants représentent le rappel de changement DependencyProperty.

// Command dependency property change callback.
private static void CommandChanged(DependencyObject d,
    DependencyPropertyChangedEventArgs e)
{
    CommandSlider cs = (CommandSlider)d;
    cs.HookUpCommand((ICommand)e.OldValue,(ICommand)e.NewValue);
}

L'étape suivante consiste à ajouter et supprimer la commande associée à la source de commande. La propriété Command ne peut pas être remplacée simplement à l'ajout d'une nouvelle commande car les gestionnaires d'événements éventuellement associés à la commande précédente doivent être supprimés en premier.

// Add a new command to the Command Property.
private void HookUpCommand(ICommand oldCommand, ICommand newCommand)
{
    // If oldCommand is not null, then we need to remove the handlers.
    if (oldCommand != null)
    {
        RemoveCommand(oldCommand, newCommand);
    }
    AddCommand(oldCommand, newCommand);
}

// Remove an old command from the Command Property.
private void RemoveCommand(ICommand oldCommand, ICommand newCommand)
{
    EventHandler handler = CanExecuteChanged;
    oldCommand.CanExecuteChanged -= handler;
}

// Add the command.
private void AddCommand(ICommand oldCommand, ICommand newCommand)
{
    EventHandler handler = new EventHandler(CanExecuteChanged);
    canExecuteChangedHandler = handler;
    if (newCommand != null)
    {
        newCommand.CanExecuteChanged += canExecuteChangedHandler;
    }
}

La dernière étape consiste à créer la logique du gestionnaire CanExecuteChanged et la méthode Execute.

L'événement CanExecuteChanged informe la source de commande que la possibilité d'exécuter la commande sur la cible de commande actuelle a peut-être changé. Lorsqu'une source de commande reçoit cet événement, elle appelle généralement la méthode CanExecute sur la commande. Si la commande ne peut pas s'exécuter sur la cible de la commande actuelle, la source de commande se désactivera d'elle-même en règle générale. Si la commande peut s'exécuter sur la cible, la source de commande s'activera d'elle-même en règle générale.

private void CanExecuteChanged(object sender, EventArgs e)
{

    if (this.Command != null)
    {
        RoutedCommand command = this.Command as RoutedCommand;

        // If a RoutedCommand.
        if (command != null)
        {
            if (command.CanExecute(CommandParameter, CommandTarget))
            {
                this.IsEnabled = true;
            }
            else
            {
                this.IsEnabled = false;
            }
        }
        // If a not RoutedCommand.
        else
        {
            if (Command.CanExecute(CommandParameter))
            {
                this.IsEnabled = true;
            }
            else
            {
                this.IsEnabled = false;
            }
        }
    }
}

La dernière étape consiste en la méthode Execute. Si la commande est un RoutedCommand, la méthode RoutedCommandExecute est appelée ; sinon, la méthode ICommandExecute est appelée.

// If Command is defined, moving the slider will invoke the command;
// Otherwise, the slider will behave normally.
protected override void OnValueChanged(double oldValue, double newValue)
{
    base.OnValueChanged(oldValue, newValue);

    if (this.Command != null)
    {
        RoutedCommand command = Command as RoutedCommand;

        if (command != null)
        {
            command.Execute(CommandParameter, CommandTarget);
        }
        else
        {
            ((ICommand)Command).Execute(CommandParameter);
        }
    }
}
Afficher: