officefileapi-devexpress-dot-xtrarichedit-dot-api-dot-native-dot-shapecollection-dot-insertpicture-x28-devexpress-dot-xtrarichedit-dot-api-dot-native-dot-documentposition-devexpress-dot-xtrarichedit-dot-api-dot-native-dot-documentimagesource-x29.md
Inserts a picture in the document.
Namespace : DevExpress.XtraRichEdit.API.Native
Assembly : DevExpress.RichEdit.v25.2.Core.dll
NuGet Package : DevExpress.RichEdit.Core
Shape InsertPicture(
DocumentPosition pos,
DocumentImageSource imageSource
)
Function InsertPicture(
pos As DocumentPosition,
imageSource As DocumentImageSource
) As Shape
| Name | Type | Description |
|---|---|---|
| pos | DocumentPosition |
The position of the picture’s anchor.
| | imageSource | DocumentImageSource |
An object that specifies the image source.
|
| Type | Description |
|---|---|
| Shape |
The picture embedded in the document.
|
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 following image formats are available:
The example below inserts a picture and specifies its horizontal alignment.
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;
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
The following code snippets (auto-collected from DevExpress Examples) contain references 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.
word-document-api-insert-inline-pictures/CS/Program.cs#L26
DocumentPosition pos = document.Paragraphs[document.Paragraphs.Get(rangeFound.End).Index + 2].Range.Start;
Shape imageFromFile = document.Shapes.InsertPicture(pos, DocumentImageSource.FromFile("Pictures\\ReadersChoice.png"));
imageFromFile.TextWrapping = TextWrappingType.InLineWithText;
wpf-richedit-document-api/CS/DXRichEditControlAPISample/CodeExamples/ShapesActions.cs#L25
{
Shape myPicture = document.Shapes.InsertPicture(document.CreatePosition(15),
DocumentImageSource.FromStream(s));
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),
DocumentImageSource.FromFile("beverages.png"));
word-document-api-create-master-detail-report/CS/Program.cs#L72
using var imageStream = File.OpenRead(Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "..", "..", "..", "..", "data", "logo.png"));
Shape shape = pictureProcessor.Document.Shapes.InsertPicture(pictureProcessor.Document.Range.End, DocumentImageSource.FromStream(imageStream));
shape.TextWrapping = TextWrappingType.InLineWithText;
word-document-api-insert-inline-pictures/VB/Program.vb#L19
Dim pos As DocumentPosition = document.Paragraphs(document.Paragraphs.Get(rangeFound.End).Index + 2).Range.Start
Dim imageFromFile As Shape = document.Shapes.InsertPicture(pos, DocumentImageSource.FromFile("Pictures\ReadersChoice.png"))
imageFromFile.TextWrapping = TextWrappingType.InLineWithText
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
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), DevExpress.XtraRichEdit.API.Native.DocumentImageSource.FromFile("beverages.png"))
myPicture.HorizontalAlignment = DevExpress.XtraRichEdit.API.Native.ShapeHorizontalAlignment.Center
word-document-api-create-master-detail-report/VB/Program.vb#L72
Using imageStream As Stream = File.OpenRead(Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "..", "..", "..", "..", "data", "logo.png"))
Dim shape As Shape = pictureProcessor.Document.Shapes.InsertPicture(pictureProcessor.Document.Range.End, DocumentImageSource.FromStream(imageStream))
shape.TextWrapping = TextWrappingType.InLineWithText
See Also