CompositionPropertySet 類別

定義

命名空間:

Microsoft.UI.Composition

以鍵值對形式儲存值。

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(Microsoft.Foundation.WindowsAppSDKContract, 65536)]
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(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是 CompositionObject，允許儲存可跨應用程式共享且不綁定於其他組合物件壽命的鍵值對。 CompositionPropertySet最常用於動畫，它們會維持鍵值對，這些鍵值對被參考以驅動合成動畫的某些部分。 CompositionPropertySet提供插入鍵值對或取得特定鍵值的能力。 欲了解更多關於使用 CompositionPropertySet 搭配動畫的資訊，請參閱 動畫概覽 頁面。

CompositionPropertySet 不支援刪除函式——請務必使用 CompositionPropertySet 來儲存將在整個應用程式間共享的值。

Note

在已存在的鍵值中插入新值，會用新值覆蓋舊值。

屬性

名稱	Description
Comment	一個用來關聯 CompositionObject 的字串。 (繼承來源 CompositionObject)
Compositor	用於建立此 CompositionObject 的合成器。 (繼承來源 CompositionObject)
DispatcherQueue	取得 CompositionObject 的 DispatcherQueue。 (繼承來源 CompositionObject)
ImplicitAnimations	附加於此物件的隱含動畫集合。 (繼承來源 CompositionObject)
Properties	與 CompositionObject 相關聯的屬性集合。 (繼承來源 CompositionObject)

方法

名稱	Description
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)	取得指定的 單一 屬性值。
TryGetVector2(String, Vector2)	取得指定的 Vector2 屬性值。
TryGetVector3(String, Vector3)	取得指定的 Vector3 屬性值。
TryGetVector4(String, Vector4)	取得指定的 Vector4 屬性值。

另請參閱

• CompositionObject
• IClosable