InsertImageAction Class

Definition

Namespace:Avalonia.Controls.Documents.Primitives.Actions

Assembly:Avalonia.Controls.RichTextEditor

Package:Avalonia.Controls.RichTextEditor

Action for inserting an inline Avalonia.Controls.Documents.RichImage at the current selection.

public class InsertImageAction

Inheritance: object -> EditorAction -> InsertImageAction

Remarks

Call Avalonia.Controls.Documents.Primitives.Actions.InsertImageAction.ExecuteWith(Avalonia.Controls.Documents.Primitives.ITextEditorHost,ReadOnlyMemory{byte},string,double,double,string) when the image bytes are already available (drag-drop, application logic, custom pickers).

The default Avalonia.Controls.Documents.Primitives.Actions.InsertImageAction.ExecuteAsync(Avalonia.Controls.Documents.Primitives.ITextEditorHost) opens a file picker via the host's Avalonia.Controls.TopLevel.StorageProvider and inserts the chosen image file.

Constructors

Name	Description
InsertImageAction	No summary available.

InsertImageAction Constructor

public InsertImageAction()

Methods

Name	Description
CanExecute	No summary available.
Execute	No summary available.
ExecuteAsync	No summary available.
ExecuteWith	No summary available.
GetState	Gets the current state of the action. Inherited from EditorAction.

CanExecute Method

public bool CanExecute(Avalonia.Controls.Documents.Primitives.ITextEditorHost host)

Parameters

host Avalonia.Controls.Documents.Primitives.ITextEditorHost

Returns

bool

Execute Method

public void Execute(Avalonia.Controls.Documents.Primitives.ITextEditorHost host)

Parameters

host Avalonia.Controls.Documents.Primitives.ITextEditorHost

ExecuteAsync Method

public System.Threading.Tasks.Task ExecuteAsync(Avalonia.Controls.Documents.Primitives.ITextEditorHost host)

Parameters

host Avalonia.Controls.Documents.Primitives.ITextEditorHost

Returns

System.Threading.Tasks.Task

ExecuteWith Method

public void ExecuteWith(Avalonia.Controls.Documents.Primitives.ITextEditorHost host, ReadOnlyMemory<byte> data, string mimeType, double width, double height, string altText)

Parameters

host Avalonia.Controls.Documents.Primitives.ITextEditorHost

data ReadOnlyMemory<byte>

mimeType string

width double

height double

altText string

Properties

Name	Description
DisplayName	No summary available.
Gesture	Gets the optional keyboard gesture for this action. Inherited from EditorAction.
Id	No summary available.

DisplayName Property

public string DisplayName { get; set; }

Id Property

public string Id { get; set; }