Skip to content
Shiny .NET v4 is here with BLE Windows Support, Improved GPS, & More! Check It Out

ImageEditor | Properties & Commands

PropertyTypeDefaultDescription
SourceImageSource?nullImage to edit (supports file, stream, URI)
CurrentToolModeImageEditorToolModeMoveActive tool: Move, Crop, Draw, Text (TwoWay)
AllowCropbooltrueEnable/disable crop tool
AllowRotatebooltrueEnable/disable rotate action
AllowDrawbooltrueEnable/disable freehand drawing
AllowTextAnnotationbooltrueEnable/disable text annotations
AllowZoombooltrueEnable/disable pinch-to-zoom
CanUndoboolfalseWhether undo is available (OneWayToSource)
CanRedoboolfalseWhether redo is available (OneWayToSource)
DrawStrokeColorColorWhiteDrawing stroke color (TwoWay)
DrawStrokeWidthdouble3Drawing stroke width
TextFontSizedouble16Text annotation font size
AnnotationTextColorColorWhiteText annotation color
SaveCommandICommand?nullInvoked with EditedImage parameter on save
SaveTextstring"Save"Save button label
CropApplyTextstring"Apply Crop"Crop apply button label
CropCancelTextstring"Cancel"Crop cancel button label
ToolbarTemplateDataTemplate?nullCustom toolbar (replaces the default toolbar)
ToolbarPositionToolbarPositionBottomToolbar placement: Top or Bottom
UseHapticFeedbackbooltrueHaptic feedback on actions (MAUI only)

All editing actions are exposed as ICommand properties for use with custom toolbars or ViewModels:

CommandParameterDescription
UndoCommandUndo the last edit action
RedoCommandRedo the last undone action
RotateCommandfloat (degrees)Rotate the image
ResetCommandClear all edits and restore the original image
CropCommandToggle crop mode on/off
DrawCommandToggle draw mode on/off
TextCommandToggle text annotation mode on/off
SaveCommandEditedImageFires when the user taps Save (only shown when bound)
MethodReturnsDescription
Undo()voidUndo the last action
Redo()voidRedo the last undone action
Rotate(float degrees)voidRotate by the given angle
Reset()voidClear all edits
ApplyCrop()voidCommit the active crop selection
GetEditedImage()EditedImage?Get an EditedImage for export