Share via


IXRColorAnimation::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 COLORREF By
) = 0;

Parameters

  • By
    [in] The COLORREF value that indicates the total difference between the starting and ending values of the animation.

Return Value

Returns an HRESULT that returns S_OK if successful; otherwise, returns a non-zero error code.

Remarks

Use this method to animate a value by a specific amount, instead of specifying a starting or ending value. You can also use this method with the SetFrom method. For more information, see the Remarks section in IXRColorAnimation.

You can use the RGB macro or the RGBA macro to create a color value to supply to this method.

.NET Framework Equivalent

System.Windows.Media.Animation.ColorAnimation.By

Requirements

Header

XamlRuntime.h

sysgen

SYSGEN_XAML_RUNTIME

See Also

Reference

IXRColorAnimation
IXRColorAnimation::GetBy