DocumentImageSource Class

Contains static methods used to create an image from various sources.

Namespace: DevExpress.XtraRichEdit.API.Native

Assembly: DevExpress.RichEdit.v24.1.Core.dll

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.Win.Navigation

Declaration

C#

[ComVisible(true)]
public abstract class DocumentImageSource

VB.NET

<ComVisible(True)>
Public MustInherit Class DocumentImageSource

Related API Members

The following members return DocumentImageSource objects:

• DocumentImageSource.FromFile(String)
• DocumentImageSource.FromGdiImage(Image)
• DocumentImageSource.FromImage(DXImage)
• DocumentImageSource.FromStream(Stream)
• DocumentImageSource.FromUri(String, IServiceContainer)

Remarks

The following image formats are available:

• 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)
• Scalable Vector Graphics (*.svg)

Example: Create an Image from Different Sources

C#

using DevExpress.BarCodes;
using DevExpress.XtraRichEdit;
using DevExpress.XtraRichEdit.API.Native;

using (var wordProcessor = new RichEditDocumentServer()) {
    wordProcessor.LoadDocument("Texts\\Pictures.docx");
    Document doc = wordProcessor.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.Shapes.InsertPicture(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.Shapes.InsertPicture(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, wordProcessor));
    doc.Sections[0].EndUpdateHeader(docHeader);
}

VB.NET

Imports DevExpress.BarCodes
Imports DevExpress.XtraRichEdit
Imports DevExpress.XtraRichEdit.API.Native

Using wordProcessor = New RichEditDocumentServer()
  wordProcessor.LoadDocument("Texts\Pictures.docx")
  Dim doc As Document = wordProcessor.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.Shapes.InsertPicture(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("InlinePictures.Resources." & imageToInsert)
  doc.Shapes.InsertPicture(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, wordProcessor))
  doc.Sections(0).EndUpdateHeader(docHeader)
End Using

Inheritance

Object

DocumentImageSource