BitmapImage.DecodePixelHeight Property (System.Windows.Media.Imaging)

DecodePixelHeight Property

Switch on low bandwidth view

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

BitmapImage..::.DecodePixelHeight Property

Gets or sets the height, in pixels, that the image is decoded to. This is a dependency property.

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

Syntax

Visual Basic (Declaration)

Public Property DecodePixelHeight As Integer

Visual Basic (Usage)

Dim instance As BitmapImage
Dim value As Integer

value = instance.DecodePixelHeight

instance.DecodePixelHeight = value

public int DecodePixelHeight { get; set; }

Visual C++

public:
property int DecodePixelHeight {
    int get ();
    void set (int value);
}

JScript

public function get DecodePixelHeight () : int
public function set DecodePixelHeight (value : int)

XAML Attribute Usage

<object DecodePixelHeight="int" .../>

Property Value

Type: System..::.Int32
The height, in pixels, that the image is decoded to. The default value is 0.

Dependency Property Information

Identifier field	DecodePixelHeightProperty
Metadata properties set to true	None

Remarks

If DecodePixelWidth is also set, the aspect ratio of the bitmap remains the same. If DecodePixelWidth is not set, the aspect ratio is ignored.

The JPEG and Portable Network Graphics (PNG) codecs natively decode the image to the specified size; other codecs decode the image at its original size and scale the image to the desired size.

Examples

The following code example demonstrates how to set the DecodePixelHeight property by using code.

Visual Basic

' Define a BitmapImage.
Dim myImage As New Image()
Dim bi As New BitmapImage()

' Begin initialization.
bi.BeginInit()

' Set properties.
bi.CacheOption = BitmapCacheOption.OnDemand
bi.CreateOptions = BitmapCreateOptions.DelayCreation
bi.DecodePixelHeight = 125
bi.DecodePixelWidth = 125
bi.Rotation = Rotation.Rotate90
MessageBox.Show(bi.IsDownloading.ToString())
bi.UriSource = New Uri("smiley.png", UriKind.Relative)

' End initialization.
bi.EndInit()
myImage.Source = bi
myImage.Stretch = Stretch.None
myImage.Margin = New Thickness(5)

// Define a BitmapImage.
Image myImage = new Image();
BitmapImage bi = new BitmapImage();

// Begin initialization.
bi.BeginInit();

// Set properties.
bi.CacheOption = BitmapCacheOption.OnDemand;
bi.CreateOptions = BitmapCreateOptions.DelayCreation;
bi.DecodePixelHeight = 125;
bi.DecodePixelWidth = 125;
bi.Rotation = Rotation.Rotate90;
MessageBox.Show(bi.IsDownloading.ToString());
bi.UriSource = new Uri("smiley.png", UriKind.Relative);

// End initialization.
bi.EndInit();
myImage.Source = bi;
myImage.Stretch = Stretch.None;
myImage.Margin = new Thickness(5);

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

BitmapImage Class

BitmapImage Members

System.Windows.Media.Imaging Namespace

DecodePixelWidth