Share via

  • Article

PointAnimation.By Property

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Gets or sets the total amount by which the animation changes its starting value.

Namespace:  System.Windows.Media.Animation
Assembly:  System.Windows (in System.Windows.dll)

Syntax

'Declaration
Public Property By As Nullable(Of Point)

public Nullable<Point> By { get; set; }

<PointAnimation By="x,y"/>

XAML Values

  • x
    The X value of the Point that specifies the animation increment.

  • y
    The Y value of a Point that specifies the animation increment.

Property Value

Type: System.Nullable<Point>
The total amount by which the animation changes its starting value. The default is nulla null reference (Nothing in Visual Basic).

Remarks

Dependency property identifier field: ByProperty

Use the By property when you want to animate a value "by" a certain amount, rather than specifying a starting or ending value. You may also use the By property with the From property. The following table summarizes how the From, To, and By properties can be used together or separately to determine an animation's target values.

Properties Specified

Resulting Behavior

From

The animation progresses from the value specified by the From property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.

From and To

The animation progresses from the value specified by the From property to the value specified by the To property.

From and By

The animation progresses from the value specified by the From property to the value specified by the sum of the From and By properties.

To

The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the To property.

By

The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the By property.

Note   If you set both the To and By properties, the To property takes precedence and the By property is ignored.

To use other interpolation methods or animate between more than two target values, use a PointAnimationUsingKeyFrames object.

To set a PointAnimation attribute to null in XAML, use an attribute value of {x:Null}.

The XAML syntax for this property specifies a new Point as a string. The delimiter between the x and y values of the point can be either a comma or a space. Note that the comma usage has potential to clash with the usage of comma as the decimal point in some UI cultures. For more information, see the "XAML Attribute Syntax" section of Point.

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.