BitmapImage.BeginInit Method ()

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Signals the start of the BitmapImage initialization.

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

public void BeginInit()

Exception Condition
InvalidOperationException

The BitmapImage is currently being initialized. BeginInit has already been called.

-or-

The BitmapImage has already been initialized.

Property initialization must be done between BeginInit and EndInit calls. Once the BitmapImage has been initialized, property changes are ignored.

The following example demonstrates how to initialize a BitmapImage with a set of properties by using the BeginInit and EndInit methods.

// 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);

.NET Framework
Available since 3.0
Return to top
Show: