ShapeCollection.InsertPicture(DocumentPosition, Image) Method

Inserts a picture 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#

Shape InsertPicture(
    DocumentPosition pos,
    Image image
)

VB.NET

Function InsertPicture(
    pos As DocumentPosition,
    image As Image
) As Shape

Parameters

Name	Type	Description
pos	DocumentPosition	The position of the picture’s anchor.
image	Image	The image to insert.

Returns

Type	Description
Shape	The picture embedded in the document.

Remarks

The InsertPicture method positions a floating picture at the top-left corner of the page that contains the picture’s anchor. The TextWrapping property is set to InFrontOfText.

The Word Processing Document API and Rich Text Editors support the following image types:

• Bitmap (*.bmp, *.dib)
• JPEG File Interchange Format (*.jpg, *.jpeg)
• Portable Network Graphics (*.png)
• Graphics Interchange Format (*.gif)
• Tagged Image Format (*.tif, *.tiff)
• Microsoft Enhanced Metafile (*.emf)
• Windows Metafile (*.wmf)

The example below inserts a picture and specifies its horizontal alignment.

C#

Document document = wordProcessor.Document;
document.AppendText("Line One\nLine Two\nLine Three");
Shape myPicture = document.Shapes.InsertPicture(document.CreatePosition(15),
    System.Drawing.Image.FromFile("Documents\\beverages.png"));
myPicture.HorizontalAlignment = ShapeHorizontalAlignment.Center;

VB.NET

Dim document As Document = wordProcessor.Document
document.AppendText("Line One" & vbLf & "Line Two" & vbLf & "Line Three")
Dim myPicture As Shape = document.Shapes.InsertPicture(document.CreatePosition(15), System.Drawing.Image.FromFile("Documents\beverages.png"))
myPicture.HorizontalAlignment = ShapeHorizontalAlignment.Center

Related GitHub Examples

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

how-to-add-a-watermark-with-a-text-or-image-to-the-document-e4184/CS/Form1.cs#L51

subDocument.Delete(subDocument.Range);
Shape shape = subDocument.Shapes.InsertPicture(subDocument.Range.Start, image);

how-to-add-remove-a-specific-watermark-only-for-a-particular-section-of-the-richeditcontrols-e4901/CS/WindowsFormsApplication1/Form1.cs#L52

subDocument.Delete(subDocument.Range);
Shape shape = subDocument.Shapes.InsertPicture(subDocument.Range.Start, watermarkImage);

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

document.AppendText("Line One\nLine Two\nLine Three");
Shape myPicture = document.Shapes.InsertPicture(document.CreatePosition(15),
    System.Drawing.Image.FromFile("Documents\\beverages.png"));

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

document.AppendText("Line One\nLine Two\nLine Three");
Shape myPicture = document.Shapes.InsertPicture(document.CreatePosition(15),
    System.Drawing.Image.FromFile("beverages.png"));

VB.NET

how-to-add-a-watermark-with-a-text-or-image-to-the-document-e4184/VB/Form1.vb#L53

subDocument.Delete(subDocument.Range)
Dim shape As Shape = subDocument.Shapes.InsertPicture(subDocument.Range.Start, image)

how-to-add-remove-a-specific-watermark-only-for-a-particular-section-of-the-richeditcontrols-e4901/VB/WindowsFormsApplication1/Form1.vb#L54

subDocument.Delete(subDocument.Range)
Dim shape As Shape = subDocument.Shapes.InsertPicture(subDocument.Range.Start, watermarkImage)

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

document.AppendText("Line One" & Global.Microsoft.VisualBasic.Constants.vbLf & "Line Two" & Global.Microsoft.VisualBasic.Constants.vbLf & "Line Three")
Dim myPicture As DevExpress.XtraRichEdit.API.Native.Shape = document.Shapes.InsertPicture(document.CreatePosition(15), System.Drawing.Image.FromFile("Documents\beverages.png"))
myPicture.HorizontalAlignment = DevExpress.XtraRichEdit.API.Native.ShapeHorizontalAlignment.Center

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

document.AppendText("Line One" & Global.Microsoft.VisualBasic.Constants.vbLf & "Line Two" & Global.Microsoft.VisualBasic.Constants.vbLf & "Line Three")
Dim myPicture As DevExpress.XtraRichEdit.API.Native.Shape = document.Shapes.InsertPicture(document.CreatePosition(15), System.Drawing.Image.FromFile("beverages.png"))
myPicture.HorizontalAlignment = DevExpress.XtraRichEdit.API.Native.ShapeHorizontalAlignment.Center