CompositionBatchCompletedEventArgs Class

Definition

Namespace:

Microsoft.UI.Composition

Arguments for the CompositionCommitBatch.Completed or CompositionScopedBatch.Completed events.

public ref class CompositionBatchCompletedEventArgs 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 CompositionBatchCompletedEventArgs 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 CompositionBatchCompletedEventArgs : CompositionObject

Public NotInheritable Class CompositionBatchCompletedEventArgs
Inherits CompositionObject

Inheritance

Object Platform::Object IInspectable CompositionObject CompositionBatchCompletedEventArgs

Attributes

ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Examples

    private void CreateVisuals_Click(object sender, RoutedEventArgs e)
    {
        //Create Scoped batch for animations
        _batch = _compositor.CreateScopedBatch(CompositionBatchTypes.Animation);

        //Setup completion event 
        _batch.Completed += ScopedBatchCompleted;


        //Setup animations
        Animation1(_target);

        _batch.End()
    }

    // Creates and defines the key frame animation 
    private void Animation1(Visual targetVisual)
    {
        var animation1 = _compositor.CreateVector3KeyFrameAnimation();

        animation1.InsertKeyFrame(0.0f, new Vector3(100.00f, 100.00f, 0.00f));
        animation1.InsertKeyFrame(0.5f, new Vector3(300.00f, 100.00f, 0.00f));
        animation1.InsertKeyFrame(1.0f, new Vector3(500.00f, 100.00f, 0.00f));

        animation1.Duration = TimeSpan.FromMilliseconds(2000);
        targetVisual.StartAnimation("Offset", animation1);
    }

    public void ScopedBatchCompleted(object sender, 
        CompositionBatchCompletedEventArgs args)
    {
        _root.Children.Remove(_target);
    }      
}

Properties

Comment	A string to associate with the CompositionObject. (Inherited from CompositionObject)
Compositor	The Compositor used to create this CompositionObject. (Inherited from CompositionObject)
DispatcherQueue	Gets the DispatcherQueue for the CompositionObject. (Inherited from CompositionObject)
ImplicitAnimations	The collection of implicit animations attached to this object. (Inherited from CompositionObject)
Properties	The collection of properties associated with the CompositionObject. (Inherited from CompositionObject)

Methods

Close()	Closes the CompositionObject and releases system resources. (Inherited from CompositionObject)
Dispose()	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from CompositionObject)
PopulatePropertyInfo(String, AnimationPropertyInfo)	Defines a property that can be animated. (Inherited from CompositionObject)
StartAnimation(String, CompositionAnimation, AnimationController)	Connects an animation with the specified property of the object and starts the animation. (Inherited from CompositionObject)
StartAnimation(String, CompositionAnimation)	Connects an animation with the specified property of the object and starts the animation. (Inherited from CompositionObject)
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. (Inherited from CompositionObject)
StopAnimation(String)	Disconnects an animation from the specified property and stops the animation. (Inherited from CompositionObject)
StopAnimationGroup(ICompositionAnimationBase)	Stops an animation group. (Inherited from CompositionObject)
TryGetAnimationController(String)	Returns an AnimationController for the animation running on the specified property. (Inherited from CompositionObject)

See also

• CompositionObject
• Composition Animations Overview
• IClosable