The requested page is not available for the requested platform. You are viewing the content for .NET Framework 4.5.2+ platform.
.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+

DocumentImageCollection Interface

A collection of DocumentImage objects.

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

[ComVisible(true)]
public interface DocumentImageCollection :
    ReadOnlyDocumentImageCollection,
    ISimpleCollection<DocumentImage>,
    IEnumerable<DocumentImage>,
    IEnumerable,
    ICollection
<ComVisible(True)>
Public Interface DocumentImageCollection
    Inherits ReadOnlyDocumentImageCollection,
             ISimpleCollection(Of DocumentImage),
             IEnumerable(Of DocumentImage),
             IEnumerable,
             ICollection
[ComVisible(true)]
public interface DocumentImageCollection :
    ReadOnlyDocumentImageCollection,
    ISimpleCollection<DocumentImage>,
    IEnumerable<DocumentImage>,
    IEnumerable,
    ICollection
<ComVisible(True)>
Public Interface DocumentImageCollection
    Inherits ReadOnlyDocumentImageCollection,
             ISimpleCollection(Of DocumentImage),
             IEnumerable(Of DocumentImage),
             IEnumerable,
             ICollection

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.

Examples

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