HtmlEditorExtension Class

Represents an extension object implementing the HtmlEditor functionality.

Namespace: DevExpress.Web.Mvc

Assembly: DevExpress.Web.Mvc.v18.1.dll

Declaration

C#

public class HtmlEditorExtension :
    ExtensionBase

VB.NET

Public Class HtmlEditorExtension
    Inherits ExtensionBase

Related API Members

The following members accept/return HtmlEditorExtension objects:

• ExtensionsFactory.HtmlEditor(Action<HtmlEditorSettings>)
• ExtensionsFactory.HtmlEditor(HtmlEditorSettings)
• ExtensionsFactory<ModelType>.HtmlEditorFor<ValueType>(Expression<Func<ModelType, ValueType>>)
• ExtensionsFactory<ModelType>.HtmlEditorFor<ValueType>(Expression<Func<ModelType, ValueType>>, Action<HtmlEditorSettings>)
• HtmlEditorExtension.Bind(Object)
• HtmlEditorExtension.Bind(Object, String)

Remarks

To declare the HtmlEditor in a View, invoke the ExtensionsFactory.HtmlEditor helper method. This method returns the HtmlEditor extension that is implemented by the HtmlEditorExtension class.

To configure the HtmlEditor extension, pass the HtmlEditorSettings object to the ExtensionsFactory.HtmlEditor helper method as a parameter. The HtmlEditorSettings object contains all the HtmlEditor extension settings.

Refer to the HtmlEditor Overview topic to learn how to add the HtmlEditor extension to your project.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the HtmlEditorExtension class.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

htmleditor-how-to-customize-the-controls-inside-the-default-spellchecker-dialog-t493023/CS/SpellCheckerCustomization/Models/MyHtmlEditorExtension.cs#L14

namespace SpellCheckerCustomization.Models {
    public class MyHtmlEditorExtension : HtmlEditorExtension {
        public MyHtmlEditorExtension(HtmlEditorSettings settings, ViewContext ctx)

htmleditor-how-to-embed-header-and-footer-to-exported-document-t135639/CS/Project/Controllers/HomeController.cs#L20

public ActionResult HtmlEditorPartialImageSelectorUpload() {
    HtmlEditorExtension.SaveUploadedImage("HtmlEditor", HomeControllerControllerHtmlEditorSettings.ImageSelectorSettings);
    return null;

how-to-upload-and-download-html-files-to-from-htmleditor-e2838/CS/Controllers/HomeController.cs#L26

public FileContentResult DownloadFile() {
    String html = HtmlEditorExtension.GetHtml("htmlEdit");

VB.NET

htmleditor-how-to-customize-the-controls-inside-the-default-spellchecker-dialog-t493023/VB/SpellCheckerCustomization/Models/MyHtmlEditorExtension.vb#L15

Public Class MyHtmlEditorExtension
    Inherits HtmlEditorExtension

htmleditor-how-to-embed-header-and-footer-to-exported-document-t135639/VB/Project/Controllers/HomeController.vb#L22

Public Function HtmlEditorPartialImageSelectorUpload() As ActionResult
    HtmlEditorExtension.SaveUploadedImage("HtmlEditor", HomeControllerControllerHtmlEditorSettings.ImageSelectorSettings)
    Return Nothing

how-to-upload-and-download-html-files-to-from-htmleditor-e2838/VB/Controllers/HomeController.vb#L28

Public Function DownloadFile() As FileContentResult
   Dim html As String = HtmlEditorExtension.GetHtml("htmlEdit")

Inheritance

Object

ExtensionBase

HtmlEditorExtension