Skip to main content
All docs
.NET Framework 4.5.2+

ShapeCollection.InsertOleObject(DocumentPosition, Stream, String, DocumentImageSource) Method

Inserts an OLE object that stores data from the specified file. The object is displayed in the document as an image.

Namespace: DevExpress.XtraRichEdit.API.Native

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

NuGet Package: DevExpress.RichEdit.Core


Shape InsertOleObject(
    DocumentPosition pos,
    Stream stream,
    string progId,
    DocumentImageSource presentation


Name Type Description
pos DocumentPosition

The position of the object’s anchor.

stream Stream

A stream that contains data to embed in the document.

progId String

Embedded content type. You can use constant fields of the OleObjectType class to set this value.

presentation DocumentImageSource

The source for the image that displays OLE object content.


Type Description

The OLE object added to the document.


The following example embeds an OLE object in the document:

Document document = wordProcessor.Document;
// Embed data from an Excel worksheet in the document.
using (Stream excelStream = File.Open(@"D:\ExcelWorkbook.xlsx", FileMode.Open))
    Shape oleObject = document.Shapes.InsertOleObject(document.CreatePosition(1780), excelStream,
        OleObjectType.ExcelWorksheet, DocumentImageSource.FromFile(@"Images\Spreadsheet.png"));
    // Specify the object position on the page.
    oleObject.RelativeHorizontalPosition = ShapeRelativeHorizontalPosition.Column;
    oleObject.RelativeVerticalPosition = ShapeRelativeVerticalPosition.Paragraph;
    oleObject.Offset = new PointF(0, 0);
    // Specify how text wraps around the object. 
    oleObject.TextWrapping = TextWrappingType.TopAndBottom;

Open the document in Microsoft® Word® and double-click the OLE object to modify the embedded data.

Insert an Embedded OLE Object

See Also