Cette rubrique suppose que vous compreniez les propriétés de dépendance du point de vue d'un consommateur de propriétés de dépendance existantes sur les classes Windows Presentation Foundation (WPF) et que vous ayez lu Vue d'ensemble des propriétés de dépendance. Pour suivre les exemples dans cette rubrique, vous devez également comprendre le XAML (Extensible Application Markup Language) et savoir comment écrire des applications WPF.

Une des finalités d'une propriété attachée est de permettre à différents éléments enfants de spécifier des valeurs uniques pour une propriété définie en fait dans un élément parent. Une application spécifique de ce scénario est de faire en sorte que les éléments enfants informent l'élément parent sur la manière dont ils doivent être présentés dans interface utilisateur (UI). La propriété DockPanel..::.Dock en est un exemple. La propriété DockPanel..::.Dock est créée comme une propriété attachée car elle est conçue pour être définie sur les éléments contenus dans un DockPanel, plutôt que sur le DockPanel proprement dit. La classe DockPanel définit le champ statique DependencyProperty nommé DockProperty, puis fournit les méthodes GetDock et SetDock comme accesseurs publics pour la propriété attachée.

En XAML, vous définissez des propriétés attachées à l'aide de la syntaxe AttachedPropertyProvider.PropertyName.

L'exemple suivant illustre la manière dont vous pouvez définir DockPanel..::.Dock en XAML :

<DockPanel>
  <CheckBox DockPanel.Dock="Top">Hello</CheckBox>
</DockPanel>

Notez que l'utilisation est quelque peu semblable à une propriété statique ; vous faites toujours référence au type DockPanel qui possède et enregistre la propriété attachée, plutôt qu'à une instance quelconque spécifiée par nom.

En outre, du fait qu'une propriété attachée en XAML est un attribut que vous définissez dans les balises, seule l'opération définie est pertinente. Il n'est pas possible d'obtenir directement une propriété en XAML, bien que des mécanismes indirects permettent de comparer des valeurs, telles que les déclencheurs dans les styles (pour plus d'informations, consultez Application d'un style et création de modèles).

Implémentation des propriétés attachées dans WPF

Bien que les propriétés attachées puissent être définies sur tout objet, cela ne signifie pas systématiquement que leur définition produira un résultat concret ou que leur valeur sera jamais utilisée par un autre objet. En général, les propriétés attachées sont utilisées pour que les objets provenant de diverses relations logiques ou hiérarchies de classes possibles puissent chacun communiquer des informations communes au type propriétaire. Le type qui définit la propriété attachée suit en général l'un de ces modèles :

• Le type qui définit la propriété attachée est conçu pour pouvoir être l'élément parent des éléments qui définiront les valeurs de la propriété attachée. Le type itère ensuite ses éléments enfants à travers la logique interne, obtient les valeurs et agit sur ces valeurs de quelque manière que ce soit.

• Le type qui définit la propriété attachée sera utilisé comme élément enfant pour divers éléments parents et modèles de contenu possibles.

• Le type qui définit la propriété attachée représente un service. D'autres types définissent les valeurs de la propriété attachée. Lorsque l'élément qui définit la propriété est évalué dans le contexte du service, les valeurs de la propriété attachée sont alors obtenues par le biais de la logique interne de la classe de service.

Exemple d'une propriété attachée définie par le parent

Les propriétés attachées dans WPF n'ont pas les méthodes de "wrapper" CLR typiques qui facilitent la définition/l'obtention de l'accès. Cela est dû au fait que la propriété attachée ne fait pas nécessairement partie de l'espace de noms CLR pour les instances dans lesquelles est définie la propriété. Toutefois, un lecteur XAML doit être en mesure de définir ces valeurs lorsque du XAML est traité. Pour être une propriété attachée effective, le type de propriétaire de la propriété attachée doit implémenter des méthodes d'accesseur dédiées au format GetPropertyName et SetPropertyName. Ces méthodes d'accesseur dédiées permettent également d'obtenir ou de définir la propriété attachée dans le code. Du point de vue du code, une propriété attachée s'apparente à un champ de stockage comportant des accesseurs de méthode au lieu d'accesseurs de propriété, et ce champ de stockage peut exister sur tout objet plutôt que devoir être défini de manière spécifique.

L'exemple suivant illustre la définition d'une propriété attachée dans le code. Dans cet exemple, myCheckBox est une instance de la classe CheckBox.

DockPanel myDockPanel = new DockPanel();
CheckBox myCheckBox = new CheckBox();
myCheckBox.Content = "Hello";
myDockPanel.Children.Add(myCheckBox);
DockPanel.SetDock(myCheckBox, Dock.Top);

Similaire au cas du XAML, si myCheckBox n'a pas déjà été ajouté comme un élément enfant de myDockPanel par la troisième ligne du code, la quatrième ligne du code ne déclenchera pas d'exception, mais la valeur de la propriété n'interagira pas avec un parent DockPanel et donc n'aura aucun impact. Seule une valeur DockPanel..::.Dock définie sur un élément enfant combiné à la présence d'un élément parent DockPanel déclenchera un comportement effectif dans l'application rendue.

Lors de l'enregistrement de la propriété, FrameworkPropertyMetadata est défini pour spécifier des caractéristiques de la propriété, par exemple si la propriété affecte le rendu, les mesures, etc. Les métadonnées d'une propriété attachée sont en général identiques à celles d'une propriété de dépendance. Si vous spécifiez une valeur par défaut dans une substitution des métadonnées d'une propriété attachée, cette valeur devient la valeur par défaut de la propriété attachée implicite sur les instances de la classe prioritaire. Spécifiquement, votre valeur par défaut est signalée si un processus demande la valeur d'une propriété attachée par le biais de l'accesseur de méthode Get de cette propriété, en spécifiant une instance de la classe dans laquelle vous avez indiqué les métadonnées, et si la valeur de cette propriété attachée n'était autrement pas définie.

Si vous souhaitez activer l'héritage des valeurs de propriété sur une propriété, vous devez utiliser des propriétés attachées plutôt que des propriétés de dépendance non attachées. Pour plus d'informations, consultez Héritage de la valeur de propriété.

Quand créer une propriété attachée

Comment créer une propriété attachée

public static readonly DependencyProperty IsBubbleSourceProperty = DependencyProperty.RegisterAttached(
  "IsBubbleSource",
  typeof(Boolean),
  typeof(AquariumObject),
  new FrameworkPropertyMetadata(false, FrameworkPropertyMetadataOptions.AffectsRender)
);
public static void SetIsBubbleSource(UIElement element, Boolean value)
{
  element.SetValue(IsBubbleSourceProperty, value);
}
public static Boolean GetIsBubbleSource(UIElement element)
{
  return (Boolean)element.GetValue(IsBubbleSourceProperty);
}

• Pour plus d'informations sur la création d'une propriété attachée, consultez Comment : enregistrer une propriété attachée.

• Pour obtenir des scénarios d'usage avancés des propriétés de dépendance et des propriétés attachées, consultez Propriétés de dépendance personnalisées.

• Vous pouvez également enregistrer une propriété comme une propriété attachée et comme une propriété de dépendance ; mais dans ce cas, vous exposerez encore les implémentations de "wrapper." Dans ce cas, la propriété peut avoir pour valeur cet élément ou tout élément inclus dans la syntaxe de la propriété attachée XAML. Le scénario suivant illustre un exemple de propriété pour utilisations standard et attachée : FrameworkElement..::.FlowDirection.

Tâches

Concepts

Référence