The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

ImageBrush Class

.NET Framework (current version)

Other Versions

Paints an area with an image.

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

Inheritance Hierarchy

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

Syntax

C++

public ref class ImageBrush sealed : TileBrush

Constructors

	Name	Description
	ImageBrush()	Initializes a new instance of the ImageBrush class with no content.
	ImageBrush(ImageSource^)	Initializes a new instance of the ImageBrush class that paints an area with the specified image.

Properties

	Name	Description
	AlignmentX	Gets or sets the horizontal alignment of content in the TileBrush base tile. (Inherited from TileBrush.)
	AlignmentY	Gets or sets the vertical alignment of content in the TileBrush base tile. (Inherited from TileBrush.)
	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.)
	ImageSource	Gets or sets the image displayed by this ImageBrush.
	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	Gets or sets the degree of opacity of a Brush. (Inherited from Brush.)
	RelativeTransform	Gets or sets the transformation that is applied to the brush using relative coordinates. (Inherited from Brush.)
	Stretch	Gets or sets a value that specifies how the content of this TileBrush stretches to fit its tiles. (Inherited from TileBrush.)
	TileMode	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.)
	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	Gets or sets the position and dimensions of the content in a TileBrush tile. (Inherited from TileBrush.)
	ViewboxUnits	Gets or sets a value that specifies whether the Viewbox value is relative to the bounding box of the TileBrush contents or whether the value is absolute. (Inherited from TileBrush.)
	Viewport	Gets or sets the position and dimensions of the base tile for a TileBrush. (Inherited from TileBrush.)
	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.)

Methods

	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 ImageBrush, making deep copies of this object's values.
	CloneCurrentValue()	Creates a modifiable clone of this ImageBrush object, making deep copies of this object's current values.
	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()	Makes the current object unmodifiable and sets its IsFrozen property to true. (Inherited from Freezable.)
	GetAnimationBaseValue(DependencyProperty^)	Returns the non-animated value of the specified DependencyProperty.(Inherited from Animatable.)
	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.)
	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.)
	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()	Gets the Type of the current instance.(Inherited from Object.)
	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()	Return string representation of this Brush. (Inherited from Brush.)
	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.)

Fields

	Name	Description
	ImageSourceProperty	Identifies the ImageSource dependency property.

Events

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

Explicit Interface Implementations

	Name	Description
	IFormattable::ToString(String^, IFormatProvider^)	Formats the value of the current instance using the specified format.(Inherited from Brush.)

An ImageBrush is a type of TileBrush that defines its content as an image, which is specified by its ImageSource property. You can control how the image is stretched, aligned, and tiled, enabling you to produce patterns and other effects. The following images show some effects that can be achieved with an ImageBrush.

An ImageBrush can paint shapes, controls, text, and more

As mentioned, an ImageBrush paints an area with an ImageSource. The most common type of ImageSource to use with an ImageBrush is a BitmapImage, which describes a bitmap graphic. You can use a DrawingImage to paint using a Drawing object, but it is simpler to use a DrawingBrush instead. For more information about ImageSource objects, see Imaging Overview.

For more information about ImageBrush features, see Painting with Images, Drawings, and Visuals overview.

Freezable Features

Because the ImageBrush class inherits from Freezable, ImageBrush objects gain several special features, which include the following: they can be declared as , shared among multiple objects, made read-only to improve performance, cloned, and made thread safe. For more information about the features provided by Freezable objects, see Freezable Objects Overview.

Security

MediaPermission

to display images that you have WebPermission or FileIOPermission access for. Associated enumeration: MediaPermissionImage::SiteOfOriginImage.

MediaPermission

to display images that you don't have WebPermission or FileIOPermission access for. Associated enumeration: MediaPermissionImage::SafeImage.

Version Information

.NET Framework
Available since 3.0
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.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.

Deutsch	English	Español	Français
Italiano	日本語	한국어	Português
Pусский	简体中文	繁體中文