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，允許儲存可在應用程式間共用的索引鍵值組，而且不會系結至另一個組合物件的存留期。 CompositionPropertySets 最常與動畫搭配使用，其中會維護參考組合動畫部分的索引鍵/值組。 CompositionPropertySets 可讓您插入索引鍵/值組，或擷取指定索引鍵的值。 如需搭配動畫使用 CompositionPropertySet 的詳細資訊，請參閱 動畫概觀 頁面。

CompositionPropertySet 不支援刪除函式 – 請確定您使用 CompositionPropertySet 來儲存將在應用程式間共用的值。

注意

針對已經存在的索引鍵，將新值插入 CompositionPropertySet 中，將會以新的值覆寫舊值。

屬性

Comment	要與 CompositionObject 建立關聯的字串。 (繼承來源 CompositionObject)
Compositor	用來建立這個CompositionObject的Compositor。 (繼承來源 CompositionObject)
DispatcherQueue	取得 CompositionObject 的 DispatcherQueue。 (繼承來源 CompositionObject)
ImplicitAnimations	附加至這個 物件的隱含動畫集合。 (繼承來源 CompositionObject)
Properties	與 CompositionObject相關聯的屬性集合。 (繼承來源 CompositionObject)

方法

Close()	關閉 CompositionObject 並釋放系統資源。 (繼承來源 CompositionObject)
Dispose()	執行與釋放 (Free)、釋放 (Release) 或重設 Unmanaged 資源相關聯之應用程式定義的工作。 (繼承來源 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)	將動畫與物件的指定屬性連接，並啟動動畫。 (繼承來源 CompositionObject)
StartAnimation(String, CompositionAnimation, AnimationController)	將動畫與物件的指定屬性連接，並啟動動畫。 (繼承來源 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 屬性值。

另請參閱

• CompositionObject
• IClosable