BitmapImage.DecodePixelHeight Property


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

 property int DecodePixelHeight { int get(); void set(int value); };
public int DecodePixelHeight { get; set; }
member this.DecodePixelHeight : int with get, set
Public Property DecodePixelHeight As Integer

Property Value

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


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);
' Define a BitmapImage.
Dim myImage As New Image()
Dim bi As 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)


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

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.

Dependency Property Information

Identifier field DecodePixelHeightProperty
Metadata properties set to true None

Applies to

See also