Skip to main content
All docs
.NET Framework 4.5.2+

ShapeCollection.InsertOleObjectAsIcon(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 icon.

Namespace: DevExpress.XtraRichEdit.API.Native

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

NuGet Package: DevExpress.RichEdit.Core


Shape InsertOleObjectAsIcon(
    DocumentPosition pos,
    string fileName,
    string progId,
    DocumentImageSource icon


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.

icon DocumentImageSource

An object used to load the icon for the OLE object.


Type Description

The OLE object added to the document.


The following example inserts a linked OLE object as an icon:

Document document = wordProcessor.Document;
// Insert an OLE object. Link it to an Excel worksheet.
// The OLE object is displayed in the document as an icon.
Shape oleObject = document.Shapes.InsertOleObjectAsIcon(document.CreatePosition(1780), @"D:\ExcelWorkbook.xlsx",
    OleObjectType.ExcelWorksheet, DocumentImageSource.FromFile(@"Images\Excel.ico"));
// 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 icon to open the file associated with the OLE object.

Insert an OLE Object as an Icon

See Also