Animatable::FreezeCore Method (Boolean)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Makes this Animatable object unmodifiable or determines whether it can be made unmodifiable.

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

protected:
virtual bool FreezeCore(
	bool isChecking
) override

Parameters

isChecking
Type: System::Boolean

true if this method should simply determine whether this instance can be frozen. false if this instance should actually freeze itself when this method is called.

Return Value

Type: System::Boolean

If isChecking is true, this method returns true if this Animatable can be made unmodifiable, or false if it cannot be made unmodifiable.

If isChecking is false, this method returns true if the if this Animatable is now unmodifiable, or false if it cannot be made unmodifiable, with the side effect of having begun to change the frozen status of this object.

This method will return false when HasAnimatedProperties is true.

Do not call this method directly (except when calling base in an implementation). This method is called internally by CanFreeze (with isChecking equal to true) and Freeze (with isChecking equal to false).

Notes to Implementers:

Classes that derive from Animatable must override this method when the class contains data that is not stored using dependency properties.

A typical implementation would call the base implementation, then call the static Freeze method on all Freezable typed properties that the class contains, returning true only if all properties were frozen (or could have been frozen, in the case of passing through a false value for isChecking).

.NET Framework
Available since 3.0
Return to top
Show: