Skip to main content

HtmlDocumentImporterOptions.AsyncImageLoading Property

Gets or sets whether images are loaded synchronously or asynchronously when importing an HTML document.

Namespace: DevExpress.XtraRichEdit.Import

Assembly: DevExpress.RichEdit.v24.1.Core.dll

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.Win.Navigation

Declaration

public bool AsyncImageLoading { get; set; }

Property Value

Type Description
Boolean

true to load images asynchronously; otherwise, false.

Property Paths

You can access this nested property as listed below:

Object Type Path to AsyncImageLoading
RichEditDocumentImportOptions
.Html .AsyncImageLoading

Remarks

By default, when an HTML document is imported, images are loaded asynchronously and the RichEditControl.DocumentLoaded event may occur before images are loaded completely. The reason is that loading images might be time-consuming and not successful in all cases.

Before exporting or printing, the control tries to ensure image availability, but this cannot be guaranteed. Other operations, such as Document API calls, may fail because an image is not ready. To prevent this from happening, set the AsyncImageLoading to false to ensure complete loading of external images.

Note

The HtmlDocumentImporterOptions.AsyncImageLoading property does not affect the RichEditDocumentServer behavior. RichEditDocumentServer always loads images synchronously.

See Also