CompositionPropertySet Klasse

Definition

Namespace:

Windows.UI.Composition

Speichert Werte als Schlüssel-Wert-Paare.

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

Vererbung

Object Platform::Object IInspectable CompositionObject CompositionPropertySet

Attribute

ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows-Anforderungen

Gerätefamilie	Windows 10 (eingeführt in 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (eingeführt in v1.0)

Beispiele

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);
}

Hinweise

CompositionPropertySetssind CompositionObjects, die das Speichern von Schlüsselwertpaaren ermöglichen, die in der gesamten Anwendung gemeinsam verwendet werden können und nicht an die Lebensdauer eines anderen Kompositionsobjekts gebunden sind. CompositionPropertySetswerden am häufigsten mit Animationen verwendet, bei denen sie Schlüssel-Wert-Paare beibehalten, auf die verwiesen wird, um Teile von Kompositionsanimationen zu steuern. CompositionPropertySetsbieten die Möglichkeit, Schlüssel-Wert-Paare einzufügen oder einen Wert für einen bestimmten Schlüssel abzurufen. Weitere Informationen zur Verwendung von CompositionPropertySet mit Animationen finden Sie auf der Seite Übersicht über Animationen .

CompositionPropertySet unterstützt keine Delete-Funktion. Stellen Sie sicher, dass Sie CompositionPropertySet verwenden, um Werte zu speichern, die in der gesamten Anwendung freigegeben werden.

Hinweis

Durch Einfügen eines neuen Werts in ein CompositionPropertySet für einen bereits vorhandenen Schlüssel wird der alte Wert mit dem neuen überschrieben.

Versionsverlauf

Windows-Version	SDK-Version	Mehrwert
1607	14393	InsertBoolean
1607	14393	TryGetBoolean

Eigenschaften

Comment	Eine Zeichenfolge, die dem CompositionObject zugeordnet werden soll. (Geerbt von CompositionObject)
Compositor	Der Compositor , der zum Erstellen dieses CompositionObject verwendet wird. (Geerbt von CompositionObject)
Dispatcher	Der Verteiler für das CompositionObject. (Geerbt von CompositionObject)
DispatcherQueue	Ruft die DispatcherQueue für das CompostionObject ab. (Geerbt von CompositionObject)
ImplicitAnimations	Die Auflistung impliziter Animationen, die an dieses Objekt angefügt sind. (Geerbt von CompositionObject)
Properties	Die Auflistung der Eigenschaften, die dem CompositionObject zugeordnet sind. (Geerbt von CompositionObject)

Methoden

Close()	Schließt das CompositionObject und gibt Systemressourcen frei. (Geerbt von CompositionObject)
ConnectAnimation(String, CompositionAnimation)	Verbindet und Animation. (Geerbt von CompositionObject)
DisconnectAnimation(String)	Trennt eine Animation. (Geerbt von CompositionObject)
Dispose()	Führt anwendungsspezifische Aufgaben durch, die mit der Freigabe, der Zurückgabe oder dem Zurücksetzen von nicht verwalteten Ressourcen zusammenhängen. (Geerbt von CompositionObject)
InsertBoolean(String, Boolean)	Fügt ein boolesches Schlüssel-Wert-Paar ein.
InsertColor(String, Color)	Fügt ein Farbschlüssel-Wert-Paar ein.
InsertMatrix3x2(String, Matrix3x2)	Fügt ein Matrix3x2-Schlüssel-Wert-Paar ein.
InsertMatrix4x4(String, Matrix4x4)	Fügt ein Matrix4x4-Schlüssel-Wert-Paar ein.
InsertQuaternion(String, Quaternion)	Fügt ein Quaternion-Schlüssel-Wert-Paar ein.
InsertScalar(String, Single)	Fügt ein Einzelnes Schlüssel-Wert-Paar ein.
InsertVector2(String, Vector2)	Fügt ein Vector2-Schlüssel-Wert-Paar ein.
InsertVector3(String, Vector3)	Fügt ein Vector3-Schlüssel-Wert-Paar ein.
InsertVector4(String, Vector4)	Fügt ein Vector4-Schlüssel-Wert-Paar ein.
PopulatePropertyInfo(String, AnimationPropertyInfo)	Definiert eine Eigenschaft, die animiert werden kann. (Geerbt von CompositionObject)
StartAnimation(String, CompositionAnimation)	Verbindet eine Animation mit der angegebenen Eigenschaft des Objekts und startet die Animation. (Geerbt von CompositionObject)
StartAnimation(String, CompositionAnimation, AnimationController)	Verbindet eine Animation mit der angegebenen Eigenschaft des Objekts und startet die Animation. (Geerbt von CompositionObject)
StartAnimationGroup(ICompositionAnimationBase)	Startet eine Animationsgruppe. Mit der StartAnimationGroup-Methode für CompositionObject können Sie CompositionAnimationGroup starten. Alle Animationen in der Gruppe werden gleichzeitig für das Objekt gestartet. (Geerbt von CompositionObject)
StopAnimation(String)	Trennt eine Animation von der angegebenen Eigenschaft und beendet die Animation. (Geerbt von CompositionObject)
StopAnimationGroup(ICompositionAnimationBase)	Beendet eine Animationsgruppe. (Geerbt von CompositionObject)
TryGetAnimationController(String)	Gibt einen AnimationController für die Animation zurück, die für die angegebene Eigenschaft ausgeführt wird. (Geerbt von CompositionObject)
TryGetBoolean(String, Boolean)	Ruft den angegebenen booleschen Eigenschaftswert ab.
TryGetColor(String, Color)	Ruft den angegebenen Color-Eigenschaftswert ab.
TryGetMatrix3x2(String, Matrix3x2)	Ruft den angegebenen Matrix3x2-Eigenschaftswert ab.
TryGetMatrix4x4(String, Matrix4x4)	Ruft den angegebenen Matrix4x4-Eigenschaftswert ab.
TryGetQuaternion(String, Quaternion)	Ruft den angegebenen Quaternion-Eigenschaftswert ab.
TryGetScalar(String, Single)	Ruft den angegebenen Wert der Single-Eigenschaft ab.
TryGetVector2(String, Vector2)	Ruft den angegebenen Vector2-Eigenschaftswert ab.
TryGetVector3(String, Vector3)	Ruft den angegebenen Vector3-Eigenschaftswert ab.
TryGetVector4(String, Vector4)	Ruft den angegebenen Vector4-Eigenschaftswert ab.

Weitere Informationen

• CompositionObject
• IClosable