SubDocument.AppendHtmlText(String, InsertOptions) Method

Appends HTML formatted text.

Namespace: DevExpress.XtraRichEdit.API.Native

Assembly: DevExpress.RichEdit.v24.1.Core.dll

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.Win.Navigation

Declaration

C#

DocumentRange AppendHtmlText(
    string htmlText,
    InsertOptions insertOptions
)

VB.NET

Function AppendHtmlText(
    htmlText As String,
    insertOptions As InsertOptions
) As DocumentRange

Parameters

Name	Type	Description
htmlText	String	A string containing data in HTML format.
insertOptions	InsertOptions	An InsertOptions enumeration value, specifying how destination formatting is applied to appended content in certain cases.

Returns

Type	Description
DocumentRange	A DocumentRange representing a range with appended content.

Remarks

The AppendHtmlText method imports the specified string in HTML format into the internal document model.

Note

Do not include the meta charset attribute in HTML string that is supplied to this method. It will result in incorrect character encoding.

If the HTML string contains links to external content, such as pictures, the corresponding attributes should contain a valid URL from which the content can be downloaded.

After the string is successfully imported, the new document model is inserted at the end of the main document.

Use the InsertOptions.KeepSourceFormatting value for the insertOptions parameter if you observe that the last item in the numbered list is copied as a simple paragraph (not in the list) after insertion using the AppendHtmlText method.

If the Paragraph.ContextualSpacing property of the last paragraph is false (default), RichEditControl inserts additional space between inserted HTML paragraphs. To remove extra space, set the Paragraph.ContextualSpacing option to true for paragraphs in the document and set the Paragraph.SpacingAfter property of the current paragraph and the Paragraph.SpacingBefore property of the next paragraph to zero (0).

Note

If you want more control over the text before it is inserted, create an instance of the RichEditDocumentServer and load the string into it. Then use the SubDocument.AppendDocumentContent method to append the modified document.