SubDocument.InsertHtmlText(DocumentPosition, String, InsertOptions) Method
Inserts the specified HTML text into the specified position.
Namespace: DevExpress.XtraRichEdit.API.Native
Assembly: DevExpress.RichEdit.v24.2.Core.dll
NuGet Package: DevExpress.RichEdit.Core
Declaration
DocumentRange InsertHtmlText(
DocumentPosition pos,
string htmlText,
InsertOptions insertOptions
)Parameters
| Name | Type | Description |
|---|---|---|
| pos | DocumentPosition | A DocumentPosition object specifying the position at which the text should be inserted. |
| htmlText | String | A string in HTML format. |
| insertOptions | InsertOptions | An InsertOptions enumeration value, specifying how destination formatting is applied to inserted content in certain special cases, i.e., when inserting a numbering list. |
Returns
| Type | Description |
|---|---|
| DocumentRange | A DocumentPosition object specifying the position at which the text should be inserted. |
Remarks
The InsertHtmlText 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 specified position 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 InsertHtmlText 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.InsertDocumentContent method to insert the modified document.