DocumentImageCollection.Insert(DocumentPosition, Image) Method

Inserts an image at the specified position in the document.

Namespace: DevExpress.XtraRichEdit.API.Native

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

NuGet Package: DevExpress.RichEdit.Core

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.WindowsDesktop.RichEdit.Core

Declaration

C#

DocumentImage Insert(
    DocumentPosition pos,
    Image image
)

VB.NET

Function Insert(
    pos As DocumentPosition,
    image As Image
) As DocumentImage

Parameters

Name	Type	Description
pos	DocumentPosition	A DocumentPosition object specifying the position to insert an image.
image	Image	A Image object specifying the image to insert.

Returns

Type	Description
DocumentImage	A DocumentImage object specifying the inline image in the document.

Remarks

C#

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

VB.NET

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

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Insert(DocumentPosition, Image) method.

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#

inline-pictures-in-richeditcontrol-e1525/CS/InlinePictures/Form1.cs#L29

Image imageToInsert = imageCollection1.Images[3];
richEditControl1.Document.Images.Insert(pos, imageToInsert);

word-document-api-examples/CS/CodeExamples/ShapesActions.cs#L91

// Insert an image form the main document into the text box.
boxedDocument.Images.Insert(boxedDocument.CreatePosition(appendPosition), document.Images[0].Image.NativeImage);
// Resize the image so that its size equals the image in the main document.

wpf-richedit-document-api/CS/DXRichEditControlAPISample/CodeExamples/ShapesActions.cs#L95

// Insert an image form the main document into the text box.
boxedDocument.Images.Insert(boxedDocument.CreatePosition(appendPosition), document.Images[0].Image.NativeImage);
// Resize the image so that its size equals the image in the main document.

winforms-richedit-document-api/CS/RichEditAPISample/CodeExamples/Shapes.cs#L84

// Insert an image form the main document into the text box.
boxedDocument.Images.Insert(boxedDocument.CreatePosition(appendPosition), document.Images[0].Image.NativeImage);
// Resize the image so that its size equals the image in the main document.

dxrichedit-for-wpf-how-to-customize-the-hover-menu-e2753/CS/DXRichEdit_HoverMenu/MySmileyCommand.cs#L91

    doc.Delete(r);
    doc.Images.Insert(r.Start, smile);
}

VB.NET

inline-pictures-in-richeditcontrol-e1525/VB/InlinePictures/Form1.vb#L31

Dim imageToInsert As Image = imageCollection1.Images(3)
richEditControl1.Document.Images.Insert(pos, imageToInsert)

word-document-api-examples/VB/CodeExamples/ShapesActions.vb#L84

' Insert an image form the main document into the text box.
boxedDocument.Images.Insert(boxedDocument.CreatePosition(appendPosition), document.Images(CInt((0))).Image.NativeImage)
' Resize the image so that its size equals the image in the main document.

wpf-richedit-document-api/VB/DXRichEditControlAPISample/CodeExamples/ShapesActions.vb#L85

' Insert an image form the main document into the text box.
boxedDocument.Images.Insert(boxedDocument.CreatePosition(appendPosition), document.Images(0).Image.NativeImage)
' Resize the image so that its size equals the image in the main document.

winforms-richedit-document-api/VB/RichEditAPISample/CodeExamples/Shapes.vb#L78

' Insert an image form the main document into the text box.
boxedDocument.Images.Insert(boxedDocument.CreatePosition(appendPosition), document.Images(CInt((0))).Image.NativeImage)
' Resize the image so that its size equals the image in the main document.

dxrichedit-for-wpf-how-to-customize-the-hover-menu-e2753/VB/DXRichEdit_HoverMenu/MySmileyCommand.vb#L85

    doc.Delete(r)
    doc.Images.Insert(r.Start, smile)
Next r