VisualBrush Class
Paints an area with a Visual.
Assembly: PresentationCore (in PresentationCore.dll)
| Name | Description | |
|---|---|---|
![]() | VisualBrush() | Initializes a new instance of the VisualBrush class. |
![]() | VisualBrush(Visual^) | Initializes a new instance of the VisualBrush class that contains the specified Visual. |
| Name | Description | |
|---|---|---|
![]() | AlignmentX | |
![]() | AlignmentY | |
![]() | AutoLayoutContent | Gets or sets a value that specifies whether this VisualBrush will run layout its Visual. |
![]() | CanFreeze | Gets a value that indicates whether the object can be made unmodifiable. (Inherited from Freezable.) |
![]() | DependencyObjectType | Gets the DependencyObjectType that wraps the CLR type of this instance. (Inherited from DependencyObject.) |
![]() | Dispatcher | Gets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.) |
![]() | HasAnimatedProperties | Gets a value that indicates whether one or more AnimationClock objects is associated with any of this object's dependency properties.(Inherited from Animatable.) |
![]() | IsFrozen | Gets a value that indicates whether the object is currently modifiable. (Inherited from Freezable.) |
![]() | IsSealed | Gets a value that indicates whether this instance is currently sealed (read-only).(Inherited from DependencyObject.) |
![]() | Opacity | |
![]() | RelativeTransform | Gets or sets the transformation that is applied to the brush using relative coordinates. (Inherited from Brush.) |
![]() | Stretch | |
![]() | TileMode | |
![]() | Transform | 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.) |
![]() | Viewbox | |
![]() | ViewboxUnits | |
![]() | Viewport | |
![]() | ViewportUnits | Gets or sets a BrushMappingMode enumeration that specifies whether the value of the Viewport, which indicates the size and position of the TileBrush base tile, is relative to the size of the output area. (Inherited from TileBrush.) |
![]() | Visual | Gets or sets the brush's content. |
| Name | Description | |
|---|---|---|
![]() | ApplyAnimationClock(DependencyProperty^, AnimationClock^) | Applies an AnimationClock to the specified DependencyProperty. If the property is already animated, the SnapshotAndReplace handoff behavior is used.(Inherited from Animatable.) |
![]() | ApplyAnimationClock(DependencyProperty^, AnimationClock^, HandoffBehavior) | Applies an AnimationClock to the specified DependencyProperty. If the property is already animated, the specified HandoffBehavior is used.(Inherited from Animatable.) |
![]() | BeginAnimation(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.) |
![]() | BeginAnimation(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.) |
![]() | CheckAccess() | Determines whether the calling thread has access to this DispatcherObject.(Inherited from DispatcherObject.) |
![]() | ClearValue(DependencyProperty^) | Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier. (Inherited from DependencyObject.) |
![]() | ClearValue(DependencyPropertyKey^) | Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey. (Inherited from DependencyObject.) |
![]() | Clone() | Creates a modifiable clone of this VisualBrush, making deep copies of this object's values. |
![]() | 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. |
![]() | CoerceValue(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.) |
![]() | Equals(Object^) | Determines whether a provided DependencyObject is equivalent to the current DependencyObject.(Inherited from DependencyObject.) |
![]() | Freeze() | |
![]() | GetAnimationBaseValue(DependencyProperty^) | Returns the non-animated value of the specified DependencyProperty.(Inherited from Animatable.) |
![]() | GetAsFrozen() | |
![]() | GetCurrentValueAsFrozen() | |
![]() | GetHashCode() | Gets a hash code for this DependencyObject.(Inherited from DependencyObject.) |
![]() | GetLocalValueEnumerator() | Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject. (Inherited from DependencyObject.) |
![]() | GetType() | |
![]() | GetValue(DependencyProperty^) | Returns the current effective value of a dependency property on this instance of a DependencyObject. (Inherited from DependencyObject.) |
![]() | InvalidateProperty(DependencyProperty^) | Re-evaluates the effective value for the specified dependency property(Inherited from DependencyObject.) |
![]() | ReadLocalValue(DependencyProperty^) | Returns the local value of a dependency property, if it exists. (Inherited from DependencyObject.) |
![]() | SetCurrentValue(DependencyProperty^, Object^) | Sets the value of a dependency property without changing its value source. (Inherited from DependencyObject.) |
![]() | SetValue(DependencyProperty^, Object^) | Sets the local value of a dependency property, specified by its dependency property identifier. (Inherited from DependencyObject.) |
![]() | SetValue(DependencyPropertyKey^, Object^) | Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property. (Inherited from DependencyObject.) |
![]() | ShouldSerializeProperty(DependencyProperty^) | Returns a value that indicates whether serialization processes should serialize the value for the provided dependency property.(Inherited from DependencyObject.) |
![]() | ToString() | |
![]() | ToString(IFormatProvider^) | Creates a string representation of this object based on the specified culture-specific formatting information. (Inherited from Brush.) |
![]() | VerifyAccess() | Enforces that the calling thread has access to this DispatcherObject.(Inherited from DispatcherObject.) |
| Name | Description | |
|---|---|---|
![]() ![]() | AutoLayoutContentProperty | Identifies the AutoLayoutContent dependency property. |
![]() ![]() | VisualProperty | Identifies the Visual dependency property. |
| Name | Description | |
|---|---|---|
![]() ![]() | IFormattable::ToString(String^, IFormatProvider^) | Formats the value of the current instance using the specified format.(Inherited from Brush.) |
There are two ways to specify the Visual content of a VisualBrush.
Create a new Visual and use it to set the Visual 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 Visual 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 AutoLayoutContent 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.
Note |
|---|
A VisualBrush cannot be made read-only (frozen) when its Visual property is set to any value other than null. |
Available since 3.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.








