BitmapImage.DecodePixelHeight Property

Gets or sets the height, in pixels, that the image is decoded to.

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

public int DecodePixelHeight { get; set; }
/** @property */
public int get_DecodePixelHeight ()

/** @property */
public void set_DecodePixelHeight (int value)

public function get DecodePixelHeight () : int

public function set DecodePixelHeight (value : int)

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

Property Value

The height, in pixels, that the image is decoded to. The default value is 0.

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.

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

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

// Begin initialization.

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

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

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0

Community Additions