IXRBeginStoryboard (Compact 2013)

3/28/2014

This class represents a trigger action that begins a storyboard and distributes its animations to their targeted objects and properties.

Syntax

class IXRBeginStoryboard : public IXRTriggerAction

Inheritance Hierarchy

IXRDependencyObject

    IXRTriggerAction

        IXRBeginStoryboard

Methods

Method

Description

IXRBeginStoryboard::GetStoryboard

Retrieves the storyboard that this IXRBeginStoryboard object starts in response to an event trigger.

IXRBeginStoryboard::SetStoryboard

Sets the storyboard that this IXRBeginStoryboard object starts in response to an event trigger.

Thread Safety

Members of this class are thread-safe if you previously called IXRApplication::CreateHostFromXaml and supplied it with an XRWindowCreateParams structure that has AllowsMultipleThreadAccess set to true.

Remarks

You use IXRBeginStoryboard as a wrapper around an IXRStoryboard object that is being triggered. An IXRBeginStoryboard object can contain only one IXRStoryboard object, not a collection of them.

You can store multiple IXRBeginStoryboard objects, which each contain a storyboard, in an IXRTriggerActionCollection object that belongs to an IXREventTrigger object. To obtain this collection, call IXREventTrigger::GetActions.

Alternatively, you can use the interactive methods in IXRStoryboard to start, pause, resume, and stop an animation.

When you create a class instance, use an IXRBeginStoryboardPtr smart pointer instead of a raw interface pointer. For more information, see XRPtr<Interface>.

You can also define a begin-storyboard object in Microsoft Silverlight 3 XAML. For information about the differences between XAML in XAML for Windows Embedded and Silverlight 3, see Differences Between Microsoft Silverlight 3 and XAML for Windows Embedded. For more information about how to define this element in the source XAML for your application, see the BeginStoryboard Class on MSDN.

.NET Framework Equivalent

System.Windows.Media.Animation.BeginStoryboard

Requirements

Header

XamlRuntime.h

sysgen

SYSGEN_XAML_RUNTIME

See Also

Reference

Classes for Visual Appearance