CompositionPropertySet 类

参考

定义

命名空间:: Microsoft.UI.Composition

重要

一些信息与预发行产品相关，相应产品在发行之前可能会进行重大修改。对于此处提供的信息，Microsoft 不作任何明示或暗示的担保。

编辑

将值存储为键值对。

public ref class CompositionPropertySet sealed : CompositionObject

/// [Windows.Foundation.Metadata.ContractVersion(Microsoft.Foundation.LiftedContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
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(Microsoft.Foundation.WindowsAppSDKContract, 65536)]
class CompositionPropertySet final : CompositionObject

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

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

Public NotInheritable Class CompositionPropertySet
Inherits CompositionObject

继承: Object Platform::Object IInspectable CompositionObject CompositionPropertySet

属性: ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

示例

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

注解

CompositionPropertySet是 CompositionObjects，允许存储可跨应用程序共享且不绑定到另一个组合对象的生存期的键值对。 CompositionPropertySet最常用于动画，其中它们维护用于驱动部分合成动画的键值对。 CompositionPropertySet提供插入键值对或检索给定键的值的功能。有关将 CompositionPropertySet 与动画配合使用的详细信息，请参阅动画概述页。

CompositionPropertySet 不支持删除函数 – 请确保使用 CompositionPropertySet 存储将在应用程序中共享的值。

注意

将新值插入到已存在的键的 CompositionPropertySet 中会用新值覆盖旧值。

属性

Comment	要与 CompositionObject 关联的字符串。 (继承自 CompositionObject)
Compositor	用于创建此 CompositionObject 的 Compositor。 (继承自 CompositionObject)
DispatcherQueue	获取 CompositionObject 的 DispatcherQueue。 (继承自 CompositionObject)
ImplicitAnimations	附加到此对象的隐式动画集合。 (继承自 CompositionObject)
Properties	与 CompositionObject 关联的属性的集合。 (继承自 CompositionObject)

方法

Close()	关闭 CompositionObject 并释放系统资源。 (继承自 CompositionObject)
Dispose()	执行与释放或重置非托管资源关联的应用程序定义的任务。 (继承自 CompositionObject)
InsertBoolean(String, Boolean)	插入布尔键值对。
InsertColor(String, Color)	插入 Color 键值对。
InsertMatrix3x2(String, Matrix3x2)	插入 Matrix3x2 键值对。
InsertMatrix4x4(String, Matrix4x4)	插入 Matrix4x4 键值对。
InsertQuaternion(String, Quaternion)	插入四元数键值对。
InsertScalar(String, Single)	插入单个键值对。
InsertVector2(String, Vector2)	插入 Vector2 键值对。
InsertVector3(String, Vector3)	插入 Vector3 键值对。
InsertVector4(String, Vector4)	插入 Vector4 键值对。
PopulatePropertyInfo(String, AnimationPropertyInfo)	定义可进行动画处理的属性。 (继承自 CompositionObject)
StartAnimation(String, CompositionAnimation, AnimationController)	使用对象的指定属性连接动画并启动动画。 (继承自 CompositionObject)
StartAnimation(String, CompositionAnimation)	使用对象的指定属性连接动画并启动动画。 (继承自 CompositionObject)
StartAnimationGroup(ICompositionAnimationBase)	启动动画组。 CompositionObject 上的 StartAnimationGroup 方法可用于启动 CompositionAnimationGroup。组中的所有动画将同时在对象上启动。 (继承自 CompositionObject)
StopAnimation(String)	断开动画与指定属性的连接并停止动画。 (继承自 CompositionObject)
StopAnimationGroup(ICompositionAnimationBase)	停止动画组。 (继承自 CompositionObject)
TryGetAnimationController(String)	返回指定属性上运行的动画的 AnimationController。 (继承自 CompositionObject)
TryGetBoolean(String, Boolean)	检索指定的布尔属性值。
TryGetColor(String, Color)	检索指定的 Color 属性值。
TryGetMatrix3x2(String, Matrix3x2)	检索指定的 Matrix3x2 属性值。
TryGetMatrix4x4(String, Matrix4x4)	检索指定的 Matrix4x4 属性值。
TryGetQuaternion(String, Quaternion)	检索指定的四元数属性值。
TryGetScalar(String, Single)	检索指定的 Single 属性值。
TryGetVector2(String, Vector2)	检索指定的 Vector2 属性值。
TryGetVector3(String, Vector3)	检索指定的 Vector3 属性值。
TryGetVector4(String, Vector4)	检索指定的 Vector4 属性值。

适用于

通过

CompositionPropertySet 类

定义

示例

注解

属性

方法

适用于

另请参阅

反馈

其他资源