ImageEdit Class

Represents an image editor.

Namespace: DevExpress.Xpf.Editors

Assembly: DevExpress.Xpf.Core.v20.2.dll

NuGet Packages: DevExpress.WindowsDesktop.Wpf.Core, DevExpress.Wpf.Core

Declaration

C#

public class ImageEdit :
    BaseEdit,
    IImageEdit,
    IInputElement,
    IImageExportSettings,
    IExportSettings

VB.NET

Public Class ImageEdit
    Inherits BaseEdit
    Implements IImageEdit,
               IInputElement,
               IImageExportSettings,
               IExportSettings

Remarks

The ImageEdit control is an editor that allows you to display images in various formats.

Tip

The ImageEdit class inherits its features from the BaseEdit class.

Refer to the BaseEdit class description for information on derived features and API.

The DevExpress WPF Editors Library has a popup variation of the ImageEdit control: PopupImageEdit.

Create an ImageEdit

XAML

<Window ...
    xmlns:dxe="http://schemas.devexpress.com/winfx/2008/xaml/editors">

<!-- Specify value using the ImageEdit.Source property -->
<dxe:ImageEdit Source="../Images/Persons/m02.jpg" ShowMenuMode="Hover"/>

<!-- Specify value using the BaseEdit.EditValue property. 
Userpic is a data context field that stores values of Byte[] type. -->
<dxe:ImageEdit EditValue="{Binding UserPic}" />

Editor Value

Use the Source property to specify a path to the editor’s image. Note, that end users can load their own images when the image menu is available.

You can use the EditValue property to get or set the displayed image as an array of bytes.

Edit an Image

• Built-in Menu - end users can use the built-in menu to cut, copy, paste, delete, load, or save an image.
• Easy Image Loading - if the ImageEdit.ShowLoadDialogOnClickMode property is set to Always or Empty, end users can click within an image editor to open the Open dialog and load a new image.

Support for Various Formats

The ImageEdit control supports the following image formats.

• Bitmap
• JPEG
• GIF
• PNG

Optional Image Menu

Use the ImageEdit.ShowMenu and ImageEdit.ShowMenuMode properties to control the availability of the image menu.

Use the ImageEdit.MenuTemplate and ImageEdit.MenuContainerTemplate properties to implement a custom menu appearance.

Various Stretch Modes

To specify how the image should be stretched to fill the available space, use the ImageEdit.Stretch property. The following stretch modes are available.

• None
• Fill
• Uniform
• Uniform to fill

Webcam Support

Image menu contains the Take Snapshot button. Clicking this button allows end users to take a picture using a web camera.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the ImageEdit class.

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.

XAML

how-to-resize-gaugecontrol-on-printing-exporting-t274220/CS/WpfApplication72/MainWindow.xaml#L11

<StackPanel>
    <dxe:ImageEdit IsPrintingMode="True" Source="{Binding Content}" />
</StackPanel>

how-to-specify-editors-for-displayed-properties-t324581/CS/MainWindow.xaml#L18

<DataTemplate>
    <dxe:ImageEdit Name="PART_Editor"/>
</DataTemplate>

how-to-manage-displayed-properties-at-the-view-model-model-level-t329586/CS/MainWindow.xaml#L19

<DataTemplate x:Key="ImageTemplate">
    <dxe:ImageEdit Height="150"/>
</DataTemplate>

wpf-property-grid-apply-data-annotation-attributes/CS/MainWindow.xaml#L18

<DataTemplate>
    <dxe:ImageEdit Name="PART_Editor"/>
</DataTemplate>

Reporting_how-to-create-drill-down-documents-with-dxprinting-for-wpf-e3249/CS/MainWindow.xaml#L58

<dxe:ImageEdit Margin="0,0,0,10" Grid.Row="0" Grid.Column="1" IsPrintingMode="True"
               Source="{Binding Content.Row.Picture}"/>

Inheritance

Object

DispatcherObject

DependencyObject

Visual

UIElement

FrameworkElement

Control

BaseEdit

ImageEdit