DocumentImageCollection Interface

A collection of DocumentImage objects.

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

C#

[ComVisible(true)]
public interface DocumentImageCollection :
    ReadOnlyDocumentImageCollection,
    ISimpleCollection<DocumentImage>,
    IEnumerable<DocumentImage>,
    IEnumerable,
    ICollection

VB.NET

<ComVisible(True)>
Public Interface DocumentImageCollection
    Inherits ReadOnlyDocumentImageCollection,
             ISimpleCollection(Of DocumentImage),
             IEnumerable(Of DocumentImage),
             IEnumerable,
             ICollection

Related API Members

The following members return DocumentImageCollection objects:

• SubDocument.Images

Remarks

The DocumentImageCollection object holds all document images. Use the SubDocument.Images property to access this collection.
Call the ReadOnlyDocumentImageCollection.Get method to get images located in the specified document range.

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)

Use the DocumentImageCollection.Insert or DocumentImageCollection.Append method to place a new image. The created object is also added to the ShapeCollection.

Example

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;
DocumentPosition pos = document.Range.Start;
document.Images.Insert(pos, DocumentImageSource.FromFile("Documents\\beverages.png"));

InlinePictureActions.vb

Dim document As Document = server.Document
Dim pos As DocumentPosition = document.Range.Start
document.Images.Insert(pos, DocumentImageSource.FromFile("Documents\beverages.png"))