TransformedBitmap Class

Scales and rotates a BitmapSource.

Namespace:  System.Windows.Media.Imaging
Assembly:  PresentationCore (in PresentationCore.dll)
XMLNS for XAML: http://schemas.microsoft.com/winfx/2006/xaml/presentation, http://schemas.microsoft.com/netfx/2007/xaml/presentation

public ref class TransformedBitmap sealed : public BitmapSource, 
	ISupportInitialize
<TransformedBitmap .../>

The TransformedBitmap type exposes the following members.

  NameDescription
Public methodTransformedBitmap()Initializes a new instance of the TransformedBitmap class.
Public methodTransformedBitmap(BitmapSource, Transform)Initializes a new instance of the TransformedBitmap class that has the specified Source and Transform.
Top

  NameDescription
Public propertyCanFreezeGets a value that indicates whether the object can be made unmodifiable. (Inherited from Freezable.)
Public propertyDependencyObjectTypeGets the DependencyObjectType that wraps the CLR type of this instance.  (Inherited from DependencyObject.)
Public propertyDispatcherGets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.)
Public propertyDpiXGets the horizontal dots per inch (dpi) of the image.  (Inherited from BitmapSource.)
Public propertyDpiYGets the vertical dots per inch (dpi) of the image.  (Inherited from BitmapSource.)
Public propertyFormatGets the native PixelFormat of the bitmap data. (Inherited from BitmapSource.)
Public propertyHasAnimatedPropertiesGets a value that indicates whether one or more AnimationClock objects is associated with any of this object's dependency properties. (Inherited from Animatable.)
Public propertyHeightGets the height of the source bitmap in device-independent units (1/96th inch per unit).  (Inherited from BitmapSource.)
Public propertyIsDownloadingGets a value that indicates whether the BitmapSource content is currently downloading. (Inherited from BitmapSource.)
Public propertyIsFrozenGets a value that indicates whether the object is currently modifiable. (Inherited from Freezable.)
Public propertyIsSealedGets a value that indicates whether this instance is currently sealed (read-only). (Inherited from DependencyObject.)
Public propertyMetadataGets the metadata that is associated with this bitmap image. (Inherited from BitmapSource.)
Public propertyPaletteGets the color palette of the bitmap, if one is specified. (Inherited from BitmapSource.)
Public propertyPixelHeightGets the height of the bitmap in pixels. (Inherited from BitmapSource.)
Public propertyPixelWidthGets the width of the bitmap in pixels. (Inherited from BitmapSource.)
Public propertySourceGets or sets the source for the bitmap.
Public propertyTransformGets or sets the Transform, which specifies the scale or rotation of the bitmap.
Public propertyWidthGets the width of the bitmap in device-independent units (1/96th inch per unit).  (Inherited from BitmapSource.)
Top

  NameDescription
Public methodApplyAnimationClock(DependencyProperty, AnimationClock)Applies an AnimationClock to the specified DependencyProperty. If the property is already animated, the SnapshotAndReplace handoff behavior is used. (Inherited from Animatable.)
Public methodApplyAnimationClock(DependencyProperty, AnimationClock, HandoffBehavior)Applies an AnimationClock to the specified DependencyProperty. If the property is already animated, the specified HandoffBehavior is used. (Inherited from Animatable.)
Public methodBeginAnimation(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.)
Public methodBeginAnimation(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.)
Public methodBeginInitSignals the start of the TransformedBitmap initialization.
Public methodCheckAccessDetermines whether the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)
Public methodClearValue(DependencyProperty)Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier. (Inherited from DependencyObject.)
Public methodClearValue(DependencyPropertyKey)Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey. (Inherited from DependencyObject.)
Public methodCloneCreates a modifiable clone of this TransformedBitmap, making deep copies of this object's values. When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values.
Public methodCloneCurrentValueCreates a modifiable clone of this TransformedBitmap object, making deep copies of this object's current values. Resource references, data bindings, and animations are not copied, but their current values are.
Public methodCoerceValueCoerces 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.)
Public methodCopyPixels(Array, Int32, Int32)Copies the bitmap pixel data into an array of pixels with the specified stride, starting at the specified offset. (Inherited from BitmapSource.)
Public methodCopyPixels(Int32Rect, Array, Int32, Int32)Copies the bitmap pixel data within the specified rectangle into an array of pixels that has the specified stride starting at the specified offset. (Inherited from BitmapSource.)
Public methodCopyPixels(Int32Rect, IntPtr, Int32, Int32)Copies the bitmap pixel data within the specified rectangle (Inherited from BitmapSource.)
Public methodEndInitSignals the end of the BitmapImage initialization.
Public methodEqualsDetermines whether a provided DependencyObject is equivalent to the current DependencyObject. (Inherited from DependencyObject.)
Public methodFreeze()Makes the current object unmodifiable and sets its IsFrozen property to true. (Inherited from Freezable.)
Public methodGetAnimationBaseValueReturns the non-animated value of the specified DependencyProperty. (Inherited from Animatable.)
Public methodGetAsFrozenCreates 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.)
Public methodGetCurrentValueAsFrozenCreates 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.)
Public methodGetHashCodeGets a hash code for this DependencyObject. (Inherited from DependencyObject.)
Public methodGetLocalValueEnumeratorCreates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject. (Inherited from DependencyObject.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodGetValueReturns the current effective value of a dependency property on this instance of a DependencyObject. (Inherited from DependencyObject.)
Public methodInvalidatePropertyRe-evaluates the effective value for the specified dependency property (Inherited from DependencyObject.)
Public methodReadLocalValueReturns the local value of a dependency property, if it exists. (Inherited from DependencyObject.)
Public methodSetCurrentValueSets the value of a dependency property without changing its value source. (Inherited from DependencyObject.)
Public methodSetValue(DependencyProperty, Object)Sets the local value of a dependency property, specified by its dependency property identifier. (Inherited from DependencyObject.)
Public methodSetValue(DependencyPropertyKey, Object)Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property. (Inherited from DependencyObject.)
Protected methodShouldSerializePropertyReturns a value that indicates whether serialization processes should serialize the value for the provided dependency property. (Inherited from DependencyObject.)
Public methodToString() Creates a string representation of this object based on the current culture. (Inherited from ImageSource.)
Public methodToString(IFormatProvider)Creates a string representation of this object based on the IFormatProvider passed in. If the provider is nullptr, the CurrentCulture is used. (Inherited from ImageSource.)
Public methodVerifyAccessEnforces that the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)
Top

  NameDescription
Public eventChangedOccurs when the Freezable or an object it contains is modified. (Inherited from Freezable.)
Public eventDecodeFailedOccurs when the image fails to load, due to a corrupt image header. (Inherited from BitmapSource.)
Public eventDownloadCompletedOccurs when the bitmap content has been completely downloaded. (Inherited from BitmapSource.)
Public eventDownloadFailedOccurs when the bitmap content failed to download. (Inherited from BitmapSource.)
Public eventDownloadProgressOccurs when the download progress of the bitmap content has changed. (Inherited from BitmapSource.)
Top

  NameDescription
Public fieldStatic memberSourcePropertyIdentifies the Source dependency property.
Public fieldStatic memberTransformPropertyIdentifies the Transform dependency property.
Top

  NameDescription
Explicit interface implemetationPrivate methodIFormattable::ToStringFormats the value of the current instance using the specified format. (Inherited from ImageSource.)
Top

TransformedBitmap supports only orthogonal transforms such as rotation transforms of 90° increments and scale transforms. Transforms that skew the image are not supported.

TransformedBitmap implements the ISupportInitialize interface to optimize initialization on multiple properties. Property changes can only occur during object initialization. Call BeginInit to signal that initialization has begun and EndInit to signal that initialization has completed. After initialization, property changes are ignored.

TransformedBitmap objects created using the TransformedBitmap(BitmapSource, Transform) constructor are automatically initialized and property changes are ignored.

Metadata tags related to image data must be updated if an image is saved to a file after a transform is applied.

This example shows how you can apply a variety of effects to an image source by chaining multiple BitmapSource derived objects together.

The following example uses chaining to flip and change the pixel format of the source of an image.

<Page xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
  xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml">

  <Page.Resources>

    <!-- This resource defines a BitmapImage with a source and a
         DecodePixelWidth of 200. This property is set to the same value 
         as the desired width of the image to save on memory use. This 
         BitmapImage is used as the base for the other BitmapSource resources. -->
    <BitmapImage x:Key="masterImage" DecodePixelWidth="200" 
     UriSource="C:\Documents and Settings\All Users\Documents\My Pictures\Sample Pictures\Forest.jpg"/>

    <!-- This TransformedBitmap uses the BitmapImage defined above and flips
         it 90 degrees. -->
    <TransformedBitmap x:Key="rotatedImage" Source="{StaticResource masterImage}">
      <TransformedBitmap.Transform>
        <RotateTransform Angle="90" />
      </TransformedBitmap.Transform>
    </TransformedBitmap>

    <!-- This FormatConvertedBitmap uses the TransformedBitmap defined above and
         changes the format to Gray32Float (grayscale). -->
    <FormatConvertedBitmap x:Key="convertFormatImage" 
                           Source="{StaticResource rotatedImage}"
                           DestinationFormat="Gray32Float" />

  </Page.Resources>

  <StackPanel>

    <!-- Apply the "convertFormatImage" resource defined above to this image. 
         The resource is  a combination of all three BitmapSource objects which
         renders this image with DecodePixelWidth set to 200, fliped 90 degrees 
         and converted to grayscale. -->
    <Image Width="200" Source="{StaticResource convertFormatImage}" />
  </StackPanel>
</Page>
No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 4.6, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft