ShapeCollection.InsertPicture(DocumentPosition, Image) Method

Inserts a picture as a floating object.

Namespace: DevExpress.XtraRichEdit.API.Native

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

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	A DocumentPosition object that is the position in a paragraph to which a floating object will be anchored.
image	Image	A Image object specifying the image to insert.

Returns

Type	Description
Shape	A Shape interface exposing properties and methods of a newly created floating object containing the specified picture.

Remarks

The InsertPicture method positions a floating picture at the beginning of the first paragraph on the page that contains the floating object’s anchor.

To insert an inline picture, use the DocumentImageCollection.Insert method.

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

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

winforms-richedit-document-api-e5219/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"));

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

VB.NET

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)

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)

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

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

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

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