DocumentImageSource Class

Contains methods that allow you to specify an image source.

Namespace: DevExpress.Blazor.RichEdit

Assembly: DevExpress.Blazor.RichEdit.v23.2.dll

NuGet Package: DevExpress.Blazor.RichEdit

Declaration

public abstract class DocumentImageSource

Related API Members

The following members return DocumentImageSource objects:

• DocumentImageSource.LoadFromStream(Stream, Int32, Int32)
• DocumentImageSource.LoadFromUrl(String, Int32, Int32)

Remarks

Pass a DocumentImageSource object to a Images.CreateAsync method to insert an image into a document.

The example below shows how to load a 1000 by 1000 twips image from a URL and insert this image at the end of the main sub-document:

<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);
            Image newImage = await documentAPI.Images.CreateAsync(imageSource);
            @* ... *@
        }
        catch (OperationCanceledException e) {
            Console.WriteLine($"{nameof(OperationCanceledException)} thrown with message: {e.Message}");
        }
}

Pass a DocumentImageSource object to an InlineImages.CreateAsync method to insert an inline image into a document.

The example below shows how to load a 1000 by 1000 twips image from a stream and insert this image at the beginning of the main sub-document:

@using System.IO
@* ... *@
<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;
            @* ... *@
            FileStream sourceStream = File.Open("file-path-to-your-image", FileMode.Open);
            DocumentImageSource imgSource = DocumentImageSource.LoadFromStream(sourceStream, 1000, 1000);
            InlineImage newInlineImage = await documentAPI.InlineImages.CreateAsync(0, imgSource);
            @* ... *@
        }
        catch (OperationCanceledException e) {
            Console.WriteLine($"{nameof(OperationCanceledException)} thrown with message: {e.Message}");
        }
}

Inheritance

Object

DocumentImageSource