BitmapCacheBrush Class

.NET Framework (current version)
 

Paints an area with cached content.

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

System::Object
  System.Windows.Threading::DispatcherObject
    System.Windows::DependencyObject
      System.Windows::Freezable
        System.Windows.Media.Animation::Animatable
          System.Windows.Media::Brush
            System.Windows.Media::BitmapCacheBrush

public ref class BitmapCacheBrush sealed : Brush

NameDescription
System_CAPS_pubmethodBitmapCacheBrush()

Initializes a new instance of the BitmapCacheBrush class.

System_CAPS_pubmethodBitmapCacheBrush(Visual^)

Initializes a new instance of the BitmapCacheBrush class with the specified Visual.

NameDescription
System_CAPS_pubpropertyAutoLayoutContent

Gets or sets a value that indicates whether layout is applied to the contents of this brush.

System_CAPS_pubpropertyBitmapCache

Gets or sets a CacheMode that represents cached content.

System_CAPS_pubpropertyCanFreeze

Gets a value that indicates whether the object can be made unmodifiable. (Inherited from Freezable.)

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_pubpropertyHasAnimatedProperties

Gets a value that indicates whether one or more AnimationClock objects is associated with any of this object's dependency properties.(Inherited from Animatable.)

System_CAPS_pubpropertyIsFrozen

Gets a value that indicates whether the object is currently modifiable. (Inherited from Freezable.)

System_CAPS_pubpropertyIsSealed

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

System_CAPS_pubpropertyOpacity

Gets or sets the degree of opacity of a Brush. (Inherited from Brush.)

System_CAPS_pubpropertyRelativeTransform

Gets or sets the transformation that is applied to the brush using relative coordinates. (Inherited from Brush.)

System_CAPS_pubpropertyTarget

Gets or sets the target visual to cache.

System_CAPS_pubpropertyTransform

Gets or sets the transformation that is applied to the brush. This transformation is applied after the brush's output has been mapped and positioned. (Inherited from Brush.)

NameDescription
System_CAPS_pubmethodApplyAnimationClock(DependencyProperty^, AnimationClock^)

Applies an AnimationClock to the specified DependencyProperty. If the property is already animated, the SnapshotAndReplace handoff behavior is used.(Inherited from Animatable.)

System_CAPS_pubmethodApplyAnimationClock(DependencyProperty^, AnimationClock^, HandoffBehavior)

Applies an AnimationClock to the specified DependencyProperty. If the property is already animated, the specified HandoffBehavior is used.(Inherited from Animatable.)

System_CAPS_pubmethodBeginAnimation(DependencyProperty^, AnimationTimeline^)

Applies an animation to the specified DependencyProperty. The animation is started when the next frame is rendered. If the specified property is already animated, the SnapshotAndReplace handoff behavior is used.(Inherited from Animatable.)

System_CAPS_pubmethodBeginAnimation(DependencyProperty^, AnimationTimeline^, HandoffBehavior)

Applies an animation to the specified DependencyProperty. The animation is started when the next frame is rendered. If the specified property is already animated, the specified HandoffBehavior is used. (Inherited from Animatable.)

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 BitmapCacheBrush, 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_pubmethodCloneCurrentValue()

Creates a modifiable clone (deep copy) of the BitmapCacheBrush using its current 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_pubmethodEquals(Object^)

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

System_CAPS_pubmethodFreeze()

Makes the current object unmodifiable and sets its IsFrozen property to true. (Inherited from Freezable.)

System_CAPS_pubmethodGetAnimationBaseValue(DependencyProperty^)

Returns the non-animated value of the specified DependencyProperty.(Inherited from Animatable.)

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. (Inherited from Freezable.)

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.(Inherited from Freezable.)

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_pubmethodReadLocalValue(DependencyProperty^)

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

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()

Return string representation of this Brush. (Inherited from Brush.)

System_CAPS_pubmethodToString(IFormatProvider^)

Creates a string representation of this object based on the specified culture-specific formatting information. (Inherited from Brush.)

System_CAPS_pubmethodVerifyAccess()

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

NameDescription
System_CAPS_pubfieldSystem_CAPS_staticAutoLayoutContentProperty

Identifies the AutoLayoutContent dependency property.

System_CAPS_pubfieldSystem_CAPS_staticBitmapCacheProperty

Identifies the BitmapCache dependency property.

System_CAPS_pubfieldSystem_CAPS_staticTargetProperty

Identifies the Target dependency property.

NameDescription
System_CAPS_pubeventChanged

Occurs when the Freezable or an object it contains is modified. (Inherited from Freezable.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIFormattable::ToString(String^, IFormatProvider^)

Formats the value of the current instance using the specified format.(Inherited from Brush.)

Use the BitmapCacheBrush class to reuse a cached element efficiently. This is useful when you need to paint complex content onto multiple elements. Use the BitmapCache class to cache a complex element.

Assign a Visual to the Target property and optionally assign a BitmapCache to the BitmapCache property. The CacheMode of the brush and the target Visual interact to produce different behaviors. The following table describes this interaction.

Target has no CacheMode

Target has CacheMode

Brush has no CacheMode

Target visual renders normally; brush uses default cache behavior.

Target visual renders into its own cache; brush uses target’s cache when rendering.

Brush has CacheMode

Target visual renders normally; brush renders target into its own cache and uses this to render.

Target visual renders into its own cache; brush renders target into brush's own cache and uses this to render.

The BitmapCacheBrush class is similar to the VisualBrush class, but BitmapCacheBrush always renders from a cache on the target element, or from a cache defined by the BitmapCache property. The BitmapCacheBrush class also supports dirty regions.

The following table shows the default bitmap cache settings for the BitmapCacheBrush class.

Bitmap Cache Property

Default Setting

SnapsToDevicePixels

false

EnableClearType

false

RenderAtScale

1

The SnapsToDevicePixels property is ignored by the BitmapCacheBrush class.

The BitmapCacheBrush class ignores the following properties on the root Visual. This behavior differs from the VisualBrush class.

The following code example shows how to associate a BitmapCache with a BitmapCacheBrush. You can use the BitmapCacheBrush resource on multiple elements and achieve good performance. For the complete code listing, see How to: Use a Cached Element as a Brush.

<Window.Resources>
    <RichTextBox x:Key="cachedRichTextBox"  >
        <RichTextBox.CacheMode>
            <BitmapCache EnableClearType="True" RenderAtScale="1" SnapsToDevicePixels="True" />
        </RichTextBox.CacheMode>
    </RichTextBox>

    <BitmapCacheBrush x:Key="cachedRichTextBoxBrush" Target="{StaticResource cachedRichTextBox}">
        <BitmapCacheBrush.BitmapCache>
            <BitmapCache EnableClearType="False" RenderAtScale="0.4" SnapsToDevicePixels="False" />
        </BitmapCacheBrush.BitmapCache>
    </BitmapCacheBrush>        
</Window.Resources>

.NET Framework
Available since 4.0

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: