IdxRichEditSubDocument.InsertImage(IdxRichEditDocumentPosition,TGraphic) Method

Inserts an inline picture at the specified position within the document.

Declaration

function InsertImage(const APos: IdxRichEditDocumentPosition; AImage: TGraphic): IdxRichEditDocumentImage;

Parameters

Name	Type
APos	IdxRichEditDocumentPosition
AImage	TGraphic

Returns

Type
IdxRichEditDocumentImage

Remarks

Call this function to insert an inline picture at the document position passed as the APos parameter. Use the AImage parameter to pass a source image hosted within an image container. Currently, the Rich Edit control supports all image formats provided by the smart image container, except for SVG.

The InsertPicture function returns the inline image inserted into a document or subdocument (that is, header, footer, or floating text box). Note that this function has no effect and returns nil if nil is passed as the AImage parameter.

Note

Call the InsertPicture function instead of InsertImage to insert a floating picture into a document.