DocumentImageCollection.Insert(DocumentPosition, DocumentImageSource) Method

Inserts an image at the specified position in the document.

Namespace: DevExpress.XtraRichEdit.API.Native

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

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.Win.Navigation

Declaration

C#

DocumentImage Insert(
    DocumentPosition pos,
    DocumentImageSource imageSource
)

VB.NET

Function Insert(
    pos As DocumentPosition,
    imageSource As DocumentImageSource
) As DocumentImage

Parameters

Name	Type	Description
pos	DocumentPosition	A DocumentPosition object specifying the position to insert an image.
imageSource	DocumentImageSource	A DocumentImageSource object containing information about the image to insert.

Returns

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

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

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Insert(DocumentPosition, DocumentImageSource) 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#

how-to-retain-original-image-uri-in-html-document-e3189/CS/HTML_Export_ImageSourceExample/Form1.cs#L18

DocumentPosition pos = richEditControl1.Document.CaretPosition;
richEditControl1.Document.Images.Insert(pos, DocumentImageSource.FromUri(imageUri, null));
embedImagesCheck.EditValue = true;

winforms-richedit-document-api/CS/RichEditAPISample/CodeExamples/InlinePictures.cs#L16

DocumentPosition pos = document.Range.Start;
document.Images.Insert(pos, DocumentImageSource.FromFile("beverages.png"));
#endregion #ImageFromFile

wpf-richedit-document-api/CS/DXRichEditControlAPISample/CodeExamples/InlinePicturesActions.cs#L24

{
    document.Images.Insert(pos, DocumentImageSource.FromStream(s));
}

word-document-api-table-examples/CS/TablesSimpleExample/Program.cs#L87

//Insert the customer photo
document.Images.Insert(table[3, 0].Range.Start, DocumentImageSource.FromFile("photo.png"));

winforms-richedit-tables-simple-example/CS/TablesSimpleExample/Form1.cs#L113

// Insert the customer photo
document.Images.Insert(table[3, 1].Range.Start, DocumentImageSource.FromFile("photo.png"));

VB.NET

word-document-api-insert-inline-pictures/VB/InlinePictures/Program.vb#L26

Dim pos As DocumentPosition = doc.Paragraphs(doc.Paragraphs.Get(rangeFound.End).Index + 2).Range.Start
doc.Images.Insert(pos, DocumentImageSource.FromFile("Pictures\ReadersChoice.png"))
' Insert an image from a stream.

how-to-retain-original-image-uri-in-html-document-e3189/VB/HTML_Export_ImageSourceExample/Form1.vb#L17

Dim pos As DocumentPosition = richEditControl1.Document.CaretPosition
richEditControl1.Document.Images.Insert(pos, DocumentImageSource.FromUri(imageUri, Nothing))
embedImagesCheck.EditValue = True

winforms-richedit-document-api/VB/RichEditAPISample/CodeExamples/InlinePictures.vb#L15

            Dim pos As DevExpress.XtraRichEdit.API.Native.DocumentPosition = document.Range.Start
            document.Images.Insert(pos, DevExpress.XtraRichEdit.API.Native.DocumentImageSource.FromFile("beverages.png"))
#End Region  ' #ImageFromFile

wpf-richedit-document-api/VB/DXRichEditControlAPISample/CodeExamples/InlinePicturesActions.vb#L19

Using s As Stream = streamResInfo.Stream
    document.Images.Insert(pos, DocumentImageSource.FromStream(s))
End Using

word-document-api-table-examples/VB/TablesSimpleExample/Program.vb#L71

'Insert the customer photo
document.Images.Insert(table(3, 0).Range.Start, DocumentImageSource.FromFile("photo.png"))
'Insert the customer info