DocumentImageCollection.Insert(DocumentPosition, DocumentImageSource) Method

Inserts an image at the specified position in the document.

Namespace: DevExpress.XtraRichEdit.API.Native

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

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.

Remarks

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

To insert a picture in line with text, use the DocumentImageCollection.Insert method.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/winforms-richedit-document-api-e5219

InlinePictures.vb

Dim pos As DocumentPosition = document.Range.Start
document.Images.Insert(pos, DocumentImageSource.FromFile("beverages.png"))

InlinePictures.cs

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

To inserts a picture as a floating object, use the ShapeCollection.InsertPicture method.

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#

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

string imageToInsert = dialog.FileName;
richEditControl1.Document.Images.Insert(pos,
    DocumentImageSource.FromFile(imageToInsert));

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;

tables-simple-example-t472346/CS/TablesSimpleExample/Form1.cs#L104

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

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

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

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

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

VB.NET

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

    Dim imageToInsert As String = dialog.FileName
    richEditControl1.Document.Images.Insert(pos, DocumentImageSource.FromFile(imageToInsert))
End If

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

tables-simple-example-t472346/VB/TablesSimpleExample/Form1.vb#L98

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

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

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

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

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