DocumentImageCollection Interface

Defines a collection of document images.

Namespace: DevExpress.XtraRichEdit.API.Native

Assembly: DevExpress.RichEdit.v18.2.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. To access this collection, use the SubDocument.Images property. To get a collection of images located in the specified document range, call the ReadOnlyDocumentImageCollection.Get method of the DocumentImageCollection object.

To place an image in the document, use the DocumentImageCollection.Insert or DocumentImageCollection.Append method.

Example

This sample code inserts a Image object into the document. The image is obtained from the ImageCollection control.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/inline-pictures-in-richeditcontrol-e1525

Form1.vb

Imports DevExpress.XtraRichEdit
Imports DevExpress.XtraRichEdit.API.Native
' ...
Dim pos As DocumentPosition = richEditControl1.Document.CaretPosition
Dim imageToInsert As Image = imageCollection1.Images(3)
richEditControl1.Document.Images.Insert(pos, imageToInsert)

Form1.cs

using DevExpress.XtraRichEdit;
using DevExpress.XtraRichEdit.API.Native;
// ...
DocumentPosition pos = richEditControl1.Document.CaretPosition;
Image imageToInsert = imageCollection1.Images[3];
richEditControl1.Document.Images.Insert(pos, imageToInsert);