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

Inserts an OLE object that contains a link to the specified file. The object is displayed in the document as an image.

Namespace: DevExpress.XtraRichEdit.API.Native

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

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.Win.Navigation

Declaration

C#

Shape InsertOleObject(
    DocumentPosition pos,
    string fileName,
    string progId,
    DocumentImageSource presentation
)

VB.NET

Function InsertOleObject(
    pos As DocumentPosition,
    fileName As String,
    progId As String,
    presentation As DocumentImageSource
) As Shape

Parameters

Name	Type	Description
pos	DocumentPosition	The position of the object’s anchor.
fileName	String	A path to the file associated with the OLE object.
progId	String	The file 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.

Returns

Type	Description
Shape	The OLE object added to the document.

Remarks

The following example adds a linked OLE object to the document:

C#

Document document = wordProcessor.Document;
// Insert an OLE object. Link it to an Excel worksheet.
Shape oleObject = document.Shapes.InsertOleObject(document.CreatePosition(1780), @"D:\ExcelWorkbook.xlsx",
    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;

VB.NET

Dim document As Document = wordProcessor.Document
' Insert an OLE object. Link it to an Excel worksheet.
Dim oleObject As Shape = document.Shapes.InsertOleObject(document.CreatePosition(1780), "D:\ExcelWorkbook.xlsx", _ 
    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 image to open the file associated with the OLE object.