Image.ChangePropertiesAsync(Action<ImageProperties>, CancellationToken) Method

Sets image properties.

Namespace: DevExpress.Blazor.RichEdit

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

NuGet Package: DevExpress.Blazor.RichEdit

Declaration

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

Parameters

Name	Type	Description
modifier	Action<ImageProperties>	A delegate method that configures 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 ImageProperties object to the ChangePropertiesAsync method to set the image’s properties. You can specify image properties or use the CopyFrom(Image) method to copy properties from another 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;
            @* ... *@
            Image image = await documentAPI.Images.GetAsync(0);
            IReadOnlyList<Image> images = await documentAPI.Images.GetAllAsync();
            @* ... *@
            for (int i = 1; i < images.Count; i++)
                await images[i].ChangePropertiesAsync(properties => {
                    properties.CopyFrom(image);
                });
                @* ... *@
        }
        catch (OperationCanceledException e) {
            Console.WriteLine($"{nameof(OperationCanceledException)} thrown with message: {e.Message}");
        }
}