SubDocument.InsertImage(DocumentPosition, Image) Method

OBSOLETE

This method has become obsolete. Use the 'Insert' method instead.

Inserts an image into the specified position in the document.

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

C#

[Obsolete("This method has become obsolete. Use the 'DevExpress.XtraRichEdit.API.Native.DocumentImageCollection.Insert(DocumentPosition pos, System.Drawing.Image image)' method instead.")]
DocumentImage InsertImage(
    DocumentPosition pos,
    Image image
)

VB.NET

<Obsolete("This method has become obsolete. Use the 'DevExpress.XtraRichEdit.API.Native.DocumentImageCollection.Insert(DocumentPosition pos, System.Drawing.Image image)' method instead.")>
Function InsertImage(
    pos As DocumentPosition,
    image As Image
) As DocumentImage

Parameters

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

Returns

Type	Description
DocumentImage	A DocumentImage object representing an inline image in the document.

Remarks

The InsertImage method inserts an inline picture in the document so that the picture maintains a link to the original image. Any image modifications or its disposal result in a changed or disappearing picture. To prevent this, clone the original image and supply the clone to the InsertImage method, as illustrated in the following code snippet.

C#

richEditControl1.Document.InsertImage(richEditControl1.Document.CaretPosition, (Image)myImage.Clone());

VB.NET

richEditControl1.Document.InsertImage(richEditControl1.Document.CaretPosition, CType(myImage.Clone(), Image))

Related GitHub Examples

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

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

    doc.Delete(r);
    doc.InsertImage(r.Start, smile);
}

how-to-create-an-editor-similar-to-outlook-attachment-editor-e4911/CS/WindowsFormsApplication1/WindowsFormsApplication1/AttachmentsEditor.cs#L85

FileFieldInfo info = filesCollection[e.VariableName];
server.Document.InsertImage(server.Document.Range.End, new Bitmap(Icon.ExtractAssociatedIcon(info.FullFileName).ToBitmap(), new Size(16, 16)));
DocumentRange range = server.Document.AppendText(info.FileName + "; ");

VB.NET

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

    doc.Delete(r)
    doc.InsertImage(r.Start, smile)
Next r

how-to-create-an-editor-similar-to-outlook-attachment-editor-e4911/VB/WindowsFormsApplication1/AttachmentsEditor.vb#L89

Dim info As FileFieldInfo = filesCollection(e.VariableName)
server.Document.InsertImage(server.Document.Range.End, New Bitmap(Icon.ExtractAssociatedIcon(info.FullFileName).ToBitmap(), New Size(16, 16)))
Dim range As DocumentRange = server.Document.AppendText(info.FileName & "; ")