Freezable Class
TOC
Collapse the table of content
Expand the table of content

Freezable Class

 

Defines an object that has a modifiable state and a read-only (frozen) state. Classes that derive from Freezable provide detailed change notification, can be made immutable, and can clone themselves.

Namespace:   System.Windows
Assembly:  WindowsBase (in WindowsBase.dll)

System::Object
  System.Windows.Threading::DispatcherObject
    System.Windows::DependencyObject
      System.Windows::Freezable
        System.Windows.Controls.Ribbon::RibbonControlSizeDefinition
        System.Windows.Controls.Ribbon::RibbonGroupSizeDefinitionBase
        System.Windows.Input::InputBinding
        System.Windows.Media.Animation::Animatable
        System.Windows.Media.Animation::BooleanKeyFrame
        System.Windows.Media.Animation::BooleanKeyFrameCollection
        System.Windows.Media.Animation::ByteKeyFrame
        System.Windows.Media.Animation::ByteKeyFrameCollection
        System.Windows.Media.Animation::CharKeyFrame
        System.Windows.Media.Animation::CharKeyFrameCollection
        System.Windows.Media.Animation::ColorKeyFrame
        System.Windows.Media.Animation::ColorKeyFrameCollection
        System.Windows.Media.Animation::DecimalKeyFrame
        System.Windows.Media.Animation::DecimalKeyFrameCollection
        System.Windows.Media.Animation::DoubleKeyFrame
        System.Windows.Media.Animation::DoubleKeyFrameCollection
        System.Windows.Media.Animation::EasingFunctionBase
        System.Windows.Media.Animation::Int16KeyFrame
        System.Windows.Media.Animation::Int16KeyFrameCollection
        System.Windows.Media.Animation::Int32KeyFrame
        System.Windows.Media.Animation::Int32KeyFrameCollection
        System.Windows.Media.Animation::Int64KeyFrame
        System.Windows.Media.Animation::Int64KeyFrameCollection
        System.Windows.Media.Animation::KeySpline
        System.Windows.Media.Animation::MatrixKeyFrame
        System.Windows.Media.Animation::MatrixKeyFrameCollection
        System.Windows.Media.Animation::ObjectKeyFrame
        System.Windows.Media.Animation::ObjectKeyFrameCollection
        System.Windows.Media.Animation::Point3DKeyFrame
        System.Windows.Media.Animation::Point3DKeyFrameCollection
        System.Windows.Media.Animation::PointKeyFrame
        System.Windows.Media.Animation::PointKeyFrameCollection
        System.Windows.Media.Animation::QuaternionKeyFrame
        System.Windows.Media.Animation::QuaternionKeyFrameCollection
        System.Windows.Media.Animation::RectKeyFrame
        System.Windows.Media.Animation::RectKeyFrameCollection
        System.Windows.Media.Animation::Rotation3DKeyFrame
        System.Windows.Media.Animation::Rotation3DKeyFrameCollection
        System.Windows.Media.Animation::SingleKeyFrame
        System.Windows.Media.Animation::SingleKeyFrameCollection
        System.Windows.Media.Animation::SizeKeyFrame
        System.Windows.Media.Animation::SizeKeyFrameCollection
        System.Windows.Media.Animation::StringKeyFrame
        System.Windows.Media.Animation::StringKeyFrameCollection
        System.Windows.Media.Animation::ThicknessKeyFrame
        System.Windows.Media.Animation::ThicknessKeyFrameCollection
        System.Windows.Media.Animation::Vector3DKeyFrame
        System.Windows.Media.Animation::Vector3DKeyFrameCollection
        System.Windows.Media.Animation::VectorKeyFrame
        System.Windows.Media.Animation::VectorKeyFrameCollection
        System.Windows.Media::DoubleCollection
        System.Windows.Media::ImageMetadata
        System.Windows.Media::Int32Collection
        System.Windows.Media.Media3D::GeneralTransform2DTo3D
        System.Windows.Media.Media3D::GeneralTransform3DTo2D
        System.Windows.Media.Media3D::Point3DCollection
        System.Windows.Media.Media3D::Vector3DCollection
        System.Windows.Media::PointCollection
        System.Windows.Media::VectorCollection
        System.Windows.Shell::TaskbarItemInfo
        System.Windows.Shell::ThumbButtonInfo
        System.Windows.Shell::WindowChrome

public ref class Freezable abstract : DependencyObject

NameDescription
System_CAPS_protmethodFreezable()

Initializes a new instance of a Freezable derived class.

NameDescription
System_CAPS_pubpropertyCanFreeze

Gets a value that indicates whether the object can be made unmodifiable.

System_CAPS_pubpropertyDependencyObjectType

Gets the DependencyObjectType that wraps the CLR type of this instance. (Inherited from DependencyObject.)

System_CAPS_pubpropertyDispatcher

Gets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.)

System_CAPS_pubpropertyIsFrozen

Gets a value that indicates whether the object is currently modifiable.

System_CAPS_pubpropertyIsSealed

Gets a value that indicates whether this instance is currently sealed (read-only).(Inherited from DependencyObject.)

NameDescription
System_CAPS_pubmethodCheckAccess()

Determines whether the calling thread has access to this DispatcherObject.(Inherited from DispatcherObject.)

System_CAPS_pubmethodClearValue(DependencyProperty^)

Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier. (Inherited from DependencyObject.)

System_CAPS_pubmethodClearValue(DependencyPropertyKey^)

Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey. (Inherited from DependencyObject.)

System_CAPS_pubmethodClone()

Creates a modifiable clone of the Freezable, making deep copies of the object's values. When copying the object's dependency properties, this method copies expressions (which might no longer resolve) but not animations or their current values.

System_CAPS_protmethodCloneCore(Freezable^)

Makes the instance a clone (deep copy) of the specified Freezable using base (non-animated) property values.

System_CAPS_pubmethodCloneCurrentValue()

Creates a modifiable clone (deep copy) of the Freezable using its current values.

System_CAPS_protmethodCloneCurrentValueCore(Freezable^)

Makes the instance a modifiable clone (deep copy) of the specified Freezable using current property values.

System_CAPS_pubmethodCoerceValue(DependencyProperty^)

Coerces the value of the specified dependency property. This is accomplished by invoking any CoerceValueCallback function specified in property metadata for the dependency property as it exists on the calling DependencyObject.(Inherited from DependencyObject.)

System_CAPS_protmethodCreateInstance()

Initializes a new instance of the Freezable class.

System_CAPS_protmethodCreateInstanceCore()

When implemented in a derived class, creates a new instance of the Freezable derived class.

System_CAPS_pubmethodEquals(Object^)

Determines whether a provided DependencyObject is equivalent to the current DependencyObject.(Inherited from DependencyObject.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodFreeze()

Makes the current object unmodifiable and sets its IsFrozen property to true.

System_CAPS_protmethodSystem_CAPS_staticFreeze(Freezable^, Boolean)

If the isChecking parameter is true, this method indicates whether the specified Freezable can be made unmodifiable. If the isChecking parameter is false, this method attempts to make the specified Freezable unmodifiable and indicates whether the operation succeeded.

System_CAPS_protmethodFreezeCore(Boolean)

Makes the Freezable object unmodifiable or tests whether it can be made unmodifiable.

System_CAPS_pubmethodGetAsFrozen()

Creates a frozen copy of the Freezable, using base (non-animated) property values. Because the copy is frozen, any frozen sub-objects are copied by reference.

System_CAPS_protmethodGetAsFrozenCore(Freezable^)

Makes the instance a frozen clone of the specified Freezable using base (non-animated) property values.

System_CAPS_pubmethodGetCurrentValueAsFrozen()

Creates a frozen copy of the Freezable using current property values. Because the copy is frozen, any frozen sub-objects are copied by reference.

System_CAPS_protmethodGetCurrentValueAsFrozenCore(Freezable^)

Makes the current instance a frozen clone of the specified Freezable. If the object has animated dependency properties, their current animated values are copied.

System_CAPS_pubmethodGetHashCode()

Gets a hash code for this DependencyObject.(Inherited from DependencyObject.)

System_CAPS_pubmethodGetLocalValueEnumerator()

Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject. (Inherited from DependencyObject.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodGetValue(DependencyProperty^)

Returns the current effective value of a dependency property on this instance of a DependencyObject. (Inherited from DependencyObject.)

System_CAPS_pubmethodInvalidateProperty(DependencyProperty^)

Re-evaluates the effective value for the specified dependency property(Inherited from DependencyObject.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_protmethodOnChanged()

Called when the current Freezable object is modified.

System_CAPS_protmethodOnFreezablePropertyChanged(DependencyObject^, DependencyObject^)

Ensures that appropriate context pointers are established for a DependencyObjectType data member that has just been set.

System_CAPS_protmethodOnFreezablePropertyChanged(DependencyObject^, DependencyObject^, DependencyProperty^)

This member supports the Windows Presentation Foundation (WPF) infrastructure and is not intended to be used directly from your code.

System_CAPS_protmethodOnPropertyChanged(DependencyPropertyChangedEventArgs)

Overrides the DependencyObject implementation of OnPropertyChanged to also invoke any Changed handlers in response to a changing dependency property of type Freezable.(Overrides DependencyObject::OnPropertyChanged(DependencyPropertyChangedEventArgs).)

System_CAPS_pubmethodReadLocalValue(DependencyProperty^)

Returns the local value of a dependency property, if it exists. (Inherited from DependencyObject.)

System_CAPS_protmethodReadPreamble()

Ensures that the Freezable is being accessed from a valid thread. Inheritors of Freezable must call this method at the beginning of any API that reads data members that are not dependency properties.

System_CAPS_pubmethodSetCurrentValue(DependencyProperty^, Object^)

Sets the value of a dependency property without changing its value source. (Inherited from DependencyObject.)

System_CAPS_pubmethodSetValue(DependencyProperty^, Object^)

Sets the local value of a dependency property, specified by its dependency property identifier. (Inherited from DependencyObject.)

System_CAPS_pubmethodSetValue(DependencyPropertyKey^, Object^)

Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property. (Inherited from DependencyObject.)

System_CAPS_protmethodShouldSerializeProperty(DependencyProperty^)

Returns a value that indicates whether serialization processes should serialize the value for the provided dependency property.(Inherited from DependencyObject.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

System_CAPS_pubmethodVerifyAccess()

Enforces that the calling thread has access to this DispatcherObject.(Inherited from DispatcherObject.)

System_CAPS_protmethodWritePostscript()

Raises the Changed event for the Freezable and invokes its OnChanged method. Classes that derive from Freezable should call this method at the end of any API that modifies class members that are not stored as dependency properties.

System_CAPS_protmethodWritePreamble()

Verifies that the Freezable is not frozen and that it is being accessed from a valid threading context. Freezable inheritors should call this method at the beginning of any API that writes to data members that are not dependency properties.

NameDescription
System_CAPS_pubeventChanged

Occurs when the Freezable or an object it contains is modified.

The Freezable class provides special features that can help improve application performance when using objects that are expensive to modify or copy. Examples of Freezable objects include the following:

A class that derives from Freezable gains the following features:

  • Special states: a read-only (frozen) state and a writable state.

  • Thread safety: a frozen Freezable object can be shared across threads.

  • Detailed change notification: Unlike other DependencyObject objects, a Freezable object provides change notifications when sub-property values change.

  • Easy cloning: the Freezable class has already implemented several methods that produce deep clones.

For information on using and creating your own Freezable objects, see Freezable Objects Overview.

.NET Framework
Available since 3.0

Any public static members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

When the IsFrozen property is false, a Freezable object can be accessed only from the thread on which it was created. Attempting to access it from another thread throws an InvalidOperationException. The Dispatcher::Invoke and Dispatcher::BeginInvoke methods provide support for marshalling to the correct thread.

When their IsFrozen property is true, Freezable objects are free-threaded. For more information, see Freezable Objects Overview.

Return to top
Show:
© 2016 Microsoft