CompositionPropertySet CompositionPropertySet CompositionPropertySet CompositionPropertySet Class

Definition

public : sealed class CompositionPropertySet : CompositionObject

struct winrt::Windows::UI::Composition::CompositionPropertySet : CompositionObject

public sealed class CompositionPropertySet : CompositionObject

Public NotInheritable Class CompositionPropertySet Inherits CompositionObject

Inheritance

CompositionObjectCompositionObject

CompositionPropertySetCompositionPropertySetCompositionPropertySetCompositionPropertySet

Attributes

ContractVersionAttribute DualApiPartitionAttribute MarshalingBehaviorAttribute ThreadingAttribute WebHostHiddenAttribute

Windows 10 requirements

Examples

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

Remarks

CompositionPropertySets are CompositionObject s that allow storage of key values pairs that can be shared across the application and are not tied to the lifetime of another composition object. CompositionPropertySets are most commonly used with animations, where they maintain key-value pairs that are referenced to drive portions of composition animations. CompositionPropertySets provide the ability to insert key-value pairs or retrieve a value for a given key. For more information on using CompositionPropertySet with animations, see the Animations Overview page.

CompositionPropertySet does not support a delete function – ensure you use CompositionPropertySet to store values that will be shared across the application.

Version history

Methods

Properties

See also

• CompositionObject CompositionObject
• IClosable