Back to Devexpress

IdxRichEditSubDocument.InsertTextBox(IdxRichEditDocumentPosition) Method

vcl-dxrichedit-dot-nativeapi-dot-idxricheditsubdocument-dot-inserttextbox-x28-dxrichedit-dot-nativeapi-dot-idxricheditdocumentposition-x29.md

latest1.8 KB
Original Source

IdxRichEditSubDocument.InsertTextBox(IdxRichEditDocumentPosition) Method

Inserts a floating text box at the specified position within the document.

Declaration

delphi
function InsertTextBox(const APos: IdxRichEditDocumentPosition): IdxRichEditShape;

Parameters

NameType
APosIdxRichEditDocumentPosition

Returns

Type
IdxRichEditShape

Remarks

Call this function to:

  • Insert an empty floating text box anchored at the beginning of the page that includes the document position passed as the APos parameter;

  • Obtain the floating shape that hosts the created text box.

Refer to the How to Insert a Floating Text Box topic for additional information.

Note

Calling the text box’s Document. InsertTextBox function raises an exception, since the Rich Edit control does not support creating floating shapes within floating shapes.

See Also

IdxRichEditShapeCollection.InsertTextBox

IdxRichEditSubDocument Interface

IdxRichEditSubDocument Members

dxRichEdit.NativeApi Unit