IXRStoryboard::SkipToFill (Compact 2013)
3/28/2014
This method advances a storyboard clock to the end of its active period.
Syntax
virtual HRESULT STDMETHODCALLTYPE SkipToFill() = 0;
Parameters
None.
Return Value
Returns an HRESULT that indicates success or failure.
This method can also return one of the following error messages, which can apply to either the storyboard itself or to its animations in the collection retrieved by IXRStoryboard::GetChildren.
Error message |
Description |
|---|---|
XR_E_STORYBOARD_BEGIN_INVALID_PROPERTY |
XAML for Windows Embedded cannot begin this storyboard. The property to be animated is invalid. |
XR_E_STORYBOARD_BEGIN_INVALID_TARGET |
XAML for Windows Embedded cannot begin this storyboard. The specified target is invalid. |
XR_E_STORYBOARD_BEGIN_NO_TARGET |
XAML for Windows Embedded cannot begin this storyboard. There is no target to animate. |
XR_E_STORYBOARD_BEGIN_INCOMPATIBLE_TYPE |
XAML for Windows Embedded cannot begin this storyboard. There is no conversion available between the target properties and object. |
XR_E_STORYBOARD_BEGIN_ANIMATION_COMPOSITION |
XAML for Windows Embedded cannot compose this animation with the currently running animation. |
XR_E_STORYBOARD_BEGIN_INVALID_KEYTIME |
Invalid keytime specified for the beginning of this storyboard. |
XR_E_STORYBOARD_MUST_BE_ROOT |
Storyboard must be the root element of this timeline collection. |
XR_E_STORYBOARD_SKIPTOFILL_NO_DURATION |
No valid duration specified for this skip-to-fill operation. |
XR_E_STORYBOARD_MODIFY_ACTIVE_ANIMATION |
XAML for Windows Embedded cannot modify this active animation. |
Remarks
If the inherited method IXRTimeline::SetAutoReverse is set to true, then the end of the active period is the starting frame of this storyboard.
If an easing function is applied to the animation, this method jumps straight to the end of the active period, with no interpolation. Custom easing functions must use the value passed as the NormalizedTime reference in the IXREasingFunctionBase::Ease method to calculate where the easing method should be in the animation.
When you use this method, the inherited method IXRTimeline::SetRepeatBehavior must be set to RepeatBehaviorType_Forever.
.NET Framework Equivalent
System.Windows.Media.Animation.Storyboard.SkipToFill
Requirements
Header |
XamlRuntime.h |
sysgen |
SYSGEN_XAML_RUNTIME |