ShapeCollection.InsertOleObjectAsIcon(DocumentPosition, Stream, String, DocumentImageSource) Method
In This Article
Inserts an OLE object that stores data from the specified file. The object is displayed in the document as an icon.
Namespace: DevExpress.XtraRichEdit.API.Native
Assembly: DevExpress.RichEdit.v24.2.Core.dll
NuGet Package: DevExpress.RichEdit.Core
#Declaration
Shape InsertOleObjectAsIcon(
DocumentPosition pos,
Stream stream,
string progId,
DocumentImageSource icon
)
#Parameters
Name | Type | Description |
---|---|---|
pos | Document |
The position of the object’s anchor. |
stream | Stream | A stream that contains data to embed in the document. |
prog |
String | Embedded content type. You can use constant fields of the Ole |
icon | Document |
An object used to load the icon for the OLE object. |
#Returns
Type | Description |
---|---|
Shape | The OLE object added to the document. |
#Remarks
The following example embeds an OLE object in the document:
Document document = wordProcessor.Document;
// Embed data from an Excel worksheet in the document.
// The OLE object is displayed in the document as an icon.
using (Stream excelStream = File.Open(@"D:\ExcelWorkbook.xlsx", FileMode.Open))
{
Shape oleObject = document.Shapes.InsertOleObjectAsIcon(document.CreatePosition(1780), excelStream,
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;
}
See Also