PictureBox.WaitOnLoad Property

 
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.

Gets or sets a value indicating whether an image is loaded synchronously.

Namespace:   System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

public bool WaitOnLoad { get; set; }

Property Value

Type: System.Boolean

true if an image-loading operation is completed synchronously; otherwise, false. The default is false.

Setting the WaitOnLoad property to true means the image is loaded synchronously. This causes the user interface to be blocked from other input until the image is loaded. When WaitOnLoad is false (the default) and the LoadAsync method is used to load the image, the InitialImage image is displayed when the specified image is loaded, and the user can interact with the interface during the load process.

The following code example demonstrates how to use the WaitOnLoad property. To run this example, paste the following code into a Windows Form that contains a PictureBox named pictureBox1 and a Button named startLoadButton. Make sure that the Click event for the button is associated with the startLoadButton_Click method in this example. You must change the image file path to one that is valid on your system.

private void startButton_Click(object sender, EventArgs e)
{
    // Ensure WaitOnLoad is false.
    pictureBox1.WaitOnLoad = false;

    // Load the image asynchronously.
    pictureBox1.LoadAsync(@"http://localhost/print.gif");
}

.NET Framework
Available since 2.0
Return to top
Show: