DocumentImage Interface

Defines an image in the document.

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

C#

[ComVisible(true)]
public interface DocumentImage

VB.NET

<ComVisible(True)>
Public Interface DocumentImage

Related API Members

The following members accept/return DocumentImage objects:

• DocumentImageCollection.Append(DocumentImageSource)
• DocumentImageCollection.Append(Image)
• DocumentImageCollection.Insert(DocumentPosition, DocumentImageSource)
• DocumentImageCollection.Insert(DocumentPosition, Image)

Remarks

The DocumentImage provides information on the DocumentRange where the image is located, and the original and current size of the image.

All document images are contained in two collections: the DocumentImageCollection and ShapeCollection. Use the SubDocument.Images property to access the DocumentImageCollection. The SubDocument.Shapes property retrieves the ShapeCollection.
To get a collection of images located in the specified document range, call the ReadOnlyDocumentImageCollection.Get method.

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

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"))

The DocumentImageSource object implements methods used to create the DocumentImage object instance from various sources.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the DocumentImage interface.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-manually-create-a-table-of-contents-t488553/CS/TableOfContentsExample/MainWindow.xaml.cs#L28

{
    DocumentImage shape = document.Images[i];
    Paragraph paragraph = document.Paragraphs.Insert(shape.Range.End);

VB.NET

how-to-manually-create-a-table-of-contents-t488553/VB/TableOfContentsExample/MainWindow.xaml.vb#L25

For i As Integer = 0 To document.Images.Count - 1
    Dim shape As DocumentImage = document.Images(i)
    Dim paragraph As Paragraph = document.Paragraphs.Insert(shape.Range.End)