DocumentImage Interface

Defines an image in the document.

Namespace: DevExpress.XtraRichEdit.API.Native

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

NuGet Package: DevExpress.RichEdit.Core

Declaration

C#

[ComVisible(true)]
public interface DocumentImage

VB.NET

<ComVisible(True)>
Public Interface DocumentImage

Related API Members

The following members 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.

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

Example

This sample code inserts an image into the document using the image source object created from the specified file.

View Example

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