CompositionPropertySet Classe

Définition

Espace de noms:

Windows.UI.Composition

Stocke les valeurs sous forme de paires clé-valeur.

public ref class CompositionPropertySet sealed : CompositionObject

/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 131072)]
class CompositionPropertySet final : CompositionObject

[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 131072)]
public sealed class CompositionPropertySet : CompositionObject

Public NotInheritable Class CompositionPropertySet
Inherits CompositionObject

Héritage

Object Platform::Object IInspectable CompositionObject CompositionPropertySet

Attributs

ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Configuration requise pour Windows

Famille d’appareils	Windows 10 (introduit dans 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (introduit dans v1.0)

Exemples

void CreatePropertySet()
{
  // Create the CompositionPropertySet and insert a scalar value
  CompositionPropertySet sharedPropSet = _compositor.CreatePropertySet();
  sharedPropSet.InsertScalar("offsetChange", 50f);

  // Reference value in CompositionPropertySet in an Expression
  ExpressionAnimation expression =
  _compositor.CreateExpressionAnimation("this.Target.Offset.X + shared.offsetChange");
  expression.SetReferenceParameter("shared", sharedPropSet);
}

void PropertySetRetrieve(CompositionPropertySet propertySet)
{
  // Retrieve the value of key in a CompositionPropertySet
  float tempOffset;
  propertySet.TryGetScalar("offsetChange", out tempOffset);
}

Remarques

CompositionPropertySets sont des CompositionObjectqui permettent le stockage de paires de valeurs clés qui peuvent être partagées dans l’application et ne sont pas liées à la durée de vie d’un autre objet de composition. Les éléments CompositionPropertySetsont les plus couramment utilisés avec les animations, où ils gèrent des paires clé-valeur référencées pour piloter des parties des animations de composition. CompositionPropertySetpermet d’insérer des paires clé-valeur ou de récupérer une valeur pour une clé donnée. Pour plus d’informations sur l’utilisation de CompositionPropertySet avec des animations, consultez la page Vue d’ensemble des animations .

CompositionPropertySet ne prend pas en charge une fonction de suppression. Veillez à utiliser CompositionPropertySet pour stocker les valeurs qui seront partagées entre l’application.

Notes

L’insertion d’une nouvelle valeur dans un CompositionPropertySet pour une clé qui existe déjà remplace l’ancienne valeur par la nouvelle.

Historique des versions

Version de Windows	Version du SDK	Valeur ajoutée
1607	14393	InsertBoolean
1607	14393	TryGetBoolean

Propriétés

Comment	Chaîne à associer à CompositionObject. (Hérité de CompositionObject)
Compositor	Compositor utilisé pour créer cet Objet CompositionObject. (Hérité de CompositionObject)
Dispatcher	Répartiteur pour compositionObject. (Hérité de CompositionObject)
DispatcherQueue	Obtient le DispatcherQueue pour CompostionObject. (Hérité de CompositionObject)
ImplicitAnimations	Collection d’animations implicites attachées à cet objet. (Hérité de CompositionObject)
Properties	Collection de propriétés associées à CompositionObject. (Hérité de CompositionObject)

Méthodes

Close()	Ferme l’objet CompositionObject et libère les ressources système. (Hérité de CompositionObject)
ConnectAnimation(String, CompositionAnimation)	Connecte et animation. (Hérité de CompositionObject)
DisconnectAnimation(String)	Déconnecte une animation. (Hérité de CompositionObject)
Dispose()	Exécute les tâches définies par l'application associées à la libération ou à la redéfinition des ressources non managées. (Hérité de CompositionObject)
InsertBoolean(String, Boolean)	Insère une paire clé-valeur booléenne.
InsertColor(String, Color)	Insère une paire clé-valeur de couleur .
InsertMatrix3x2(String, Matrix3x2)	Insère une paire clé-valeur Matrix3x2.
InsertMatrix4x4(String, Matrix4x4)	Insère une paire clé-valeur Matrix4x4.
InsertQuaternion(String, Quaternion)	Insère une paire clé-valeur de quaternion.
InsertScalar(String, Single)	Insère une paire clé-valeur unique .
InsertVector2(String, Vector2)	Insère une paire clé-valeur Vector2.
InsertVector3(String, Vector3)	Insère une paire clé-valeur Vector3.
InsertVector4(String, Vector4)	Insère une paire clé-valeur Vector4.
PopulatePropertyInfo(String, AnimationPropertyInfo)	Définit une propriété qui peut être animée. (Hérité de CompositionObject)
StartAnimation(String, CompositionAnimation)	Connecte une animation à la propriété spécifiée de l’objet et démarre l’animation. (Hérité de CompositionObject)
StartAnimation(String, CompositionAnimation, AnimationController)	Connecte une animation à la propriété spécifiée de l’objet et démarre l’animation. (Hérité de CompositionObject)
StartAnimationGroup(ICompositionAnimationBase)	Démarre un groupe d’animations. La méthode StartAnimationGroup sur CompositionObject vous permet de démarrer CompositionAnimationGroup. Toutes les animations du groupe seront démarrées en même temps sur l’objet. (Hérité de CompositionObject)
StopAnimation(String)	Déconnecte une animation de la propriété spécifiée et arrête l’animation. (Hérité de CompositionObject)
StopAnimationGroup(ICompositionAnimationBase)	Arrête un groupe d’animations. (Hérité de CompositionObject)
TryGetAnimationController(String)	Renvoie un AnimationController pour l’animation en cours d’exécution sur la propriété spécifiée. (Hérité de CompositionObject)
TryGetBoolean(String, Boolean)	Récupère la valeur de propriété booléenne spécifiée.
TryGetColor(String, Color)	Récupère la valeur de la propriété Color spécifiée.
TryGetMatrix3x2(String, Matrix3x2)	Récupère la valeur de propriété Matrix3x2 spécifiée.
TryGetMatrix4x4(String, Matrix4x4)	Récupère la valeur de la propriété Matrix4x4 spécifiée.
TryGetQuaternion(String, Quaternion)	Récupère la valeur de la propriété quaternion spécifiée.
TryGetScalar(String, Single)	Récupère la valeur de la propriété Single spécifiée.
TryGetVector2(String, Vector2)	Récupère la valeur de la propriété Vector2 spécifiée.
TryGetVector3(String, Vector3)	Récupère la valeur de la propriété Vector3 spécifiée.
TryGetVector4(String, Vector4)	Récupère la valeur de la propriété Vector4 spécifiée.

Voir aussi

• CompositionObject
• IClosable