PictureEdit.ShowImageEditorDialog() Method

Displays the Image Editor dialog, which allows users to perform basic edit operations on the image (crop, rotate, brightness and contrast adjustment, etc.).

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v24.2.dll

Declaration

C#

public DialogResult ShowImageEditorDialog()

VB.NET

Public Function ShowImageEditorDialog As DialogResult

Returns

Type	Description
DialogResult	The DialogResult.OK value if the image has been modified and saved by the PictureEdit control; The DialogResult.Cancel value if changes (if any) made in the editor have been discarded.

Remarks

If the RepositoryItemPictureEdit.ShowEditMenuItem property is set to True, end-users can click the Edit menu command to edit the current image in a separate Image Editor dialog.

The ShowImageEditorDialog method allows you to invoke this dialog from code. When a user modifies an image and then click the Save button, the image is saved back in the PictureEdit control and the ShowImageEditorDialog method returns the DialogResult.OK value.

The Image Editor dialog provides basic image edit operations:

• Crop and straighten
• Adjust brightness, contrast and saturation
• Mirror
• Rotate
• etc.

The Image Editor maintains the operation history and provides the undo and redo functionality. Once the editor is closed and changes are saved, the modifications cannot be undone.

Handle the PictureEdit.ImageEditorDialogShowing/RepositoryItemPictureEdit.ImageEditorDialogShowing event to customize the Image Editor dialog.

The PictureEdit.ImageEditorDialogClosed/RepositoryItemPictureEdit.ImageEditorDialogClosed event fires when the dialog is closed.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the ShowImageEditorDialog() method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

winforms-pictureedit-add-custom-graphic-operation-watermark/CS/WatermarkDemo/WatermarkDemo/Form1.cs#L27

void btnShowImageEditor_Click(object sender, EventArgs e) {
    pictureEdit1.ShowImageEditorDialog();
}

VB.NET

winforms-pictureedit-add-custom-graphic-operation-watermark/VB/WatermarkDemo/WatermarkDemo/Form1.vb#L29

Private Sub btnShowImageEditor_Click(ByVal sender As Object, ByVal e As EventArgs) Handles btnShowImageEditor.Click
    pictureEdit1.ShowImageEditorDialog()
End Sub