InlineImage.ChangePropertiesAsync(Action<InlineImageProperties>, CancellationToken) Method

Sets inline image properties.

Namespace: DevExpress.Blazor.RichEdit

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

NuGet Package: DevExpress.Blazor.RichEdit

Declaration

public ValueTask<bool> ChangePropertiesAsync(
    Action<InlineImageProperties> modifier,
    CancellationToken cancellationToken = default(CancellationToken)
)

Parameters

Name	Type	Description
modifier	Action<InlineImageProperties>	A delegate method that configures inline image properties.

Optional Parameters

Name	Type	Default	Description
cancellationToken	CancellationToken	null	An object that propagates a cancellation notification.

Returns

Type	Description
ValueTask<Boolean>	A structure that stores an awaitable result of an asynchronous operation. The awaitable result is true if the operation is successful; otherwise, false.

Remarks

Pass an InlineImageProperties object to the ChangePropertiesAsync method to set the inline image’s properties. You can specify the inline image properties or use the CopyFrom(InlineImage) method to copy properties from another inline image.

<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;
            InlineImage firstInlineImage = await documentAPI.InlineImages.GetAsync(0);
            IReadOnlyList<InlineImage> inlineImages = await documentAPI.InlineImages.GetAllAsync();
            for (int i = 1; i < inlineImages.Count; i++)
                await inlineImages[i].ChangePropertiesAsync(properties => {
                    properties.CopyFrom(firstInlineImage);
                });
        }
        catch (OperationCanceledException e) {
            Console.WriteLine($"{nameof(OperationCanceledException)} thrown with message: {e.Message}");
        }
}