Class CompositionObject

Namespace

Avalonia.Rendering.Composition

Assembly

Avalonia.Base.dll

Base class of the composition API representing a node in the visual tree structure. Composition objects are the visual tree structure on which all other features of the composition API use and build on. The API allows developers to define and create one or many CompositionVisual objects each representing a single node in a Visual tree.

public abstract class CompositionObject

Inheritance

object

CompositionObject

Derived

CompositionAnimation

CompositionAnimationGroup

ImplicitAnimationCollection

CompositionPropertySet

CompositionSurface

CompositionVisual

CompositionVisualCollection

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Properties

Compositor

The associated Compositor

public Compositor Compositor { get; }

Property Value

Compositor

ImplicitAnimations

The collection of implicit animations attached to this object.

public ImplicitAnimationCollection? ImplicitAnimations { get; set; }

Property Value

ImplicitAnimationCollection

IsDisposed

public bool IsDisposed { get; }

Property Value

bool

Methods

Dispose()

protected void Dispose()

RegisterForSerialization()

protected void RegisterForSerialization()

StartAnimation(string, CompositionAnimation)

Connects an animation with the specified property of the object and starts the animation.

public void StartAnimation(string propertyName, CompositionAnimation animation)

Parameters

propertyName string

animation CompositionAnimation

StartAnimationGroup(ICompositionAnimationBase)

Starts 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.

public void StartAnimationGroup(ICompositionAnimationBase grp)

Parameters

grp ICompositionAnimationBase