Skip to main content

CompositionPropertySet Class

Definition

Assembly:Avalonia.Base
Package:Avalonia

Avalonia.Rendering.Composition.CompositionPropertySets are Avalonia.Rendering.Composition.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. Avalonia.Rendering.Composition.CompositionPropertySets are most commonly used with animations, where they maintain key-value pairs that are referenced to drive portions of composition animations. Avalonia.Rendering.Composition.CompositionPropertySets provide the ability to insert key-value pairs or retrieve a value for a given key. Avalonia.Rendering.Composition.CompositionPropertySet does not support a delete function – ensure you use Avalonia.Rendering.Composition.CompositionPropertySet to store values that will be shared across the application.

public class CompositionPropertySet

Inheritance: object -> CompositionObject -> CompositionPropertySet

Methods

NameDescription
InsertBooleanNo summary available.
InsertColorNo summary available.
InsertMatrix3x2No summary available.
InsertMatrix4x4No summary available.
InsertQuaternionNo summary available.
InsertScalarNo summary available.
InsertVector2No summary available.
InsertVector3No summary available.
InsertVector4No summary available.
TryGetBooleanNo summary available.
TryGetColorNo summary available.
TryGetMatrix3x2No summary available.
TryGetMatrix4x4No summary available.
TryGetQuaternionNo summary available.
TryGetScalarNo summary available.
TryGetVector2No summary available.
TryGetVector3No summary available.
TryGetVector4No summary available.
StartAnimationConnects an animation with the specified property of the object and starts the animation. Inherited from CompositionObject.
StartAnimationGroupStarts an animation group. The StartAnimationGroup method on CompositionObject lets you start CompositionAnimationGroup. All the animations in the group will be started at the same time on the object. Inherited from CompositionObject.
StopAnimationDisconnects an animation from the specified property and stops the animation. Inherited from CompositionObject.
StopAnimationGroupStops an animation group. Inherited from CompositionObject.

InsertBoolean Method

public void InsertBoolean(string propertyName, bool value)

Parameters

propertyName string

value bool

InsertColor Method

public void InsertColor(string propertyName, Avalonia.Media.Color value)

Parameters

propertyName string

value Avalonia.Media.Color

InsertMatrix3x2 Method

public void InsertMatrix3x2(string propertyName, System.Numerics.Matrix3x2 value)

Parameters

propertyName string

value System.Numerics.Matrix3x2

InsertMatrix4x4 Method

public void InsertMatrix4x4(string propertyName, System.Numerics.Matrix4x4 value)

Parameters

propertyName string

value System.Numerics.Matrix4x4

InsertQuaternion Method

public void InsertQuaternion(string propertyName, System.Numerics.Quaternion value)

Parameters

propertyName string

value System.Numerics.Quaternion

InsertScalar Method

public void InsertScalar(string propertyName, float value)

Parameters

propertyName string

value float

InsertVector2 Method

public void InsertVector2(string propertyName, System.Numerics.Vector2 value)

Parameters

propertyName string

value System.Numerics.Vector2

InsertVector3 Method

public void InsertVector3(string propertyName, System.Numerics.Vector3 value)

Parameters

propertyName string

value System.Numerics.Vector3

InsertVector4 Method

public void InsertVector4(string propertyName, System.Numerics.Vector4 value)

Parameters

propertyName string

value System.Numerics.Vector4

TryGetBoolean Method

public Avalonia.Rendering.Composition.CompositionGetValueStatus TryGetBoolean(string propertyName, bool& value)

Parameters

propertyName string

value bool&

Returns

Avalonia.Rendering.Composition.CompositionGetValueStatus

TryGetColor Method

public Avalonia.Rendering.Composition.CompositionGetValueStatus TryGetColor(string propertyName, Avalonia.Media.Color& value)

Parameters

propertyName string

value Avalonia.Media.Color&

Returns

Avalonia.Rendering.Composition.CompositionGetValueStatus

TryGetMatrix3x2 Method

public Avalonia.Rendering.Composition.CompositionGetValueStatus TryGetMatrix3x2(string propertyName, System.Numerics.Matrix3x2& value)

Parameters

propertyName string

value System.Numerics.Matrix3x2&

Returns

Avalonia.Rendering.Composition.CompositionGetValueStatus

TryGetMatrix4x4 Method

public Avalonia.Rendering.Composition.CompositionGetValueStatus TryGetMatrix4x4(string propertyName, System.Numerics.Matrix4x4& value)

Parameters

propertyName string

value System.Numerics.Matrix4x4&

Returns

Avalonia.Rendering.Composition.CompositionGetValueStatus

TryGetQuaternion Method

public Avalonia.Rendering.Composition.CompositionGetValueStatus TryGetQuaternion(string propertyName, System.Numerics.Quaternion& value)

Parameters

propertyName string

value System.Numerics.Quaternion&

Returns

Avalonia.Rendering.Composition.CompositionGetValueStatus

TryGetScalar Method

public Avalonia.Rendering.Composition.CompositionGetValueStatus TryGetScalar(string propertyName, float& value)

Parameters

propertyName string

value float&

Returns

Avalonia.Rendering.Composition.CompositionGetValueStatus

TryGetVector2 Method

public Avalonia.Rendering.Composition.CompositionGetValueStatus TryGetVector2(string propertyName, System.Numerics.Vector2& value)

Parameters

propertyName string

value System.Numerics.Vector2&

Returns

Avalonia.Rendering.Composition.CompositionGetValueStatus

TryGetVector3 Method

public Avalonia.Rendering.Composition.CompositionGetValueStatus TryGetVector3(string propertyName, System.Numerics.Vector3& value)

Parameters

propertyName string

value System.Numerics.Vector3&

Returns

Avalonia.Rendering.Composition.CompositionGetValueStatus

TryGetVector4 Method

public Avalonia.Rendering.Composition.CompositionGetValueStatus TryGetVector4(string propertyName, System.Numerics.Vector4& value)

Parameters

propertyName string

value System.Numerics.Vector4&

Returns

Avalonia.Rendering.Composition.CompositionGetValueStatus

Properties

NameDescription
CompositorThe associated Compositor Inherited from CompositionObject.
ImplicitAnimationsThe collection of implicit animations attached to this object. Inherited from CompositionObject.
IsDisposedInherited from CompositionObject.