NestedShapeCollection.AddOleObjectAsIcon(String, String, DocumentImageSource, RectangleF) Method

SECURITY-RELATED CONSIDERATIONS

Using file paths sourced from untrusted input may expose unauthorized files or allow unintended file access. Always validate and normalize all external paths to prevent path manipulation.

Adds a linked OLE object to a shape group or a drawing canvas. The object is displayed in the document as an icon.

Namespace : DevExpress.XtraRichEdit.API.Native

Assembly : DevExpress.RichEdit.v25.2.Core.dll

NuGet Package : DevExpress.RichEdit.Core

csharp

NestedShape AddOleObjectAsIcon(
    string fileName,
    string progId,
    DocumentImageSource icon,
    RectangleF bounds
)

Function AddOleObjectAsIcon(
    fileName As String,
    progId As String,
    icon As DocumentImageSource,
    bounds As RectangleF
) As NestedShape

Parameters

Name	Type	Description
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.

| | bounds | RectangleF |

An object that defines the object’s size and location (relative to the top left corner of the parent object). The Document.Unit property specifies measurement units.

Returns

Type	Description
NestedShape

The OLE object in the group or drawing canvas.