Back to Devexpress

IdxRichEditSubDocument.AppendRtfText(string,TdxRichEditInsertOptions) Method

vcl-dxrichedit-dot-nativeapi-dot-idxricheditsubdocument-dot-appendrtftext-x28-system-dot-string-dxrichedit-dot-nativeapi-dot-tdxricheditinsertoptions-x29.md

latest2.5 KB
Original Source

IdxRichEditSubDocument.AppendRtfText(string,TdxRichEditInsertOptions) Method

Appends a formatted text string to the end of a subdocument.

Declaration

delphi
function AppendRtfText(const ARtfText: string; AInsertOptions: TdxRichEditInsertOptions = TdxRichEditInsertOptions.MatchDestinationFormatting): IdxRichEditDocumentRange;

Parameters

NameType
ARtfTextstring
AInsertOptionsTdxRichEditInsertOptions

Returns

Type
IdxRichEditDocumentRange

Remarks

Call the AppendRtfText function to insert the string in RTF format passed as the ARtfText parameter. Use the optional AInsertOptions parameter to specify whether the inserted string retains its formatting or not. For more information on formatted text insert options, refer to the TdxRichEditInsertOptions type description.

The AppendRtfText function returns the document range corresponding to the text inserted into the main document body, header, footer, or floating text box.

If you need to remove text from the document, invoke the Delete procedure.

See Also

IdxRichEditSubDocument.AppendSingleLineText

IdxRichEditSubDocument.AppendText

IdxRichEditSubDocument.InsertRtfText

IdxRichEditSubDocument.InsertSingleLineText

IdxRichEditSubDocument.InsertText

IdxRichEditSubDocument Interface

IdxRichEditSubDocument Members

dxRichEdit.NativeApi Unit