Class RichTextEditorBuilder
Inheritance
System.Object
RichTextEditorBuilder
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Assembly: Syncfusion.EJ2.dll
Syntax
public class RichTextEditorBuilder : ControlBuilder
Constructors
RichTextEditorBuilder()
Declaration
public RichTextEditorBuilder()
RichTextEditorBuilder(RichTextEditor)
Declaration
public RichTextEditorBuilder(RichTextEditor model)
Parameters
Fields
model
Declaration
public RichTextEditor model
Field Value
Properties
HtmlAttr
Declaration
public IDictionary<string, object> HtmlAttr { get; set; }
Property Value
| Type |
Description |
| System.Collections.Generic.IDictionary<System.String, System.Object> |
|
ID
Declaration
public string ID { get; set; }
Property Value
| Type |
Description |
| System.String |
|
Output
Declaration
public override TextWriter Output { get; set; }
Property Value
| Type |
Description |
| System.IO.TextWriter |
|
Overrides
Methods
ActionBegin(String)
Triggers before command execution using toolbar items or executeCommand method.
If you cancel this event, the command cannot be executed.
Set the cancel argument to true to cancel the command execution.
Declaration
public RichTextEditorBuilder ActionBegin(string actionBegin)
Parameters
| Type |
Name |
Description |
| System.String |
actionBegin |
|
Returns
ActionComplete(String)
Triggers after command execution using toolbar items or executeCommand method.
Declaration
public RichTextEditorBuilder ActionComplete(string actionComplete)
Parameters
| Type |
Name |
Description |
| System.String |
actionComplete |
|
Returns
AfterImageDelete(String)
Event triggers when the selected image is cleared from the Rich Text Editor Content.
Declaration
public RichTextEditorBuilder AfterImageDelete(string afterImageDelete)
Parameters
| Type |
Name |
Description |
| System.String |
afterImageDelete |
|
Returns
AfterMediaDelete(String)
Event triggers when the selected media is cleared from the Rich Text Editor Content.
Declaration
public RichTextEditorBuilder AfterMediaDelete(string afterMediaDelete)
Parameters
| Type |
Name |
Description |
| System.String |
afterMediaDelete |
|
Returns
AfterPasteCleanup(String)
Triggers after cleanup the copied content.
Declaration
public RichTextEditorBuilder AfterPasteCleanup(string afterPasteCleanup)
Parameters
| Type |
Name |
Description |
| System.String |
afterPasteCleanup |
|
Returns
AutoSaveOnIdle(Boolean)
Enables or disables the auto-save option which performs the save action while in the idle state after typed content.
If enabled, the Rich Text Editor will save the content on idle state with saveInterval property's value.
The change event will be triggered if the content has changed from the last saved state.
Declaration
public RichTextEditorBuilder AutoSaveOnIdle(bool autoSaveOnIdle = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
autoSaveOnIdle |
|
Returns
BackgroundColor(RichTextEditorBackgroundColor)
Predefine the color palette that can be rendered for background color (text highlighted color) toolbar command.
Declaration
public RichTextEditorBuilder BackgroundColor(RichTextEditorBackgroundColor backgroundColor)
Parameters
Returns
BackgroundColor(Action<RichTextEditorBackgroundColorBuilder>)
Declaration
public RichTextEditorBuilder BackgroundColor(Action<RichTextEditorBackgroundColorBuilder> backgroundColor)
Parameters
Returns
BeforeDialogClose(String)
Event triggers when the dialog is being closed.
If you cancel this event, the dialog remains opened.
Set the cancel argument to true to prevent closing a dialog.
Declaration
public RichTextEditorBuilder BeforeDialogClose(string beforeDialogClose)
Parameters
| Type |
Name |
Description |
| System.String |
beforeDialogClose |
|
Returns
BeforeDialogOpen(String)
Event triggers when the dialog is being opened.
If you cancel this event, the dialog remains closed.
Set the cancel argument to true to cancel the open of a dialog.
Declaration
public RichTextEditorBuilder BeforeDialogOpen(string beforeDialogOpen)
Parameters
| Type |
Name |
Description |
| System.String |
beforeDialogOpen |
|
Returns
BeforeFileUpload(String)
Event triggers before the media audio/video upload process.
Declaration
public RichTextEditorBuilder BeforeFileUpload(string beforeFileUpload)
Parameters
| Type |
Name |
Description |
| System.String |
beforeFileUpload |
|
Returns
BeforeImageDrop(String)
Triggers before drop the image.
Declaration
public RichTextEditorBuilder BeforeImageDrop(string beforeImageDrop)
Parameters
| Type |
Name |
Description |
| System.String |
beforeImageDrop |
|
Returns
BeforeImageUpload(String)
Event triggers before the image upload process.
Declaration
public RichTextEditorBuilder BeforeImageUpload(string beforeImageUpload)
Parameters
| Type |
Name |
Description |
| System.String |
beforeImageUpload |
|
Returns
BeforePasteCleanup(String)
Triggers before cleanup the copied content.
Declaration
public RichTextEditorBuilder BeforePasteCleanup(string beforePasteCleanup)
Parameters
| Type |
Name |
Description |
| System.String |
beforePasteCleanup |
|
Returns
BeforeQuickToolbarOpen(String)
Event triggers when the quick toolbar is being opened.
Declaration
public RichTextEditorBuilder BeforeQuickToolbarOpen(string beforeQuickToolbarOpen)
Parameters
| Type |
Name |
Description |
| System.String |
beforeQuickToolbarOpen |
|
Returns
BeforeSanitizeHtml(String)
Event triggers before sanitize the value. It's only applicable to editorMode as HTML.
Declaration
public RichTextEditorBuilder BeforeSanitizeHtml(string beforeSanitizeHtml)
Parameters
| Type |
Name |
Description |
| System.String |
beforeSanitizeHtml |
|
Returns
Blur(String)
Triggers when Rich Text Editor is focused out.
Declaration
public RichTextEditorBuilder Blur(string blur)
Parameters
| Type |
Name |
Description |
| System.String |
blur |
|
Returns
BulletFormatList(RichTextEditorBulletFormatList)
Predefine the advanced list types that populate in the bulletFormatList dropdown list from the toolbar.
Declaration
public RichTextEditorBuilder BulletFormatList(RichTextEditorBulletFormatList bulletFormatList)
Parameters
Returns
BulletFormatList(Action<RichTextEditorBulletFormatListBuilder>)
Declaration
public RichTextEditorBuilder BulletFormatList(Action<RichTextEditorBulletFormatListBuilder> bulletFormatList)
Parameters
Returns
Change(String)
Triggers only when Rich Text Editor is blurred and changes are done to the content.
Declaration
public RichTextEditorBuilder Change(string change)
Parameters
| Type |
Name |
Description |
| System.String |
change |
|
Returns
ContentTemplate(Action<Object>)
Declaration
public RichTextEditorBuilder ContentTemplate(Action<object> template)
Parameters
| Type |
Name |
Description |
| System.Action<System.Object> |
template |
|
Returns
ContentTemplate(Func<Object, Object>)
Declaration
public RichTextEditorBuilder ContentTemplate(Func<object, object> template)
Parameters
| Type |
Name |
Description |
| System.Func<System.Object, System.Object> |
template |
|
Returns
Created(String)
Triggers when the Rich Text Editor is rendered.
Declaration
public RichTextEditorBuilder Created(string created)
Parameters
| Type |
Name |
Description |
| System.String |
created |
|
Returns
CssClass(String)
Specifies the CSS class name appended with the root element of the RichTextEditor.
One or more custom CSS classes can be added to a RichTextEditor.
Declaration
public RichTextEditorBuilder CssClass(string cssClass)
Parameters
| Type |
Name |
Description |
| System.String |
cssClass |
|
Returns
Destroyed(String)
Triggers when the Rich Text Editor is destroyed.
Declaration
public RichTextEditorBuilder Destroyed(string destroyed)
Parameters
| Type |
Name |
Description |
| System.String |
destroyed |
|
Returns
DialogClose(String)
Event triggers after the dialog has been closed.
Declaration
public RichTextEditorBuilder DialogClose(string dialogClose)
Parameters
| Type |
Name |
Description |
| System.String |
dialogClose |
|
Returns
DialogOpen(String)
Event triggers when a dialog is opened.
Declaration
public RichTextEditorBuilder DialogOpen(string dialogOpen)
Parameters
| Type |
Name |
Description |
| System.String |
dialogOpen |
|
Returns
EditorMode(EditorMode)
Specifies the editing mode of the RichTextEditor.
Declaration
public RichTextEditorBuilder EditorMode(EditorMode editorMode)
Parameters
Returns
EnableAutoUrl(Boolean)
Enable enableAutoUrl to accept the given URL (relative or absolute) without validating the URL for hyperlinks, otherwise
the given URL will automatically convert to absolute path URL by prefixing https:// for hyperlinks.
Declaration
public RichTextEditorBuilder EnableAutoUrl(bool enableAutoUrl = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
enableAutoUrl |
|
Returns
Enabled(Boolean)
Specifies a value that indicates whether the component is enabled or not.
Declaration
public RichTextEditorBuilder Enabled(bool enabled = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
enabled |
|
Returns
EnableHtmlEncode(Boolean)
specifies the value whether the source code is displayed with encoded format.
Declaration
public RichTextEditorBuilder EnableHtmlEncode(bool enableHtmlEncode = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
enableHtmlEncode |
|
Returns
EnableHtmlSanitizer(Boolean)
Defines whether to allow the cross-scripting site or not.
Declaration
public RichTextEditorBuilder EnableHtmlSanitizer(bool enableHtmlSanitizer = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
enableHtmlSanitizer |
|
Returns
EnablePersistence(Boolean)
Enables or disables the persisting component's state between page reloads.
If enabled, the value of Rich Text Editor is persisted
Declaration
public RichTextEditorBuilder EnablePersistence(bool enablePersistence = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
enablePersistence |
|
Returns
EnableResize(Boolean)
Enables or disables the resizing option in the editor.
If enabled, the Rich Text Editor can be resized by dragging the resize icon in the bottom right corner.
Declaration
public RichTextEditorBuilder EnableResize(bool enableResize = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
enableResize |
|
Returns
EnableRtl(Boolean)
Enable or disable rendering component in right to left direction.
Declaration
public RichTextEditorBuilder EnableRtl(bool enableRtl = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
enableRtl |
|
Returns
EnableTabKey(Boolean)
Allows the tab key action in the Rich Text Editor content.
Declaration
public RichTextEditorBuilder EnableTabKey(bool enableTabKey = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
enableTabKey |
|
Returns
EnableXhtml(Boolean)
Specifies a value that indicates whether the xhtml is enabled or not.
Declaration
public RichTextEditorBuilder EnableXhtml(bool enableXhtml = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
enableXhtml |
|
Returns
EnterKey(EnterKey)
Specifies tag to be inserted when enter key is pressed.
Declaration
public RichTextEditorBuilder EnterKey(EnterKey enterKey)
Parameters
Returns
FileManagerSettings(RichTextEditorFileManagerSettings)
Specifies the image manager options in Rich Text Editor component and control with the following properties.
enable - set boolean value to enable or disable the image manager.
ajaxSettings - Specifies the AJAX settings of the image manager.
contextMenuSettings - Specifies the context menu settings of the image manager.
navigationPaneSettings - Specifies the navigation pane settings of the image manager.
toolbarSettings - Specifies the group of items aligned horizontally in the toolbar.
uploadSettings - Specifies the upload settings for the image manager.
Declaration
public RichTextEditorBuilder FileManagerSettings(RichTextEditorFileManagerSettings fileManagerSettings)
Parameters
Returns
FileManagerSettings(Action<RichTextEditorFileManagerSettingsBuilder>)
Declaration
public RichTextEditorBuilder FileManagerSettings(Action<RichTextEditorFileManagerSettingsBuilder> fileManagerSettings)
Parameters
Returns
FileRemoving(String)
Event triggers when the selected media is cleared from the insert audio/video dialog.
Declaration
public RichTextEditorBuilder FileRemoving(string fileRemoving)
Parameters
| Type |
Name |
Description |
| System.String |
fileRemoving |
|
Returns
FileSelected(String)
Event triggers when the media is selected or dragged into the insert media audio/video dialog.
Declaration
public RichTextEditorBuilder FileSelected(string fileSelected)
Parameters
| Type |
Name |
Description |
| System.String |
fileSelected |
|
Returns
FileUploadFailed(String)
Event triggers when there is an error in the media upload.
Declaration
public RichTextEditorBuilder FileUploadFailed(string fileUploadFailed)
Parameters
| Type |
Name |
Description |
| System.String |
fileUploadFailed |
|
Returns
FileUploading(String)
Event triggers when the selected media begins to upload in the insert media audio/video dialog.
Declaration
public RichTextEditorBuilder FileUploading(string fileUploading)
Parameters
| Type |
Name |
Description |
| System.String |
fileUploading |
|
Returns
FileUploadSuccess(String)
Event triggers when the media is successfully uploaded to the server side.
Declaration
public RichTextEditorBuilder FileUploadSuccess(string fileUploadSuccess)
Parameters
| Type |
Name |
Description |
| System.String |
fileUploadSuccess |
|
Returns
FloatingToolbarOffset(Double)
Preserves the toolbar at the top of the Rich Text Editor on scrolling and
specifies the offset of the floating toolbar from documents top position
Declaration
public RichTextEditorBuilder FloatingToolbarOffset(double floatingToolbarOffset)
Parameters
| Type |
Name |
Description |
| System.Double |
floatingToolbarOffset |
|
Returns
Focus(String)
Triggers when Rich Text Editor is focused in
Declaration
public RichTextEditorBuilder Focus(string focus)
Parameters
| Type |
Name |
Description |
| System.String |
focus |
|
Returns
FontColor(RichTextEditorFontColor)
Predefine the color palette that can be rendered for font color toolbar command .
Declaration
public RichTextEditorBuilder FontColor(RichTextEditorFontColor fontColor)
Parameters
Returns
FontColor(Action<RichTextEditorFontColorBuilder>)
Declaration
public RichTextEditorBuilder FontColor(Action<RichTextEditorFontColorBuilder> fontColor)
Parameters
Returns
FontFamily(RichTextEditorFontFamily)
Predefine the font families that populate in font family dropdown list from the toolbar.
Declaration
public RichTextEditorBuilder FontFamily(RichTextEditorFontFamily fontFamily)
Parameters
Returns
FontFamily(Action<RichTextEditorFontFamilyBuilder>)
Declaration
public RichTextEditorBuilder FontFamily(Action<RichTextEditorFontFamilyBuilder> fontFamily)
Parameters
Returns
FontSize(RichTextEditorFontSize)
Predefine the font sizes that populate in font size dropdown list from the toolbar.
Declaration
public RichTextEditorBuilder FontSize(RichTextEditorFontSize fontSize)
Parameters
Returns
FontSize(Action<RichTextEditorFontSizeBuilder>)
Declaration
public RichTextEditorBuilder FontSize(Action<RichTextEditorFontSizeBuilder> fontSize)
Parameters
Returns
Format(RichTextEditorFormat)
Predefine the collection of paragraph styles along with quote and code style that populate in format dropdown from the toolbar.
Declaration
public RichTextEditorBuilder Format(RichTextEditorFormat format)
Parameters
Returns
Format(Action<RichTextEditorFormatBuilder>)
Declaration
public RichTextEditorBuilder Format(Action<RichTextEditorFormatBuilder> format)
Parameters
Returns
Formatter(RichTextEditorFormatter)
Customize keyCode to change the key value.
Declaration
public RichTextEditorBuilder Formatter(RichTextEditorFormatter formatter)
Parameters
Returns
Formatter(Action<RichTextEditorFormatterBuilder>)
Declaration
public RichTextEditorBuilder Formatter(Action<RichTextEditorFormatterBuilder> formatter)
Parameters
Returns
Height(Double)
Specifies the height of the Rich Text Editor component.
Declaration
public RichTextEditorBuilder Height(double height)
Parameters
| Type |
Name |
Description |
| System.Double |
height |
|
Returns
Height(String)
Specifies the height of the Rich Text Editor component.
Declaration
public RichTextEditorBuilder Height(string height)
Parameters
| Type |
Name |
Description |
| System.String |
height |
|
Returns
HtmlAttributes(Object)
Allows additional HTML attributes such as title, name, etc., and
It will be accepts n number of attributes in a key-value pair format.
Declaration
public RichTextEditorBuilder HtmlAttributes(object htmlAttributes)
Parameters
| Type |
Name |
Description |
| System.Object |
htmlAttributes |
|
Returns
IframeSettings(RichTextEditorIFrameSettings)
Specifies the items to be rendered in an iframe mode, and it has the following properties.
enable - Set Boolean value to enable, the editors content is placed in an iframe and isolated from the rest of the page.
attributes - Custom style to be used inside the iframe to display content. This style is added to the iframe body.
resources - we can add both styles and scripts to the iframe.
- styles[] - An array of CSS style files to inject inside the iframe to display content
- scripts[] - An array of JS script files to inject inside the iframe
Declaration
public RichTextEditorBuilder IframeSettings(RichTextEditorIFrameSettings iframeSettings)
Parameters
Returns
IframeSettings(Action<RichTextEditorIFrameSettingsBuilder>)
Declaration
public RichTextEditorBuilder IframeSettings(Action<RichTextEditorIFrameSettingsBuilder> iframeSettings)
Parameters
Returns
ImageRemoving(String)
Event triggers when the selected image is cleared from the insert image dialog.
Declaration
public RichTextEditorBuilder ImageRemoving(string imageRemoving)
Parameters
| Type |
Name |
Description |
| System.String |
imageRemoving |
|
Returns
ImageSelected(String)
Event triggers when the image is selected or dragged into the insert image dialog.
Declaration
public RichTextEditorBuilder ImageSelected(string imageSelected)
Parameters
| Type |
Name |
Description |
| System.String |
imageSelected |
|
Returns
ImageUploadFailed(String)
Event triggers when there is an error in the image upload.
Declaration
public RichTextEditorBuilder ImageUploadFailed(string imageUploadFailed)
Parameters
| Type |
Name |
Description |
| System.String |
imageUploadFailed |
|
Returns
ImageUploading(String)
Event triggers when the selected image begins to upload in the insert image dialog.
Declaration
public RichTextEditorBuilder ImageUploading(string imageUploading)
Parameters
| Type |
Name |
Description |
| System.String |
imageUploading |
|
Returns
ImageUploadSuccess(String)
Event triggers when the image is successfully uploaded to the server side.
Declaration
public RichTextEditorBuilder ImageUploadSuccess(string imageUploadSuccess)
Parameters
| Type |
Name |
Description |
| System.String |
imageUploadSuccess |
|
Returns
InlineMode(RichTextEditorInlineMode)
Enable or disable the inline edit mode.
enable - set boolean value to enable or disable the inline edit mode.
onSelection - If its set to true, upon selecting the text, the toolbar is opened in inline.
If its set to false, upon clicking to the target element, the toolbar is opened.
Declaration
public RichTextEditorBuilder InlineMode(RichTextEditorInlineMode inlineMode)
Parameters
Returns
InlineMode(Action<RichTextEditorInlineModeBuilder>)
Declaration
public RichTextEditorBuilder InlineMode(Action<RichTextEditorInlineModeBuilder> inlineMode)
Parameters
Returns
InsertAudioSettings(RichTextEditorAudioSettings)
Specifies the audio insert options in Rich Text Editor component and control with the following properties.
allowedTypes - Specifies the extensions of the audio types allowed to insert on bowering and
passing the extensions with comma separators. For example, pass allowedTypes as .jpg and .png.
layoutOption - Sets the default display for an audio when it is inserted in to the RichTextEditor.
Possible options are: 'Inline' and 'Break'.
saveFormat - Specifies the format to store the audio in the Rich Text Editor (Base64 or Blob).
If you want to insert a lot of tiny audios in the editor and don't want a specific physical location for
saving audios, you can opt to save format as Base64.
saveUrl - Specifies the service URL of save action that will receive the uploaded files and save them in the server.
path - Specifies the path of the location to store the audios and refer it to display the audios.
Declaration
public RichTextEditorBuilder InsertAudioSettings(RichTextEditorAudioSettings insertAudioSettings)
Parameters
Returns
InsertAudioSettings(Action<RichTextEditorAudioSettingsBuilder>)
Declaration
public RichTextEditorBuilder InsertAudioSettings(Action<RichTextEditorAudioSettingsBuilder> insertAudioSettings)
Parameters
Returns
InsertImageSettings(RichTextEditorImageSettings)
Specifies the image insert options in Rich Text Editor component and control with the following properties.
allowedTypes - Specifies the extensions of the image types allowed to insert on bowering and
passing the extensions with comma separators. For example, pass allowedTypes as .jpg and .png.
display - Sets the default display for an image when it is inserted in to the RichTextEditor.
Possible options are: 'inline' and 'block'.
width - Sets the default width of the image when it is inserted in the RichTextEditor.
saveFormat - Specifies the format to store the image in the Rich Text Editor (Base64 or Blob).
If you want to insert a lot of tiny images in the editor and don't want a specific physical location for
saving images, you can opt to save format as Base64.
height - Sets the default height of the image when it is inserted in the RichTextEditor.
saveUrl - Specifies the service URL of save action that will receive the uploaded files and save them in the server.
path - Specifies the path of the location to store the images and refer it to display the images.
Declaration
public RichTextEditorBuilder InsertImageSettings(RichTextEditorImageSettings insertImageSettings)
Parameters
Returns
InsertImageSettings(Action<RichTextEditorImageSettingsBuilder>)
Declaration
public RichTextEditorBuilder InsertImageSettings(Action<RichTextEditorImageSettingsBuilder> insertImageSettings)
Parameters
Returns
InsertVideoSettings(RichTextEditorVideoSettings)
Specifies the video insert options in Rich Text Editor component and control with the following properties.
allowedTypes - Specifies the extensions of the video types allowed to insert on bowering and
passing the extensions with comma separators. For example, pass allowedTypes as .jpg and .png.
layoutOption - Sets the default display for an video when it is inserted in to the RichTextEditor.
Possible options are: 'Inline' and 'Break'.
width - Sets the default width of the video when it is inserted in the RichTextEditor.
saveFormat - Specifies the format to store the video in the Rich Text Editor (Base64 or Blob).
If you want to insert a lot of tiny videos in the editor and don't want a specific physical location for
saving videos, you can opt to save format as Base64.
height - Sets the default height of the video when it is inserted in the RichTextEditor.
saveUrl - Specifies the service URL of save action that will receive the uploaded files and save them in the server.
path - Specifies the path of the location to store the videos and refer it to display the videos.
Declaration
public RichTextEditorBuilder InsertVideoSettings(RichTextEditorVideoSettings insertVideoSettings)
Parameters
Returns
InsertVideoSettings(Action<RichTextEditorVideoSettingsBuilder>)
Declaration
public RichTextEditorBuilder InsertVideoSettings(Action<RichTextEditorVideoSettingsBuilder> insertVideoSettings)
Parameters
Returns
KeyConfig(Object)
Customizes the key actions in RichTextEditor.
For example, when using German keyboard, the key actions can be customized using these shortcuts.
Declaration
public RichTextEditorBuilder KeyConfig(object keyConfig)
Parameters
| Type |
Name |
Description |
| System.Object |
keyConfig |
|
Returns
Locale(String)
Overrides the global culture and localization value for this component. Default global culture is 'en-US'.
Declaration
public RichTextEditorBuilder Locale(string locale)
Parameters
| Type |
Name |
Description |
| System.String |
locale |
|
Returns
MaxLength(Double)
Specifies the maximum number of characters allowed in the Rich Text Editor component.
Declaration
public RichTextEditorBuilder MaxLength(double maxLength)
Parameters
| Type |
Name |
Description |
| System.Double |
maxLength |
|
Returns
NumberFormatList(RichTextEditorNumberFormatList)
Predefine the advanced list types that populate in the numberFormatList dropdown list from the toolbar.
Declaration
public RichTextEditorBuilder NumberFormatList(RichTextEditorNumberFormatList numberFormatList)
Parameters
Returns
NumberFormatList(Action<RichTextEditorNumberFormatListBuilder>)
Declaration
public RichTextEditorBuilder NumberFormatList(Action<RichTextEditorNumberFormatListBuilder> numberFormatList)
Parameters
Returns
PasteCleanupSettings(RichTextEditorPasteCleanupSettings)
Specifies the pasting options in Rich Text Editor component and control with the following properties.
prompt - Set boolean value to enable or disable the prompt when pasting.
deniedAttrs - Specifies the attributes to restrict when pasting in RTE.
allowedStyleProps - Specifies the allowed style properties when pasting in RTE.
deniedTags - Specifies the tags to restrict when pasting in RTE.
keepFormat - Set boolean value to keep or remove the from when pasting.
plainText - Set boolean value to paste as plain text or not.
Declaration
public RichTextEditorBuilder PasteCleanupSettings(RichTextEditorPasteCleanupSettings pasteCleanupSettings)
Parameters
Returns
PasteCleanupSettings(Action<RichTextEditorPasteCleanupSettingsBuilder>)
Declaration
public RichTextEditorBuilder PasteCleanupSettings(Action<RichTextEditorPasteCleanupSettingsBuilder> pasteCleanupSettings)
Parameters
Returns
Placeholder(String)
Specifies the placeholder for the RichTextEditor’s content used when the Rich Text Editor body is empty.
Declaration
public RichTextEditorBuilder Placeholder(string placeholder)
Parameters
| Type |
Name |
Description |
| System.String |
placeholder |
|
Returns
QuickToolbarClose(String)
Event triggers after the quick toolbar has been closed.
Declaration
public RichTextEditorBuilder QuickToolbarClose(string quickToolbarClose)
Parameters
| Type |
Name |
Description |
| System.String |
quickToolbarClose |
|
Returns
QuickToolbarOpen(String)
Event triggers when a quick toolbar is opened.
Declaration
public RichTextEditorBuilder QuickToolbarOpen(string quickToolbarOpen)
Parameters
| Type |
Name |
Description |
| System.String |
quickToolbarOpen |
|
Returns
QuickToolbarSettings(RichTextEditorQuickToolbarSettings)
Specifies the items to be rendered in quick toolbar based on the target element.
It has following fields:
enable - set boolean value to show or hide the quick toolbar
actionOnScroll - it has two possible options
- hide: The quickToolbar is closed when the parent element is scrolled.
- none: The quickToolbar cannot be closed even the parent element is scrolled.
link - Specifies the items to be rendered in quick toolbar based on link element such as
Open, Edit, and UnLink.
image - Specifies the items to be rendered in quick toolbar based on image element such as 'Replace',
'Align', 'Caption', 'Remove', 'InsertLink', 'Display', 'AltText', 'Dimension'.
text - Specifies the items to be rendered in quick toolbar based on text element such as 'Cut', 'Copy', 'Paste'.
Declaration
public RichTextEditorBuilder QuickToolbarSettings(RichTextEditorQuickToolbarSettings quickToolbarSettings)
Parameters
Returns
QuickToolbarSettings(Action<RichTextEditorQuickToolbarSettingsBuilder>)
Declaration
public RichTextEditorBuilder QuickToolbarSettings(Action<RichTextEditorQuickToolbarSettingsBuilder> quickToolbarSettings)
Parameters
Returns
Readonly(Boolean)
Declaration
public RichTextEditorBuilder Readonly(bool readOnly = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
readOnly |
|
Returns
Render()
Declaration
public HtmlString Render()
Returns
| Type |
Description |
| System.Web.HtmlString |
|
ResizeStart(String)
Triggers only when start resize the image.
Declaration
public RichTextEditorBuilder ResizeStart(string resizeStart)
Parameters
| Type |
Name |
Description |
| System.String |
resizeStart |
|
Returns
ResizeStop(String)
Triggers only when stop resize the image.
Declaration
public RichTextEditorBuilder ResizeStop(string resizeStop)
Parameters
| Type |
Name |
Description |
| System.String |
resizeStop |
|
Returns
Resizing(String)
Triggers only when resizing the image.
Declaration
public RichTextEditorBuilder Resizing(string resizing)
Parameters
| Type |
Name |
Description |
| System.String |
resizing |
|
Returns
SaveInterval(Double)
Specifies the saveInterval in milliseconds for autosave the value.
The change event will be triggered if the content was changed from the last saved interval.
Declaration
public RichTextEditorBuilder SaveInterval(double saveInterval)
Parameters
| Type |
Name |
Description |
| System.Double |
saveInterval |
|
Returns
ShiftEnterKey(ShiftEnterKey)
Specifies tags to be inserted when shift+enter key is pressed.
Declaration
public RichTextEditorBuilder ShiftEnterKey(ShiftEnterKey shiftEnterKey)
Parameters
Returns
ShowCharCount(Boolean)
Sets Boolean value to enable or disable the display of the character counter.
Declaration
public RichTextEditorBuilder ShowCharCount(bool showCharCount = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
showCharCount |
|
Returns
ShowTooltip(Boolean)
Specify the value whether tooltip will be displayed for the Rich Text Editor toolbar.
Declaration
public RichTextEditorBuilder ShowTooltip(bool showTooltip = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
showTooltip |
|
Returns
TableSettings(RichTextEditorTableSettings)
Specifies the table insert options in Rich Text Editor component and control with the following properties.
styles - Class name should be appended by default in table element.
It helps to design the table in specific CSS styles always when inserting in editor.
width - Sets the default width of the table when it is inserted in the RichTextEditor.
minWidth - Sets the default minWidth of the table when it is inserted in the RichTextEditor.
maxWidth - Sets the default maxWidth of the table when it is inserted in the RichTextEditor.
resize - To enable resize the table.
Declaration
public RichTextEditorBuilder TableSettings(RichTextEditorTableSettings tableSettings)
Parameters
Returns
TableSettings(Action<RichTextEditorTableSettingsBuilder>)
Declaration
public RichTextEditorBuilder TableSettings(Action<RichTextEditorTableSettingsBuilder> tableSettings)
Parameters
Returns
ToolbarClick(String)
Triggers when Rich Text Editor Toolbar items is clicked.
Declaration
public RichTextEditorBuilder ToolbarClick(string toolbarClick)
Parameters
| Type |
Name |
Description |
| System.String |
toolbarClick |
|
Returns
ToolbarSettings(RichTextEditorToolbarSettings)
Specifies the group of items aligned horizontally in the toolbar as well as defined the toolbar rendering type.
By default, toolbar is float at the top of the RichTextEditor.
When you scroll down, the toolbar will scroll along with the page on Rich Text Editor with the specified offset value.
enable: set boolean value to show or hide the toolbar.
enableFloating: Set Boolean value to enable or disable the floating toolbar.
Preserves the toolbar at top of the Rich Text Editor on scrolling.
type: it has two possible options
- Expand: Hide the overflowing toolbar items in the next row. Click the expand arrow to view overflowing toolbar items
- MultiRow: The toolbar overflowing items wrapped in the next row.
items: Specifies the array of items aligned horizontally in the toolbar.
| and - can insert a vertical and horizontal separator lines in the toolbar.
itemConfigs: Modify the default toolbar item configuration like icon class.
Declaration
public RichTextEditorBuilder ToolbarSettings(RichTextEditorToolbarSettings toolbarSettings)
Parameters
Returns
ToolbarSettings(Action<RichTextEditorToolbarSettingsBuilder>)
Declaration
public RichTextEditorBuilder ToolbarSettings(Action<RichTextEditorToolbarSettingsBuilder> toolbarSettings)
Parameters
Returns
ToolbarStatusUpdate(String)
This event is deprecated and no longer works. Use updatedToolbarStatus event to get the undo and redo status.
Declaration
public RichTextEditorBuilder ToolbarStatusUpdate(string toolbarStatusUpdate)
Parameters
| Type |
Name |
Description |
| System.String |
toolbarStatusUpdate |
|
Returns
UndoRedoSteps(Double)
Specifies the count of undo history which is stored in undoRedoManager.
Declaration
public RichTextEditorBuilder UndoRedoSteps(double undoRedoSteps)
Parameters
| Type |
Name |
Description |
| System.Double |
undoRedoSteps |
|
Returns
UndoRedoTimer(Double)
Specifies the interval value in milliseconds that store actions in undoRedoManager. The minimum value is 300 milliseconds.
Declaration
public RichTextEditorBuilder UndoRedoTimer(double undoRedoTimer)
Parameters
| Type |
Name |
Description |
| System.Double |
undoRedoTimer |
|
Returns
UpdatedToolbarStatus(String)
Triggers when the toolbar items status is updated.
Declaration
public RichTextEditorBuilder UpdatedToolbarStatus(string updatedToolbarStatus)
Parameters
| Type |
Name |
Description |
| System.String |
updatedToolbarStatus |
|
Returns
Value(String)
Specifies the value displayed in the RichTextEditor's content area and it should be string.
The content of Rich Text Editor can be loaded with dynamic data such as database, AJAX content, and more.
Declaration
public RichTextEditorBuilder Value(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
ValueTemplate(String)
Accepts the template design and assigns it as RichTextEditor’s content.
The built-in template engine which provides options to compile template string into a executable function.
For EX: We have expression evolution as like ES6 expression string literals
Declaration
public RichTextEditorBuilder ValueTemplate(string valueTemplate)
Parameters
| Type |
Name |
Description |
| System.String |
valueTemplate |
|
Returns
Width(Double)
Specifies the width of the RichTextEditor.
Declaration
public RichTextEditorBuilder Width(double width)
Parameters
| Type |
Name |
Description |
| System.Double |
width |
|
Returns
Width(String)
Specifies the width of the RichTextEditor.
Declaration
public RichTextEditorBuilder Width(string width)
Parameters
| Type |
Name |
Description |
| System.String |
width |
|
Returns
