IXRDoubleAnimation::SetBy (Compact 2013)

3/28/2014

This method sets the total difference between the starting and ending values of the animation.

Syntax

virtual HRESULT STDMETHODCALLTYPE SetBy(
    __in float By
) = 0;

Parameters

  • By
    [in] A float value that specifies the amount of incremental change for this animation.

Return Value

Returns an HRESULT that indicates success or failure.

Remarks

The following table summarizes how the SetBy, IXRDoubleAnimation::SetFrom, and IXRDoubleAnimation::SetTo methods can be used together or separately to determine the target values of an animation.

Method(s) used by the developer

Resulting behavior

SetFrom

The animation progresses from the value specified in SetFrom to the base value of an animated property, or to the output value of a previous animation, depending on how the previous animation is configured.

SetFrom and SetTo

The animation progresses from the value specified in SetFrom to the value specified in SetTo.

SetFrom and SetBy

The animation progresses from the value specified in SetFrom to the sum of the values specified in SetFrom and SetBy.

SetTo

The animation progresses from the base value of the animated property or from the output value of a previous animation to the value specified in SetTo.

SetBy

The animation progresses from the base value of the animated property or the output value of a previous animation to the sum of that value and the value specified in SetBy.

If you use both the SetTo and SetBy methods, the value specified in SetTo takes precedence and the SetBy property is ignored.

.NET Framework Equivalent

System.Windows.Media.Animation.DoubleAnimation.By

Requirements

Header

XamlRuntime.h

sysgen

SYSGEN_XAML_RUNTIME

See Also

Reference

IXRDoubleAnimation
IXRDoubleAnimation::GetBy