ShapeCollection.InsertPicture(DocumentPosition, DocumentImageSource) Method

Inserts a picture in the document.

Namespace: DevExpress.XtraRichEdit.API.Native

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

NuGet Package: DevExpress.RichEdit.Core

Declaration

C#

Shape InsertPicture(
    DocumentPosition pos,
    DocumentImageSource imageSource
)

VB.NET

Function InsertPicture(
    pos As DocumentPosition,
    imageSource As DocumentImageSource
) As Shape

Parameters

Name	Type	Description
pos	DocumentPosition	The position of the picture’s anchor.
imageSource	DocumentImageSource	An object that specifies the image source.

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),
    DocumentImageSource.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), DocumentImageSource.FromFile("Documents\beverages.png"))
myPicture.HorizontalAlignment = ShapeHorizontalAlignment.Center

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the InsertPicture(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#

wpf-richedit-document-api/CS/DXRichEditControlAPISample/CodeExamples/ShapesActions.cs#L25

{
    Shape myPicture = document.Shapes.InsertPicture(document.CreatePosition(15),
        DocumentImageSource.FromStream(s));

VB.NET

wpf-richedit-document-api/VB/DXRichEditControlAPISample/CodeExamples/ShapesActions.vb#L20

Using s As Stream = streamResInfo.Stream
    Dim myPicture As Shape = document.Shapes.InsertPicture(document.CreatePosition(15), DocumentImageSource.FromStream(s))
    myPicture.HorizontalAlignment = ShapeHorizontalAlignment.Center