Edit

UIPropertyMetadata.IsAnimationProhibited Property

  • Reference

Definition

Namespace:
System.Windows
Assembly:
PresentationCore.dll

Gets or sets a value declaring whether animations should be disabled on the dependency property where the containing metadata instance is applied.

public:
 property bool IsAnimationProhibited { bool get(); void set(bool value); };
public bool IsAnimationProhibited { get; set; }
member this.IsAnimationProhibited : bool with get, set
Public Property IsAnimationProhibited As Boolean

Property Value

Boolean

true indicates that animations are disallowed; false indicates that animations are allowed. The default is false (animations allowed).

Remarks

In general, the default dependency properties available in the Windows Presentation Foundation (WPF) framework implementation APIs can be animated. You might set this property to true in the metadata of your own custom dependency property to disable animations on it.

If a property with this value true attempts to be used as an animation target, a runtime exception will be raised.

Properties on any derived classes of PropertyMetadata are normally defined in the object model as read-write. This is so they can be adjusted after initialization of the instance. However, once the metadata is consumed as part of a call to Register, AddOwner, or OverrideMetadata, the property system will seal that metadata instance and any properties that convey the specifics of the metadata are now considered immutable. Attempting to set IsAnimationProhibited once IsSealed is true on this metadata instance will raise an exception.

Applies to