Pictures

• Aug 05, 2019
• 7 minutes to read

Note

Refer to the Shapes article for information on new pictures and shapes.

The RichEditDocumentServer 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)

Create an Image

All images in the document are contained in two collections: DocumentImageCollection (accessible by the SubDocument.Images property) and ShapeCollection (accessible by the SubDocument.Shapes property).

Call the DocumentImageCollection.Append or DocumentImageCollection.Insert method to place an inline image in the document. The resulting object is also added to the ShapeCollection.

Note

When you work with documents created in a Microsoft Word version earlier than 2007, its inline pictures are stored in the DocumentImageCollection only.

This example illustrates how to insert inline pictures in a rich text document. The image can be obtained from a file, from a stream or from a URI.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-insert-inline-pictures-using-the-richeditdocumentserver-e4803

Program.cs

using System.IO;
using System.Reflection;
using DevExpress.XtraRichEdit;
using DevExpress.XtraRichEdit.API.Native;
RichEditDocumentServer server = new RichEditDocumentServer();

server.LoadDocument("Texts\\InlinePictures.rtf", DocumentFormat.Rtf);
Document doc = server.Document;

// Insert an image from a file.
DocumentRange rangeFound = doc.FindAll("Visual Studio Magazine", SearchOptions.CaseSensitive)[0];
DocumentPosition pos = doc.Paragraphs[doc.Paragraphs.Get(rangeFound.End).Index + 2].Range.Start;
doc.Images.Insert(pos, DocumentImageSource.FromFile("Pictures\\ReadersChoice.png"));

// Insert an image from a stream.
pos = doc.Paragraphs[4].Range.Start;
string imageToInsert = "information.png";
Assembly a = Assembly.GetExecutingAssembly();
Stream imageStream = a.GetManifestResourceStream("InlinePictures.Resources." + imageToInsert);
doc.Images.Insert(pos, DocumentImageSource.FromStream(imageStream));

// Insert an image using its URI.
string imageUri = "http://i.gyazo.com/798a2ed48a3535c6c8add0ea7a4fc4e6.png";
SubDocument docHeader = doc.Sections[0].BeginUpdateHeader();
docHeader.Images.Append(DocumentImageSource.FromUri(imageUri, server));
doc.Sections[0].EndUpdateHeader(docHeader);


// Insert a barcode.
DevExpress.BarCodes.BarCode barCode = new DevExpress.BarCodes.BarCode();
barCode.Symbology = DevExpress.BarCodes.Symbology.QRCode;
barCode.CodeText = "http://www.devexpress.com";
barCode.CodeBinaryData = System.Text.Encoding.Default.GetBytes(barCode.CodeText);
barCode.Module = 0.5;
SubDocument docFooter = doc.Sections[0].BeginUpdateFooter();
docFooter.Images.Append(barCode.BarCodeImage);
doc.Sections[0].EndUpdateFooter(docFooter);

Program.vb

Imports System.IO
Imports System.Reflection
Imports DevExpress.XtraRichEdit
Imports DevExpress.XtraRichEdit.API.Native
Dim server As New RichEditDocumentServer()
server.LoadDocument("Texts\InlinePictures.rtf", DocumentFormat.Rtf)
Dim doc As Document = server.Document

' Insert an image from a file.
Dim rangeFound As DocumentRange = doc.FindAll("Visual Studio Magazine", SearchOptions.CaseSensitive)(0)
Dim pos As DocumentPosition = doc.Paragraphs(doc.Paragraphs.Get(rangeFound.End).Index + 2).Range.Start
doc.Images.Insert(pos, DocumentImageSource.FromFile("Pictures\ReadersChoice.png"))

' Insert an image from a stream.
pos = doc.Paragraphs(4).Range.Start
Dim imageToInsert As String = "information.png"
Dim a As System.Reflection.Assembly = System.Reflection.Assembly.GetExecutingAssembly()
Dim imageStream As Stream = a.GetManifestResourceStream("Resources." & imageToInsert)
doc.Images.Insert(pos, DocumentImageSource.FromStream(imageStream))

' Insert an image using its URI.
Dim imageUri As String = "http://i.gyazo.com/798a2ed48a3535c6c8add0ea7a4fc4e6.png"
Dim docHeader As SubDocument = doc.Sections(0).BeginUpdateHeader()
docHeader.Images.Append(DocumentImageSource.FromUri(imageUri, server))
doc.Sections(0).EndUpdateHeader(docHeader)


' Insert a barcode.
Dim barCode As New DevExpress.BarCodes.BarCode()
barCode.Symbology = DevExpress.BarCodes.Symbology.QRCode
barCode.CodeText = "http://www.devexpress.com"
barCode.CodeBinaryData = System.Text.Encoding.Default.GetBytes(barCode.CodeText)
barCode.Module = 0.5
Dim docFooter As SubDocument = doc.Sections(0).BeginUpdateFooter()
docFooter.Images.Append(barCode.BarCodeImage)
doc.Sections(0).EndUpdateFooter(docFooter)

Resize an Image

The following properties allow you to resize an inline image:

API	Description
DocumentImage.ScaleX	Gets or sets the X-axis scale factor.
DocumentImage.ScaleY	Gets or sets the Y-axis scale factor.
DocumentImage.Size	Specifies the picture’s size in current measurement units (specified by the Document.Unit property).

The following example examines all images in the document. If the width of an image exceeds 50 millimeters, the image is scaled proportionally to half its size.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/word-processing-document-api-examples-t418535

InlinePictureActions.cs

Document document = server.Document;
document.LoadDocument("Documents\\Grimm.docx", DocumentFormat.OpenXml);
ReadOnlyDocumentImageCollection images = document.Images;
// If the width of an image exceeds 50 millimeters, 
// the image is scaled proportionally to half its size.
for (int i = 0; i < images.Count; i++)
{
    if (images[i].Size.Width > DevExpress.Office.Utils.Units.MillimetersToDocumentsF(50))
    {
        images[i].ScaleX /= 2;
        images[i].ScaleY /= 2;
    }
}

InlinePictureActions.vb

Dim document As Document = server.Document
document.LoadDocument("Documents\Grimm.docx", DocumentFormat.OpenXml)
Dim images As ReadOnlyDocumentImageCollection = document.Images
' If the width of an image exceeds 50 millimeters, 
' the image is scaled proportionally to half its size.
For i As Integer = 0 To images.Count - 1
    If images(i).Size.Width > DevExpress.Office.Utils.Units.MillimetersToDocumentsF(50) Then
        images(i).ScaleX /= 2
        images(i).ScaleY /= 2
    End If
Next i

Obtain Image Information

The DocumentImage.Image property enables you to get information on image size, resolution and color depth. The returned OfficeImage object can be used to get a native .NET Image (the OfficeImage.NativeImage property) or to get image data in a different format (the OfficeImage.GetImageBytes method).

The code sample below retrieves all images in the document and saves them as separate files.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/word-processing-document-api-examples-t418535

InlinePictureActions.cs

Document document = server.Document;
document.LoadDocument("Documents\\MovieRentals.docx", DocumentFormat.OpenXml);
DocumentRange myRange = document.CreateRange(0, 100);
ReadOnlyDocumentImageCollection images = document.Images.Get(myRange);
if (images.Count > 0)
{
    DevExpress.Office.Utils.OfficeImage myImage = images[0].Image;
    System.Drawing.Image image = myImage.NativeImage;
    string imageName = String.Format("Image_at_pos_{0}.png", images[0].Range.Start.ToInt());
    image.Save(imageName);
    System.Diagnostics.Process.Start("explorer.exe", "/select," + imageName);
}

InlinePictureActions.vb

Dim document As Document = server.Document
document.LoadDocument("Documents\MovieRentals.docx", DocumentFormat.OpenXml)
Dim myRange As DocumentRange = document.CreateRange(0, 100)
Dim images As ReadOnlyDocumentImageCollection = document.Images.Get(myRange)
If images.Count > 0 Then
    Dim myImage As DevExpress.Office.Utils.OfficeImage = images(0).Image
    Dim image As System.Drawing.Image = myImage.NativeImage
    Dim imageName As String = String.Format("Image_at_pos_{0}.png", images(0).Range.Start.ToInt())
    image.Save(imageName)
    System.Diagnostics.Process.Start("explorer.exe", "/select," & imageName)
End If

Tip

Use the ReadOnlyDocumentImageCollection.Get method to get images from the specified range.

Delete an Image

Clear the range occupied by the image to delete this image from the document. The DocumentImage.Range property returns the related range.

C#

DocumentRange imageRange = richEditDocumentServer1.Document.Images[0].Range;
richEditDocumentServer1.Document.Delete(imageRange);

VB.NET

Dim imageRange As DocumentRange = richEditDocumentServer1.Document.Images(0).Range
richEditDocumentServer1.Document.Delete(imageRange)

Export Specifics

RTF

Use the RtfDocumentExporterCompatibilityOptions.DuplicateObjectAsMetafile property to specify whether to save inline pictures in the native format and as metafiles.

HTML

Handle the RichEditDocumentServer.BeforeExport event and specify the HtmlDocumentExporterOptions.UriExportType and IExporterOptions.TargetUri properties to specify a location for storing images as external files.

Create custom IUriProvider interface implementation and specify it instead of the default URI provider in the SubDocument.GetHtmlText method to create custom css and image URIs.

This example demonstrates how to use the DocumentImage.Uri property to set the image’s src attribute when a document is saved in HTML format. You can switch on the HtmlDocumentExporterOptions.EmbedImages option to observe that the custom URI provider is idle for embedded images.

Note

The complete sample project How to retain the original image URI in an HTML document is available in the DevExpress Examples repository.

Form1.cs

using DevExpress.Office.Services;
using DevExpress.XtraRichEdit.API.Native;
using DevExpress.XtraRichEdit.Export;
using System;
// ...
        private void richEditControl1_DocumentLoaded(object sender, EventArgs e)
        {
            IUriProviderService service = richEditControl1.GetService<IUriProviderService>();
            if (service != null) {
                service.RegisterProvider(new CustomUriProvider());
            }
        }
        private void richEditControl1_ContentChanged(object sender, EventArgs e)
        {
            ReloadHtml();
        }

        private void ReloadHtml()
        {
            HtmlDocumentExporterOptions exportOptions = new HtmlDocumentExporterOptions();
            exportOptions.EmbedImages = embedImagesCheck.Checked;
            string sText = richEditControl1.Document.GetHtmlText(richEditControl1.Document.Range, new CustomUriProvider(), exportOptions);
            memoEdit1.Text = sText;
        }

Form1.vb

Imports DevExpress.Office.Services
Imports DevExpress.XtraRichEdit.API.Native
Imports DevExpress.XtraRichEdit.Export
Imports System
' ...
        Private Sub richEditControl1_DocumentLoaded(ByVal sender As Object, ByVal e As EventArgs) Handles richEditControl1.DocumentLoaded
            Dim service As IUriProviderService = richEditControl1.GetService(Of IUriProviderService)()
            If service IsNot Nothing Then
                service.RegisterProvider(New CustomUriProvider())
            End If
        End Sub

        Private Sub richEditControl1_ContentChanged(ByVal sender As Object, ByVal e As EventArgs)
            ReloadHtml()
        End Sub

        Private Sub ReloadHtml()
            Dim exportOptions As New HtmlDocumentExporterOptions()
            exportOptions.EmbedImages = embedImagesCheck.Checked
            Dim sText As String = richEditControl1.Document.GetHtmlText(richEditControl1.Document.Range, New CustomUriProvider(), exportOptions)
            memoEdit1.Text = sText
        End Sub

CustomUriProvider.cs

using DevExpress.Office.Services;
using DevExpress.Office.Utils;
using System;
// ...
     public class CustomUriProvider : IUriProvider
     {
        public string CreateCssUri(string rootUri, string styleText, string relativeUri)
        {
            return String.Empty;
        }

        public string CreateImageUri(string rootUri, OfficeImage image, string relativeUri)
        {
            return image.Uri;
        }
    }

CustomUriProvider.vb

Imports DevExpress.Office.Services
Imports DevExpress.Office.Utils
Imports System
' ...
    Public Class CustomUriProvider
        Implements IUriProvider

        Public Function CreateCssUri(ByVal rootUri As String, ByVal styleText As String, ByVal relativeUri As String) As String Implements IUriProvider.CreateCssUri
            Return String.Empty
        End Function

        Public Function CreateImageUri(ByVal rootUri As String, ByVal image As OfficeImage, ByVal relativeUri As String) As String Implements IUriProvider.CreateImageUri
            Return image.Uri
        End Function
    End Class

The Document.HtmlText property uses a special URI provider (the DataStringUriProvider), which converts an image to a base64-encoded representation with the “data:” prefix. If you use the Document.HtmlText property to obtain the HTML content, all images are embedded in the page.