InlineImages.CreateAsync(DocumentImageSource, CancellationToken) Method
In This Article
Appends an inline image from a specified image source to the sub-document.
Namespace: DevExpress.Blazor.RichEdit
Assembly: DevExpress.Blazor.RichEdit.v24.2.dll
NuGet Package: DevExpress.Blazor.RichEdit
#Declaration
C#
public ValueTask<InlineImage> CreateAsync(
DocumentImageSource imageSource,
CancellationToken cancellationToken = default(CancellationToken)
)
#Parameters
Name | Type | Description |
---|---|---|
image |
Document |
An image source. |
#Optional Parameters
Name | Type | Default | Description |
---|---|---|---|
cancellation |
Cancellation |
null | An object that propagates a cancellation notification. |
#Returns
Type | Description |
---|---|
Value |
A structure that stores an awaitable result of an asynchronous operation. The awaitable result is an inline image object. |
#Remarks
The following code snippet loads a 1000 by 1000 twips image from a URL and insert this image at the end of the main sub-document:
Razor
<DxRichEdit @ref="richEdit" />
@code {
DxRichEdit richEdit;
Document documentAPI;
@* ... *@
/* Surround the code that contains an asynchronous operation with a try-catch block to handle
the OperationCanceledException. This exception is thrown when an asynchronous operation is canceled. */
try {
documentAPI = richEdit.DocumentAPI;
@* ... *@
DocumentImageSource imageSource = DocumentImageSource.LoadFromUrl("your-image-url", 1000, 1000);
InlineImage inlineImage = await documentAPI.InlineImages.CreateAsync(imageSource);
@* ... *@
}
catch (OperationCanceledException e) {
Console.WriteLine($"{nameof(OperationCanceledException)} thrown with message: {e.Message}");
}
}
See Also