Skip to main content
VisualBrush Class
 

Paints an area with a .

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

Inheritance Hierarchy
SystemObject
   System.Windows.ThreadingDispatcherObject
     System.WindowsDependencyObject
       System.WindowsFreezable
         System.Windows.Media.AnimationAnimatable
           System.Windows.MediaBrush
             System.Windows.MediaTileBrush
              System.Windows.MediaVisualBrush

Syntax
public sealed class VisualBrush : TileBrush
public ref class VisualBrush sealed : TileBrush
[<Sealed>]
type VisualBrush = 
    class
        inherit TileBrush
    end
Public NotInheritable Class VisualBrush
	Inherits TileBrush
Constructors
NameDescription
System_CAPS_pubmethod VisualBrush

Initializes a new instance of the VisualBrush class.

System_CAPS_pubmethod VisualBrush

Initializes a new instance of the VisualBrush class that contains the specified .

Properties
NameDescription
System_CAPS_pubproperty

Gets or sets the horizontal alignment of content in the TileBrush base tile. (Inherited from TileBrush.)

System_CAPS_pubproperty

Gets or sets the vertical alignment of content in the TileBrush base tile. (Inherited from TileBrush.)

System_CAPS_pubproperty

Gets or sets a value that specifies whether this VisualBrush will run layout its .

System_CAPS_pubproperty

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

System_CAPS_pubproperty

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

System_CAPS_pubproperty

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

System_CAPS_pubproperty

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_pubproperty

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

System_CAPS_pubproperty

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

System_CAPS_pubproperty

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

System_CAPS_pubproperty

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

System_CAPS_pubproperty

Gets or sets a value that specifies how the content of this TileBrush stretches to fit its tiles. (Inherited from TileBrush.)

System_CAPS_pubproperty

Gets or sets a value that specifies how a TileBrush fills the area that you are painting if the base tile is smaller than the output area. (Inherited from TileBrush.)

System_CAPS_pubproperty

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

System_CAPS_pubproperty

Gets or sets the position and dimensions of the content in a TileBrush tile. (Inherited from TileBrush.)

System_CAPS_pubproperty

Gets or sets a value that specifies whether the value is relative to the bounding box of the TileBrush contents or whether the value is absolute. (Inherited from TileBrush.)

System_CAPS_pubproperty

Gets or sets the position and dimensions of the base tile for a TileBrush. (Inherited from TileBrush.)

System_CAPS_pubproperty

Gets or sets a BrushMappingMode enumeration that specifies whether the value of the , which indicates the size and position of the TileBrush base tile, is relative to the size of the output area. (Inherited from TileBrush.)

System_CAPS_pubproperty

Gets or sets the brush's content.

Methods
NameDescription
System_CAPS_pubmethod ApplyAnimationClock

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

System_CAPS_pubmethod ApplyAnimationClock

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

System_CAPS_pubmethod BeginAnimation

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_pubmethod BeginAnimation

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_pubmethod CheckAccess

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

System_CAPS_pubmethod ClearValue

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

System_CAPS_pubmethod ClearValue

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

System_CAPS_pubmethod Clone

Creates a modifiable clone of this VisualBrush, making deep copies of this object's values.

System_CAPS_pubmethod CloneCurrentValue

Creates a modifiable clone of this VisualBrush object, making deep copies of this object's current values. Resource references, data bindings, and animations are not copied, but their current values are.

System_CAPS_pubmethod CoerceValue

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_pubmethod Equals

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

System_CAPS_pubmethod Freeze

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

System_CAPS_pubmethod GetAnimationBaseValue

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

System_CAPS_pubmethod GetAsFrozen

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_pubmethod GetCurrentValueAsFrozen

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_pubmethod GetHashCode

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

System_CAPS_pubmethod GetLocalValueEnumerator

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

System_CAPS_pubmethod GetType

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

System_CAPS_pubmethod GetValue

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

System_CAPS_pubmethod InvalidateProperty

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

System_CAPS_pubmethod ReadLocalValue

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

System_CAPS_pubmethod SetCurrentValue

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

System_CAPS_pubmethod SetValue

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

System_CAPS_pubmethod SetValue

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

System_CAPS_protmethod ShouldSerializeProperty

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

System_CAPS_pubmethod ToString

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

System_CAPS_pubmethod ToString

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

System_CAPS_pubmethod VerifyAccess

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

Fields
NameDescription
System_CAPS_pubfield System_CAPS_static AutoLayoutContentProperty

Identifies the  dependency property.

System_CAPS_pubfield System_CAPS_static VisualProperty

Identifies the  dependency property.

Events
NameDescription
System_CAPS_pubevent Changed

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

Explicit Interface Implementations
NameDescription
System_CAPS_pubinterface System_CAPS_privmethod IFormattableToString

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

Remarks

There are two ways to specify the content of a VisualBrush.

  • Create a new Visual and use it to set the property of the VisualBrush.

  • Use an existing Visual, which creates a duplicate image of the target Visual. You can then use the VisualBrush to create interesting effects, such as reflection and magnification.

When you define a new for a VisualBrush and that Visual is a UIElement (such as a panel or control), the layout system runs on the UIElement and its child elements when the property is set to true. However, the root UIElement is essentially isolated from the rest of the system; styles, storyboards, and external layout can't permeate this boundary. Therefore, you should explicitly specify the size of the root UIElement, because its only parent is the VisualBrush and therefore it cannot automatically size itself to the area being painted. For more information about layout in Windows Presentation Foundation (WPF), see the Layout.

Updates to the visual tree of a VisualBrush will not propagate if a BitmapEffect is in the brush's parent chain. You can workaround this limitation by forcing an update of the scene on the object above the effect. You can call InvalidateVisual or include an animation to force a scene update.

Freezable Features: Because it inherits from the Freezable class, the VisualBrush class provides several special features: VisualBrush objects can be declared as and shared among multiple objects. For more information about the different features provided by Freezable objects, see the Freezable Objects Overview.

System_CAPS_noteNote

A VisualBrush cannot be made read-only (frozen) when its property is set to any value other than null.

Version Information
.NET Framework
Available since 3.0
Thread Safety

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