Class CompositionPropertySet

Namespace

Avalonia.Rendering.Composition

Assembly

Avalonia.Base.dll

CompositionPropertySets are CompositionObjects 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. CompositionPropertySet does not support a delete function – ensure you use CompositionPropertySet to store values that will be shared across the application.

public sealed class CompositionPropertySet : CompositionObject

Inheritance

object

CompositionObject

CompositionPropertySet

Inherited Members

CompositionObject.StartAnimation(string, CompositionAnimation)

CompositionObject.StartAnimationGroup(ICompositionAnimationBase)

CompositionObject.ImplicitAnimations

CompositionObject.Compositor

CompositionObject.IsDisposed

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Methods

InsertBoolean(string, bool)

public void InsertBoolean(string propertyName, bool value)

Parameters

propertyName string

value bool

InsertColor(string, Color)

public void InsertColor(string propertyName, Color value)

Parameters

propertyName string

value Color

InsertMatrix3x2(string, Matrix3x2)

public void InsertMatrix3x2(string propertyName, Matrix3x2 value)

Parameters

propertyName string

value Matrix3x2

InsertMatrix4x4(string, Matrix4x4)

public void InsertMatrix4x4(string propertyName, Matrix4x4 value)

Parameters

propertyName string

value Matrix4x4

InsertQuaternion(string, Quaternion)

public void InsertQuaternion(string propertyName, Quaternion value)

Parameters

propertyName string

value Quaternion

InsertScalar(string, float)

public void InsertScalar(string propertyName, float value)

Parameters

propertyName string

value float

InsertVector2(string, Vector2)

public void InsertVector2(string propertyName, Vector2 value)

Parameters

propertyName string

value Vector2

InsertVector3(string, Vector3)

public void InsertVector3(string propertyName, Vector3 value)

Parameters

propertyName string

value Vector3

InsertVector4(string, Vector4)

public void InsertVector4(string propertyName, Vector4 value)

Parameters

propertyName string

value Vector4

TryGetBoolean(string, out bool)

public CompositionGetValueStatus TryGetBoolean(string propertyName, out bool value)

Parameters

propertyName string

value bool

Returns

CompositionGetValueStatus

TryGetColor(string, out Color)

public CompositionGetValueStatus TryGetColor(string propertyName, out Color value)

Parameters

propertyName string

value Color

Returns

CompositionGetValueStatus

TryGetMatrix3x2(string, out Matrix3x2)

public CompositionGetValueStatus TryGetMatrix3x2(string propertyName, out Matrix3x2 value)

Parameters

propertyName string

value Matrix3x2

Returns

CompositionGetValueStatus

TryGetMatrix4x4(string, out Matrix4x4)

public CompositionGetValueStatus TryGetMatrix4x4(string propertyName, out Matrix4x4 value)

Parameters

propertyName string

value Matrix4x4

Returns

CompositionGetValueStatus

TryGetQuaternion(string, out Quaternion)

public CompositionGetValueStatus TryGetQuaternion(string propertyName, out Quaternion value)

Parameters

propertyName string

value Quaternion

Returns

CompositionGetValueStatus

TryGetScalar(string, out float)

public CompositionGetValueStatus TryGetScalar(string propertyName, out float value)

Parameters

propertyName string

value float

Returns

CompositionGetValueStatus

TryGetVector2(string, out Vector2)

public CompositionGetValueStatus TryGetVector2(string propertyName, out Vector2 value)

Parameters

propertyName string

value Vector2

Returns

CompositionGetValueStatus

TryGetVector3(string, out Vector3)

public CompositionGetValueStatus TryGetVector3(string propertyName, out Vector3 value)

Parameters

propertyName string

value Vector3

Returns

CompositionGetValueStatus

TryGetVector4(string, out Vector4)

public CompositionGetValueStatus TryGetVector4(string propertyName, out Vector4 value)

Parameters

propertyName string

value Vector4

Returns

CompositionGetValueStatus