All docs
V20.2
20.2
20.1
The page you are viewing does not exist in version 20.1. This link will take you to the root page.
19.2
The page you are viewing does not exist in version 19.2. This link will take you to the root page.
19.1
The page you are viewing does not exist in version 19.1. This link will take you to the root page.
18.2
The page you are viewing does not exist in version 18.2. This link will take you to the root page.
18.1
The page you are viewing does not exist in version 18.1. This link will take you to the root page.
17.2
The page you are viewing does not exist in version 17.2. This link will take you to the root page.
.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+

ShapeCollection.InsertOleObjectAsIcon(DocumentPosition, String, String, Image) 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.v20.2.Core.dll

Declaration

Shape InsertOleObjectAsIcon(
    DocumentPosition pos,
    string fileName,
    string progId,
    Image icon
)
Function InsertOleObjectAsIcon(
    pos As DocumentPosition,
    fileName As String,
    progId As String,
    icon As Image
) 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.

icon Image

The icon for the OLE object.

Returns

Type Description
Shape

The OLE object added to the document.

Remarks

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, System.Drawing.Image.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