How to: Insert a Picture

• Aug 05, 2019
• 2 minutes to read

The RichEditControl supports the following graphic types:

• Bitmap (*.bmp, *.dib)
• JPEG File Interchange Format (*.jpg, *.jpeg)
• Portable Network Graphics (*.png)
• Graphics Interchange Format (*.gif)
• Tagged Image Format (*.tif, *.tiff)
• Microsoft Enhanced Metafile (*.emf)
• Windows Metafile (*.wmf)

Use the following API to place an image in the document:

API	Description
DocumentImageCollection.Append	Appends an image.
DocumentImageCollection.Insert ShapeCollection.InsertPicture	Inserts an image in the specified position.

The code sample belows inserts an image at the document’s start.

To insert a picture in line with text, use the DocumentImageCollection.Insert method.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/wpf-richedit-document-api-t213968.

InlinePicturesActions.cs

DocumentPosition pos = document.Range.Start;
StreamResourceInfo streamResInfo = Application.GetResourceStream(new Uri("beverages.png", UriKind.Relative));
if (streamResInfo != null)
{
    using (Stream s = streamResInfo.Stream)
    {
        document.Images.Insert(pos, DocumentImageSource.FromStream(s));
    }
}

InlinePicturesActions.vb

Dim pos As DocumentPosition = document.Range.Start
Dim streamResInfo As StreamResourceInfo = Application.GetResourceStream(New Uri("beverages.png", UriKind.Relative))
If streamResInfo IsNot Nothing Then
    Using s As Stream = streamResInfo.Stream
        document.Images.Insert(pos, DocumentImageSource.FromStream(s))
    End Using
End If

The created DocumentImage object is added to two collections: DevExpress.XtraRichEdit.API.Native.ShapeCollection and DevExpress.XtraRichEdit.API.Native.DocumentImageCollection The object’s Shape.TextWrapping property will be set to TextWrappingType.InLineWithText

The code sample below inserts an image in the specified position. The resulting object is added to the ShapeCollection only.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/wpf-richedit-document-api-t213968.

ShapesActions.cs

document.AppendText("Line One\nLine Two\nLine Three");
StreamResourceInfo streamResInfo = Application.GetResourceStream(new Uri("beverages.png", UriKind.Relative));
if (streamResInfo != null)
{
    using (Stream s = streamResInfo.Stream) 
    {
        Shape myPicture = document.Shapes.InsertPicture(document.CreatePosition(15), 
            DocumentImageSource.FromStream(s));
        myPicture.HorizontalAlignment = ShapeHorizontalAlignment.Center;
    }
}

ShapesActions.vb

document.AppendText("Line One" & vbLf & "Line Two" & vbLf & "Line Three")
Dim streamResInfo As StreamResourceInfo = Application.GetResourceStream(New Uri("beverages.png", UriKind.Relative))
If streamResInfo IsNot Nothing Then
    Using s As Stream = streamResInfo.Stream
        Dim myPicture As Shape = document.Shapes.InsertPicture(document.CreatePosition(15), DocumentImageSource.FromStream(s))
        myPicture.HorizontalAlignment = ShapeHorizontalAlignment.Center
    End Using
End If