Class RTE

Represents the RTE UI element.

Inheritance

System.Object

CommonControl

RTE

Implements

System.Web.UI.INamingContainer

System.Web.UI.IPostBackEventHandler

System.Web.UI.IPostBackDataHandler

System.Web.UI.IUrlResolutionService

Inherited Members

CommonControl.RaisePostBackEvent(String)

CommonControl.OnInit(EventArgs)

CommonControl.OnLoad(EventArgs)

Namespace: Syncfusion.JavaScript.Web

Assembly: Syncfusion.EJ.Web.dll

Syntax

public class RTE : CommonControl, INamingContainer, IPostBackEventHandler, IPostBackDataHandler, IUrlResolutionService

Constructors

RTE()

Declaration

public RTE()

Properties

AllowEditing

Gets or sets a value indicating whether [allow editing].

Declaration

public bool AllowEditing { get; set; }

Property Value

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

AllowKeyboardNavigation

Gets or sets a value indicating whether [allow keyboard navigation].

Declaration

public bool AllowKeyboardNavigation { get; set; }

Property Value

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

AutoFocus

Gets or sets a value indicating whether [automatic focus].

Declaration

public bool AutoFocus { get; set; }

Property Value

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

AutoHeight

Gets or sets a value indicating whether [automatic height].

Declaration

public bool AutoHeight { get; set; }

Property Value

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

ClientSideOnChange

Occurs when changed successfully.

Declaration

public string ClientSideOnChange { get; set; }

Property Value

Type	Description
System.String	The client side on change.

ClientSideOnContextMenuClick

Occurs when the mouse click on menu items is successful.

Declaration

public string ClientSideOnContextMenuClick { get; set; }

Property Value

Type	Description
System.String	The client side on ContextMenuClick.

ClientSideOnCreate

Occurs when RTE control create.

Declaration

public string ClientSideOnCreate { get; set; }

Property Value

Type	Description
System.String	The client side on create.

ClientSideOnDestroy

Occurs before the RTE is destroyed.

Declaration

public string ClientSideOnDestroy { get; set; }

Property Value

Type	Description
System.String	The client side on destroy.

ClientSideOnExecute

Occurs when the commands are executed successfully.

Declaration

public string ClientSideOnExecute { get; set; }

Property Value

Type	Description
System.String	The client side on execute.

ClientSideOnKeydown

Occurs when the keydown action is successful.

Declaration

public string ClientSideOnKeydown { get; set; }

Property Value

Type	Description
System.String	The client side on keydown.

ClientSideOnKeyup

Occurs when the keyup action is successful.

Declaration

public string ClientSideOnKeyup { get; set; }

Property Value

Type	Description
System.String	The client side on keyup.

ClientSideOnPreRender

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

Declaration

public string ClientSideOnPreRender { get; set; }

Property Value

Type	Description
System.String	The client side on pre render.

ClientSideOnSelect

Occurs when select the RTE item.

Declaration

public string ClientSideOnSelect { get; set; }

Property Value

Type	Description
System.String	The client side on select.

ColorCode

Gets or sets the color code.

Declaration

public List<string> ColorCode { get; set; }

Property Value

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

ColorPaletteColumns

Gets or sets the color palette columns.

Declaration

public int ColorPaletteColumns { get; set; }

Property Value

Type	Description
System.Int32	The color palette columns.

ColorPaletteRows

Gets or sets the color palette rows.

Declaration

public int ColorPaletteRows { get; set; }

Property Value

Type	Description
System.Int32	The color palette rows.

CssClass

Gets or sets the CSS class.

Declaration

public string CssClass { get; set; }

Property Value

Type	Description
System.String	The CSS class.

Enabled

Gets or sets a value indicating whether this RTE is enabled.

Declaration

public bool Enabled { get; set; }

Property Value

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

EnableHtmlEncode

Gets or sets a value indicating whether [enable HTML encode].

Declaration

public bool EnableHtmlEncode { get; set; }

Property Value

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

EnablePersistence

Gets or sets a value indicating whether [enable persistence].

Declaration

public bool EnablePersistence { get; set; }

Property Value

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

EnableResize

Gets or sets a value indicating whether [enable resize].

Declaration

public bool EnableResize { get; set; }

Property Value

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

EnableRTL

Gets or sets a value indicating whether [enable RTL].

Declaration

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

public bool EnableTabKeyNavigation { get; set; }

Property Value

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

EnableXHTML

Gets or sets a value indicating whether [enable XHTML].

Declaration

public bool EnableXHTML { get; set; }

Property Value

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

ExportToPdfSettings

Gets or sets the export to pdf url and filename.

Declaration

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

Property Value

Type	Description
ExportToPdfSettings	The pdf export settings.

ExportToWordSettings

Gets or sets the export to word url and filename.

Declaration

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

Property Value

Type	Description
ExportToWordSettings	The word export settings.

ExternalCSS

Gets or sets the external CSS.

Declaration

public string ExternalCSS { get; set; }

Property Value

Type	Description
System.String	The external CSS.

FileBrowser

Gets or sets the file browser.

Declaration

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

Property Value

Type	Description
FileBrowser	The file browser.

FocusOnLoad

Gets or sets a value indicating whether [automatic focus]. Note: this property has been deprecated with AutoFocus property.

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

Gets or sets the name of the font.

Declaration

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

Property Value

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

FontSize

Gets or sets the size of the font.

Declaration

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

Property Value

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

Format

Gets or sets the format.

Declaration

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

Property Value

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

Height

Gets or sets the height.

Declaration

public string Height { get; set; }

Property Value

Type	Description
System.String	The height.

HtmlAttributes

Gets or sets the HTML attributes.

Declaration

public IDictionary<string, object> HtmlAttributes { get; set; }

Property Value

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

IFrameAttributes

Gets or sets the i frame attributes.

Declaration

public IDictionary<string, object> IFrameAttributes { get; set; }

Property Value

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

ImageBrowser

Gets or sets the image browser.

Declaration

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

Property Value

Type	Description
ImageBrowser	The image browser.

ImportSettings

Gets or sets the import url and filename.

Declaration

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

Property Value

Type	Description
ImportSettings	The import Settings .

IsResponsive

Gets or sets a value indicating whether this instance is responsive.

Declaration

public bool IsResponsive { get; set; }

Property Value

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

Locale

Gets or sets the locale.

Declaration

public string Locale { get; set; }

Property Value

Type	Description
System.String	The locale.

MaxHeight

Gets or sets the maximum height.

Declaration

public string MaxHeight { get; set; }

Property Value

Type	Description
System.String	The maximum height.

MaxLength

Gets or sets the maximum length.

Declaration

public int MaxLength { get; set; }

Property Value

Type	Description
System.Int32	The maximum length.

MaxWidth

Gets or sets the maximum width.

Declaration

public string MaxWidth { get; set; }

Property Value

Type	Description
System.String	The maximum width.

MinHeight

Gets or sets the minimum height.

Declaration

public string MinHeight { get; set; }

Property Value

Type	Description
System.String	The minimum height.

MinWidth

Gets or sets the minimum width.

Declaration

public string MinWidth { get; set; }

Property Value

Type	Description
System.String	The minimum width.

Model

Gets or sets the RTE properties to its Model

Declaration

public RTEproperties Model { get; set; }

Property Value

Type	Description
RTEproperties

Name

Gets or sets the name.

Declaration

public string Name { get; set; }

Property Value

Type	Description
System.String	The name.

PasteCleanupSettings

Gets or sets the Filter Options.

Declaration

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

Property Value

Type	Description
PasteCleanupSettings	The CleanupFilterOption .

RemoveToolbarItems

Gets or sets the remove toolbar items.

Declaration

public List<string> RemoveToolbarItems { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<System.String>	The remove toolbar items.

RTEContent

Gets or sets the content of the rte.

Declaration

public HtmlGenericControl RTEContent { get; set; }

Property Value

Type	Description
System.Web.UI.HtmlControls.HtmlGenericControl	The content of the rte.

ShowCharCount

Gets or sets a value indicating whether [show character count].

Declaration

public bool ShowCharCount { get; set; }

Property Value

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

ShowClearAll

Gets or sets a value indicating whether [show clear all].

Declaration

public bool ShowClearAll { get; set; }

Property Value

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

ShowClearFormat

Gets or sets a value indicating whether [show clear format].

Declaration

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

public bool ShowContextMenu { get; set; }

Property Value

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

ShowCustomTable

Gets or sets a value indicating whether [show custom table].

Declaration

public bool ShowCustomTable { get; set; }

Property Value

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

ShowDimensions

Gets or sets a value indicating whether [show dimensions].

Declaration

public bool ShowDimensions { get; set; }

Property Value

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

ShowFontOption

Gets or sets a value indicating whether [show font option].

Declaration

public bool ShowFontOption { get; set; }

Property Value

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

ShowFooter

Gets or sets a value indicating whether [show footer].

Declaration

public bool ShowFooter { get; set; }

Property Value

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

ShowHtmlSource

Gets or sets a value indicating whether [show HTML source].

Declaration

public bool ShowHtmlSource { get; set; }

Property Value

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

ShowHtmlTagInfo

Gets or sets a value indicating whether [show HTML tag information].

Declaration

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

public bool ShowRoundedCorner { get; set; }

Property Value

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

ShowToolBar

Gets or sets a value indicating whether [show tool bar].

Declaration

public bool ShowToolBar { get; set; }

Property Value

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

ShowWordCount

Gets or sets a value indicating whether [show word count].

Declaration

public bool ShowWordCount { get; set; }

Property Value

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

TableColumns

Gets or sets the table columns.

Declaration

public int TableColumns { get; set; }

Property Value

Type	Description
System.Int32	The table columns.

TableRows

Gets or sets the table rows.

Declaration

public int TableRows { get; set; }

Property Value

Type	Description
System.Int32	The table rows.

ToolbarOverflowMode

Specifies the Toolbar type of RTE.

Declaration

public ToolbarOverflowMode ToolbarOverflowMode { get; set; }

Property Value

Type	Description
ToolbarOverflowMode	The toolbarOverflowMode.

Tools

Gets or sets the tools.

Declaration

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

Property Value

Type	Description
RTEtools	The tools.

ToolsList

Gets or sets the tools list.

Declaration

public List<string> ToolsList { get; set; }

Property Value

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

TooltipSettings

Gets or sets the tooltip settings for RTE.

Declaration

public TooltipProperties TooltipSettings { get; set; }

Property Value

Type	Description
TooltipProperties	The Tooltip settings.

UndoStackLimit

Gets or sets the undo stack limit.

Declaration

public int UndoStackLimit { get; set; }

Property Value

Type	Description
System.Int32	The undo stack limit.

ValidationMessage

Gets or sets the validation message.

Declaration

public List<KeyValue> ValidationMessage { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<KeyValue>	The validation message.

ValidationMessages

Gets or sets the validation messages.

Declaration

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

Property Value

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

ValidationRule

Gets or sets the validation rule.

Declaration

public List<KeyValue> ValidationRule { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<KeyValue>	The validation rule.

ValidationRules

Gets or sets the validation rules.

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

Gets or sets the value.

Declaration

public string Value { get; set; }

Property Value

Type	Description
System.String	The value.

Width

Gets or sets the width.

Declaration

public string Width { get; set; }

Property Value

Type	Description
System.String	The width.

ZoomStep

Gets or sets the zoom step.

Declaration

public string ZoomStep { get; set; }

Property Value

Type	Description
System.String	The zoom step.

Methods

DependentScripts()

Represents the dependent scripts for RTE control.

Declaration

public List<string> DependentScripts()

Returns

Type	Description
System.Collections.Generic.List<System.String>	This method returns the list of dependent script files which is of type string

GetDependentFiles()

Get the dependent files for RTE control

Declaration

public override List<string> GetDependentFiles()

Returns

Type	Description
System.Collections.Generic.List<System.String>

Overrides

CommonControl.GetDependentFiles()

LoadViewState(Object)

Restores view-state information from a previous page request.

Declaration

protected override void LoadViewState(object state)

Parameters

Type	Name	Description
System.Object	state

Overrides

CommonControl.LoadViewState(Object)

OnPreRender(EventArgs)

Modifying server controls before sending them to the client.

Declaration

protected override void OnPreRender(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e

PostBackEventHandler(String, Dictionary<String, Object>)

Gets a value that indicates whether the page is being loaded in response to a postback.

Declaration

public override void PostBackEventHandler(string EventName, Dictionary<string, object> args)

Parameters

Type	Name	Description
System.String	EventName
System.Collections.Generic.Dictionary<System.String, System.Object>	args

Overrides

CommonControl.PostBackEventHandler(String, Dictionary<String, Object>)

Render()

Render this instance

Declaration

public string Render()

Returns

Type	Description
System.String

Render(HtmlTextWriter)

Declaration

protected override void Render(HtmlTextWriter writer)

Parameters

Type	Name	Description
System.Web.UI.HtmlTextWriter	writer

Overrides

CommonControl.Render(HtmlTextWriter)

UpdateServerModel(Dictionary<String, Object>)

Maintaining viewstate model values on post back

Declaration

public override void UpdateServerModel(Dictionary<string, object> ClientModel)

Parameters

Type	Name	Description
System.Collections.Generic.Dictionary<System.String, System.Object>	ClientModel

Overrides

CommonControl.UpdateServerModel(Dictionary<String, Object>)

Events

ToolbarItemClick

Occurs when [toolbar item click].

Declaration

public event RTE.RTEEventHandler ToolbarItemClick

Event Type

Type	Description
RTE.RTEEventHandler

Implements

System.Web.UI.INamingContainer

System.Web.UI.IPostBackEventHandler

System.Web.UI.IPostBackDataHandler

System.Web.UI.IUrlResolutionService

See Also

CommonControl