RenderTargetBitmap Class (System.Windows.Media.Imaging)

MSDN Library
.NET Development
.NET Framework 3.5
.NET Framework Class Library
System.Windows.Media.Imaging Namespace

RenderTargetBitmap Class

RenderTargetBitmap Members
RenderTargetBitmap Constructor
RenderTargetBitmap Methods
RenderTargetBitmap Properties
RenderTargetBitmap Events

RenderTargetBitmap Class
This page is specific to:.NET Framework Version:3.03.5Silverlight 3 4.0

.NET Framework Class Library

RenderTargetBitmap Class

Converts a Visual object into a bitmap.

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

Syntax

C++

JScript

Copy to Clipboard Print

'Usage

Dim instance As RenderTargetBitmap

'Declaration

Public NotInheritable Class RenderTargetBitmap _
    Inherits BitmapSource

XAML

You cannot directly create an instance of this class in XAML.

Examples

The following example shows how to use RenderTargetBitmap to render text as an image.

C++

JScript

Copy to Clipboard Print

Imports System
Imports System.Windows
Imports System.Windows.Controls
Imports System.Windows.Media
Imports System.Windows.Media.Imaging
Imports System.Globalization

Namespace SDKSample

    Class RenderTargetBitmapExample
        Inherits Page

        Public Sub New()

            Dim myImage As New Image()
            Dim [text] As New FormattedText("ABC", New CultureInfo("en-us"), System.Windows.FlowDirection.LeftToRight, New Typeface(Me.FontFamily, FontStyles.Normal, FontWeights.Normal, New FontStretch()), Me.FontSize, Me.Foreground)

            Dim drawingVisual As New DrawingVisual()
            Dim drawingContext As DrawingContext = drawingVisual.RenderOpen()
            drawingContext.DrawText([text], New System.Windows.Point(2, 2))
            drawingContext.Close()

            Dim bmp As New RenderTargetBitmap(180, 180, 120, 96, PixelFormats.Pbgra32)
            bmp.Render(drawingVisual)
            myImage.Source = bmp
            ' Add Image to the UI
            Dim myStackPanel As New StackPanel()
            myStackPanel.Children.Add(myImage)
            Me.Content = myStackPanel

        End Sub 'New
    End Class 'RenderTargetBitmapExample
End Namespace 'ImagingSnippetGallery

More Code

How to: Create a Bitmap from a Visual	This example shows how you can create a bitmap from a Visual. A DrawingVisual is rendered with FormattedText. The Visual is then rendered to the RenderTargetBitmap creating a bitmap of the given text.
How to: Encode a Visual to an Image File	This example demonstrates how to encode a Visual object into an image file using a RenderTargetBitmapand a PngBitmapEncoder.

Inheritance Hierarchy

System..::.Object
  System.Windows.Threading..::.DispatcherObject
    System.Windows..::.DependencyObject
      System.Windows..::.Freezable
        System.Windows.Media.Animation..::.Animatable
          System.Windows.Media..::.ImageSource
            System.Windows.Media.Imaging..::.BitmapSource
              System.Windows.Media.Imaging..::.RenderTargetBitmap

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.

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

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

Version Information

.NET Framework

Supported in: 3.5, 3.0

Reference

RenderTargetBitmap Members

System.Windows.Media.Imaging Namespace

Other Resources

Imaging Overview

Imaging How-to Topics