Class RTEproperties

Represents the RTE UI element.

Inheritance

System.Object

EJTagHelper

RTEproperties

Inherited Members

EJTagHelper.GetControlDetails(String)

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()

Namespace: Syncfusion.JavaScript.Models

Assembly: Syncfusion.EJ.dll

Syntax

public class RTEproperties : EJTagHelper

Constructors

RTEproperties()

Initializes a new instance of the class.

Declaration

public RTEproperties()

Properties

AllowEditing

Enables/disables the editing of the content.

Declaration

[JsonProperty("allowEditing")]
public bool AllowEditing { get; set; }

Property Value

Type	Description
System.Boolean	true if [allow editing]; otherwise, false.

AllowKeyboardNavigation

RTE control can be accessed through the keyboard shortcut keys.

Declaration

[JsonProperty("allowKeyboardNavigation")]
public bool AllowKeyboardNavigation { get; set; }

Property Value

Type	Description
System.Boolean	true if [allow keyboard navigation]; otherwise, false.

AutoFocus

When the property is set to true, it focuses the RTE at the time of rendering.

Declaration

[JsonProperty("autoFocus")]
public bool AutoFocus { get; set; }

Property Value

Type	Description
System.Boolean	true if [automatic focus]; otherwise, false.

AutoHeight

Based on the content size, its height is adjusted instead of adding the scrollbar.

Declaration

[JsonProperty("autoHeight")]
public bool AutoHeight { get; set; }

Property Value

Type	Description
System.Boolean	true if [automatic height]; otherwise, false.

Change

Occurs when changed successfully.

Declaration

[JsonProperty("change")]
public string Change { get; set; }

Property Value

Type	Description
System.String	The change.

ColorCode

Sets the colorCode to display the color of the fontColor and backgroundColor in the font tools of the RTE.

Declaration

[JsonProperty("colorCode")]
public List<string> ColorCode { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<System.String>	The color code.

ColorPaletteColumns

The number of columns given are rendered in the color palate popup.

Declaration

[JsonProperty("colorPaletteColumns")]
public int ColorPaletteColumns { get; set; }

Property Value

Type	Description
System.Int32	The color palette columns.

ColorPaletteRows

The number of rows given are rendered in the color palate popup.

Declaration

[JsonProperty("colorPaletteRows")]
public int ColorPaletteRows { get; set; }

Property Value

Type	Description
System.Int32	The color palette rows.

ContentTemplate

Declaration

[JsonIgnore]
public MvcTemplate<object> ContentTemplate { get; set; }

Property Value

Type	Description
MvcTemplate<System.Object>

ContextMenuClick

Fires when mouse click on menu items.

Declaration

[JsonProperty("contextMenuClick")]
public string ContextMenuClick { get; set; }

Property Value

Type	Description
System.String	The contextMenuClick.

Create

Occurs when RTE control.

Declaration

[JsonProperty("create")]
public string Create { get; set; }

Property Value

Type	Description
System.String	The create.

CssClass

Sets the root class for the RTE theme. This cssClass API helps the usage of custom skinning option for the RTE control by including this root class in CSS.

Declaration

[JsonProperty("cssClass")]
public string CssClass { get; set; }

Property Value

Type	Description
System.String	The CSS class.

Destroy

Occurs before the RTE is destroyed.

Declaration

[JsonProperty("destroy")]
public string Destroy { get; set; }

Property Value

Type	Description
System.String	The destroy.

Enabled

Enables/disables the RTE control’s accessibility or interaction.

Declaration

[JsonProperty("enabled")]
public bool Enabled { get; set; }

Property Value

Type	Description
System.Boolean	true if enabled; otherwise, false.

EnableHtmlEncode

When the property is set to true, it returns the encrypted text.

Declaration

[JsonProperty("enableHtmlEncode")]
public bool EnableHtmlEncode { get; set; }

Property Value

Type	Description
System.Boolean	true if [enable HTML encode]; otherwise, false.

EnablePersistence

Maintain the values of the RTE after page reload.

Declaration

[JsonProperty("enablePersistence")]
public bool EnablePersistence { get; set; }

Property Value

Type	Description
System.Boolean	true if [enable persistence]; otherwise, false.

EnableResize

Shows the resize icon and enables the resize option in the RTE.

Declaration

[JsonProperty("enableResize")]
public bool EnableResize { get; set; }

Property Value

Type	Description
System.Boolean	true if [enable resize]; otherwise, false.

EnableRTL

Shows the RTE in the RTL direction.

Declaration

[JsonProperty("enableRTL")]
public bool EnableRTL { get; set; }

Property Value

Type	Description
System.Boolean	true if [enable RTL]; otherwise, false.

EnableTabKeyNavigation

Gets or sets a value indicating whether [enable tab key navigation].

Declaration

[JsonProperty("enableTabKeyNavigation")]
public bool EnableTabKeyNavigation { get; set; }

Property Value

Type	Description
System.Boolean	true if [enable tab key navigation]; otherwise, false.

EnableXHTML

Formats the contents based on the XHTML rules.

Declaration

[JsonProperty("enableXHTML")]
public bool EnableXHTML { get; set; }

Property Value

Type	Description
System.Boolean	true if [enable XHTML]; otherwise, false.

Execute

Occurs when the commands are executed successfully.

Declaration

[JsonProperty("execute")]
public string Execute { get; set; }

Property Value

Type	Description
System.String	The execute.

ExportToPdfSettings

Declaration

[JsonProperty("exportToPdfSettings")]
public ExportToPdfSettings ExportToPdfSettings { get; set; }

Property Value

Type	Description
ExportToPdfSettings

ExportToWordSettings

Declaration

[JsonProperty("exportToWordSettings")]
public ExportToWordSettings ExportToWordSettings { get; set; }

Property Value

Type	Description
ExportToWordSettings

ExternalCSS

Load the external CSS file inside Iframe.

Declaration

[JsonProperty("externalCSS")]
public string ExternalCSS { get; set; }

Property Value

Type	Description
System.String	The external CSS.

FileBrowser

This API allows to enable the file browser support in the RTE control to browse, create, delete and upload the files in the specified current directory.

Declaration

[JsonProperty("fileBrowser")]
public FileBrowser FileBrowser { get; set; }

Property Value

Type	Description
FileBrowser	The file browser.

FocusOnLoad

When the property is set to true, it focuses the RTE at the time of rendering.

Declaration

[Obsolete("This property has been deprecated with AutoFocus property.")]
public bool FocusOnLoad { get; set; }

Property Value

Type	Description
System.Boolean	true if [automatic focus]; otherwise, false.

FontName

Sets the fontName in the RTE.

Declaration

[JsonProperty("fontName")]
public List<FontName> FontName { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<FontName>	The name of the font.

FontSize

Sets the fontSize in the RTE.

Declaration

[JsonProperty("fontSize")]
public List<FontSize> FontSize { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<FontSize>	The size of the font.

Format

Sets the format in the RTE.

Declaration

[JsonProperty("format")]
public List<Format> Format { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<Format>	The format.

Height

Defines the height of the RTE textbox.

Declaration

[JsonProperty("height")]
public string Height { get; set; }

Property Value

Type	Description
System.String	The height.

HtmlAttributes

Gets or sets the HTML attributes.

Declaration

[JsonProperty("htmlAttributes")]
public IDictionary<string, object> HtmlAttributes { get; set; }

Property Value

Type	Description
System.Collections.Generic.IDictionary<System.String, System.Object>	The HTML attributes.

IFrameAttributes

Sets the given attributes to the iframe body element.

Declaration

[JsonProperty("iframeAttributes")]
public IDictionary<string, object> IFrameAttributes { get; set; }

Property Value

Type	Description
System.Collections.Generic.IDictionary<System.String, System.Object>	The i frame attributes.

ImageBrowser

This API allows the image browser to support in the RTE control to browse, create, delete, and upload the image files to the specified current directory.

Declaration

[JsonProperty("imageBrowser")]
public ImageBrowser ImageBrowser { get; set; }

Property Value

Type	Description
ImageBrowser	The image browser.

ImportSettings

Declaration

[JsonProperty("importSettings")]
public ImportSettings ImportSettings { get; set; }

Property Value

Type	Description
ImportSettings

IsFor

Declaration

[JsonIgnore]
public bool IsFor { get; set; }

Property Value

Type	Description
System.Boolean

IsResponsive

Enables/disables responsive support for the RTE control toolbar items during the window resizing time.

Declaration

[JsonProperty("isResponsive")]
public bool IsResponsive { get; set; }

Property Value

Type	Description
System.Boolean	true if this instance is responsive; otherwise, false.

Keydown

Occurs when the keydown action is successful.

Declaration

[JsonProperty("keydown")]
public string Keydown { get; set; }

Property Value

Type	Description
System.String	The keydown.

Keyup

Occurs when the keyup action is successful.

Declaration

[JsonProperty("keyup")]
public string Keyup { get; set; }

Property Value

Type	Description
System.String	The keyup.

Locale

Sets the culture in the RTE when you set the localization values are needs to be assigned to the corresponding text as follows.

Declaration

[JsonProperty("locale")]
public string Locale { get; set; }

Property Value

Type	Description
System.String	The locale.

MaxHeight

Sets the maximum height for the RTE outer wrapper element.

Declaration

[JsonProperty("maxHeight")]
public string MaxHeight { get; set; }

Property Value

Type	Description
System.String	The maximum height.

MaxLength

Sets the maximum length for the RTE outer wrapper element.

Declaration

[JsonProperty("maxLength")]
public int MaxLength { get; set; }

Property Value

Type	Description
System.Int32	The maximum length.

MaxWidth

Sets the maximum width for the RTE outer wrapper element.

Declaration

[JsonProperty("maxWidth")]
public string MaxWidth { get; set; }

Property Value

Type	Description
System.String	The maximum width.

MinHeight

Sets the minimum height for the RTE outer wrapper element.

Declaration

[JsonProperty("minHeight")]
public string MinHeight { get; set; }

Property Value

Type	Description
System.String	The minimum height.

MinWidth

Sets the minimum width for the RTE outer wrapper element.

Declaration

[JsonProperty("minWidth")]
public string MinWidth { get; set; }

Property Value

Type	Description
System.String	The minimum width.

Name

Sets the name in the RTE. When the name value is not initialized, the ID value is assigned to the name.

Declaration

[JsonProperty("name")]
public string Name { get; set; }

Property Value

Type	Description
System.String	The name.

PasteCleanupSettings

Enables/disables the pasted content cleanup action.

Declaration

[JsonProperty("pasteCleanupSettings")]
public PasteCleanupSettings PasteCleanupSettings { get; set; }

Property Value

Type	Description
PasteCleanupSettings	true if [content cleanup action]; otherwise, false.

PreRender

Occurs before the RTE Edit area is rendered and after the toolbar is rendered.

Declaration

[JsonProperty("preRender")]
public string PreRender { get; set; }

Property Value

Type	Description
System.String	The pre render.

Select

Occurs when select the RTE item.

Declaration

[JsonProperty("select")]
public string Select { get; set; }

Property Value

Type	Description
System.String	The select.

ShowCharCount

Counts the total characters and displays it in the RTE footer.

Declaration

[JsonProperty("showCharCount")]
public bool ShowCharCount { get; set; }

Property Value

Type	Description
System.Boolean	true if [show character count]; otherwise, false.

ShowClearAll

Shows ClearAll icon in the RTE footer.

Declaration

[JsonProperty("showClearAll")]
public bool ShowClearAll { get; set; }

Property Value

Type	Description
System.Boolean	true if [show clear all]; otherwise, false.

ShowClearFormat

Shows the clear format in the RTE footer.

Declaration

[JsonProperty("showClearFormat")]
public bool ShowClearFormat { get; set; }

Property Value

Type	Description
System.Boolean	true if [show clear format]; otherwise, false.

ShowContextMenu

Gets or sets a value indicating whether [show context menu].

Declaration

[JsonProperty("showContextMenu")]
public bool ShowContextMenu { get; set; }

Property Value

Type	Description
System.Boolean	true if [show context menu]; otherwise, false.

ShowCustomTable

Shows the Custom Table in the RTE.

Declaration

[JsonProperty("showCustomTable")]
public bool ShowCustomTable { get; set; }

Property Value

Type	Description
System.Boolean	true if [show custom table]; otherwise, false.

ShowDimensions

This API is used to set the default dimensions for the image and video. When this property is set to true, the image and video dialog displays the dimension option.

Declaration

[JsonProperty("showDimensions")]
public bool ShowDimensions { get; set; }

Property Value

Type	Description
System.Boolean	true if [show dimensions]; otherwise, false.

ShowFontOption

Shows the FontOption in the RTE.

Declaration

[JsonProperty("showFontOption")]
public bool ShowFontOption { get; set; }

Property Value

Type	Description
System.Boolean	true if [show font option]; otherwise, false.

ShowFooter

Shows footer in the RTE. When the footer is enabled, it displays the html tag, word Count, character count, clear format, resize icon and clear all the content icons, by default.

Declaration

[JsonProperty("showFooter")]
public bool ShowFooter { get; set; }

Property Value

Type	Description
System.Boolean	true if [show footer]; otherwise, false.

ShowHtmlSource

Shows the HtmlSource in the RTE footer.

Declaration

[JsonProperty("showHtmlSource")]
public bool ShowHtmlSource { get; set; }

Property Value

Type	Description
System.Boolean	true if [show HTML source]; otherwise, false.

ShowHtmlTagInfo

When the cursor is placed or when the text is selected in the RTE, it displays the tag info in the footer.

Declaration

[JsonProperty("showHtmlTagInfo")]
public bool ShowHtmlTagInfo { get; set; }

Property Value

Type	Description
System.Boolean	true if [show HTML tag information]; otherwise, false.

ShowRoundedCorner

Gets or sets a value indicating whether [show rounded corner].

Declaration

[JsonProperty("showRoundedCorner")]
public bool ShowRoundedCorner { get; set; }

Property Value

Type	Description
System.Boolean	true if [show rounded corner]; otherwise, false.

ShowToolbar

Shows the toolbar in the RTE.

Declaration

[JsonProperty("showToolbar")]
public bool ShowToolbar { get; set; }

Property Value

Type	Description
System.Boolean	true if [show toolbar]; otherwise, false.

ShowWordCount

Counts the total words and displays it in the RTE footer.

Declaration

[JsonProperty("showWordCount")]
public bool ShowWordCount { get; set; }

Property Value

Type	Description
System.Boolean	true if [show word count]; otherwise, false.

TableColumns

The given number of columns render the insert table pop.

Declaration

[JsonProperty("tableColumns")]
public int TableColumns { get; set; }

Property Value

Type	Description
System.Int32	The table columns.

TableRows

The given number of rows render the insert table pop.

Declaration

[JsonProperty("tableRows")]
public int TableRows { get; set; }

Property Value

Type	Description
System.Int32	The table rows.

Tag

Gets or sets the tag.

Declaration

[JsonIgnore]
public string Tag { get; set; }

Property Value

Type	Description
System.String	The tag.

ToolbarOverflowMode

Specifies the RTE Toolbar type.

Declaration

[JsonConverter(typeof(StringEnumConverter))]
[JsonProperty("toolbarOverflowMode")]
public ToolbarOverflowMode ToolbarOverflowMode { get; set; }

Property Value

Type	Description
ToolbarOverflowMode	The toolbarOverflowMode

Tools

Sets the tools in the RTE and gets the inner display order of the corresponding group element. Tools are dependent on the toolsList property.

Declaration

[JsonProperty("tools")]
public RTEtools Tools { get; set; }

Property Value

Type	Description
RTEtools	The tools.

ToolsList

Specifies the list of groups and order of those groups displayed in the RTE toolbar. The toolsList property is used to get the root group order and tools property is used to get the inner order of the corresponding groups displayed. When the value is not specified, it gets its default display order and tools.

Declaration

[JsonProperty("toolsList")]
public List<string> ToolsList { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<System.String>	The tools list.

TooltipSettings

Sets the tooltip settings property

Declaration

[JsonProperty("tooltipSettings")]
public TooltipProperties TooltipSettings { get; set; }

Property Value

Type	Description
TooltipProperties

UndoStackLimit

Gets the undo stack limit.

Declaration

[JsonProperty("undoStackLimit")]
public int UndoStackLimit { get; set; }

Property Value

Type	Description
System.Int32	The undo stack limit.

ValidationMessage

Sets the jquery validation error message to the Rich Text Editor.

Declaration

[JsonProperty("validationMessage")]
public Dictionary<string, object> ValidationMessage { get; set; }

Property Value

Type	Description
System.Collections.Generic.Dictionary<System.String, System.Object>	The validation message.

ValidationRules

Sets the jquery validation rules to the Rich Text Editor.

Declaration

[JsonProperty("validationRules")]
public Dictionary<string, object> ValidationRules { get; set; }

Property Value

Type	Description
System.Collections.Generic.Dictionary<System.String, System.Object>	The validation rules.

Value

The given string value is displayed in the editable area.

Declaration

[JsonProperty("value")]
public string Value { get; set; }

Property Value

Type	Description
System.String	The value.

Width

Defines the width of the RTE textbox.

Declaration

[JsonProperty("width")]
public string Width { get; set; }

Property Value

Type	Description
System.String	The width.

ZoomStep

Gets or sets the zoom step.

Declaration

[JsonProperty("zoomStep")]
public string ZoomStep { get; set; }

Property Value

Type	Description
System.String	The zoom step.

Methods

GetControlDetails()

Gets the control details

Declaration

protected override object GetControlDetails()

Returns

Type	Description
System.Object

Overrides

EJTagHelper.GetControlDetails()

ShouldSerializeColorCode()

ShouldSerialize method for ColorCode.

Declaration

public bool ShouldSerializeColorCode()

Returns

Type	Description
System.Boolean

ShouldSerializeFontName()

ShouldSerialize method for FontName.

Declaration

public bool ShouldSerializeFontName()

Returns

Type	Description
System.Boolean

ShouldSerializeFontSize()

ShouldSerialize method for FontSize.

Declaration

public bool ShouldSerializeFontSize()

Returns

Type	Description
System.Boolean

ShouldSerializeFormat()

ShouldSerialize method for Format.

Declaration

public bool ShouldSerializeFormat()

Returns

Type	Description
System.Boolean

ShouldSerializeTools()

ShouldSerialize method for Tools.

Declaration

public bool ShouldSerializeTools()

Returns

Type	Description
System.Boolean

ShouldSerializeToolsList()

ShouldSerialize method for ToolsList.

Declaration

public bool ShouldSerializeToolsList()

Returns

Type	Description
System.Boolean

ShouldSerializeTooltipSettings()

ShouldSerialize Method for TooltipSettings

Declaration

public bool ShouldSerializeTooltipSettings()

Returns

Type	Description
System.Boolean