Class RTEpropertiesBuilder
Inheritance
Inherited Members
Namespace: Syncfusion.JavaScript
Assembly: Syncfusion.EJ.dll
Syntax
public class RTEpropertiesBuilder : IPropertiesBuilder, IHtmlStringConstructors
RTEpropertiesBuilder()
Initializes a new instance of the RTEpropertiesBuilder class.
Declaration
public RTEpropertiesBuilder()RTEpropertiesBuilder(RTE)
Initializes a new instance of the RTEpropertiesBuilder class.
Declaration
public RTEpropertiesBuilder(RTE rte)Parameters
| Type | Name | Description |
|---|---|---|
| RTE | rte | Accepts RTE properties |
Methods
AllowEditing()
Enables/disables the editing of the content.
Declaration
public RTEpropertiesBuilder AllowEditing()Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns boolean value |
AllowEditing(Boolean)
Enables/disables the editing of the content.A boolean variable allowEditing is passed as an argument.
Declaration
public RTEpropertiesBuilder AllowEditing(bool allowEditing)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | allowEditing | allowEditing |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns boolean value |
AllowKeyboardnavigation()
RTE control can be accessed through the keyboard shortcut keys.
Declaration
public RTEpropertiesBuilder AllowKeyboardnavigation()Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns boolean value |
AllowKeyboardnavigation(Boolean)
RTE control can be accessed through the keyboard shortcut keys.A boolean variable allowKeyboardNavigation is passed.
Declaration
public RTEpropertiesBuilder AllowKeyboardnavigation(bool allowKeyboardNavigation)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | allowKeyboardNavigation | allowKeyboardNavigation |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns boolean value |
AutoFocus()
When the property is set to true, it focuses the RTE at the time of rendering.
Declaration
public RTEpropertiesBuilder AutoFocus()Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns boolean value |
AutoFocus(Boolean)
When the property is set to true, it focuses the RTE at the time of rendering.A boolean variable autoFocus is passed as an argument.
Declaration
public RTEpropertiesBuilder AutoFocus(bool autoFocus)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | autoFocus | autoFocus |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns boolean value |
AutoHeight()
Based on the content size, its height is adjusted instead of adding the scrollbar.
Declaration
public RTEpropertiesBuilder AutoHeight()Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns boolean value |
AutoHeight(Boolean)
Based on the content size, its height is adjusted instead of adding the scrollbar.A boolean variable autoHeight is passed as an argument.
Declaration
public RTEpropertiesBuilder AutoHeight(bool autoHeight)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | autoHeight | autoHeight |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns boolean value |
Change(String)
Occurs when changed successfully.
Declaration
public RTEpropertiesBuilder Change(string change)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | change | change |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns string value |
ClientSideEvents(Action<RTEclientSideEventsBuilder>)
Specifies the RTE Client side events.
Declaration
public RTEpropertiesBuilder ClientSideEvents(Action<RTEclientSideEventsBuilder> clientSideEvents)Parameters
| Type | Name | Description |
|---|---|---|
| System.Action<RTEclientSideEventsBuilder> | clientSideEvents | clientSideEvents |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns RTE properties builder value |
ColorCode(List<String>)
Sets the colorCode to display the color of the fontColor and backgroundColor in the font tools of the RTE.
Declaration
public RTEpropertiesBuilder ColorCode(List<string> colorCode)Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.List<System.String> | colorCode | colorCode |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns object value |
ColorPaletteColumns(Int32)
The number of columns given are rendered in the color palate popup.
Declaration
public RTEpropertiesBuilder ColorPaletteColumns(int colorPaletteColumns)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | colorPaletteColumns | colorPaletteColumns |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns string value |
ColorPaletteRows(Int32)
The number of rows given are rendered in the color palate popup.
Declaration
public RTEpropertiesBuilder ColorPaletteRows(int colorPaletteRows)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | colorPaletteRows | colorPaletteRows |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns number value |
ContentTemplate(Action<Object>)
Specifies the RTE content template.
Declaration
public RTEpropertiesBuilder ContentTemplate(Action<object> contentTemplate)Parameters
| Type | Name | Description |
|---|---|---|
| System.Action<System.Object> | contentTemplate | contentTemplate |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns RTE properties builder value |
ContentTemplate(Func<Object, Object>)
Specifies the RTE content template.
Declaration
public RTEpropertiesBuilder ContentTemplate(Func<object, object> contentTemplate)Parameters
| Type | Name | Description |
|---|---|---|
| System.Func<System.Object, System.Object> | contentTemplate | contentTemplate |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns RTE properties builder value |
Create(String)
Occurs when create RTE control.
Declaration
public RTEpropertiesBuilder Create(string create)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | create | create |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns string value |
CssClass(String)
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
public RTEpropertiesBuilder CssClass(string cssClass)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | cssClass | cssClass |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns string value |
Destroy(String)
Occurs before the RTE is destroyed.
Declaration
public RTEpropertiesBuilder Destroy(string destroy)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | destroy | destroy |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns string value |
Enabled()
Enables/disables the RTE control’s accessibility or interaction.
Declaration
public RTEpropertiesBuilder Enabled()Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns boolean value |
Enabled(Boolean)
Enables/disables the RTE control’s accessibility or interaction.A boolean variable enabled is passed.
Declaration
public RTEpropertiesBuilder Enabled(bool enabled)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | enabled | enabled |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns boolean value |
EnableHtmlEncode()
When the property is set to true, it returns the encrypted text.
Declaration
public RTEpropertiesBuilder EnableHtmlEncode()Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns boolean value |
EnableHtmlEncode(Boolean)
When the property is set to true, it returns the encrypted text.A boolean variable enableHtmlEncode is passed as an argument.
Declaration
public RTEpropertiesBuilder EnableHtmlEncode(bool enableHtmlEncode)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | enableHtmlEncode | enableHtmlEncode |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns boolean value |
EnablePersistence()
Maintain the values of the RTE after page reload.
Declaration
public RTEpropertiesBuilder EnablePersistence()Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns boolean value |
EnablePersistence(Boolean)
Maintain the values of the RTE after page reload.A boolean variable enablePersistence is passed as an argument.
Declaration
public RTEpropertiesBuilder EnablePersistence(bool enablePersistence)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | enablePersistence | enablePersistence |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns boolean value |
EnableResize()
Shows the resize icon and enables the resize option in the RTE.
Declaration
public RTEpropertiesBuilder EnableResize()Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns boolean value |
EnableResize(Boolean)
Shows the resize icon and enables the resize option in the RTE.A boolean variable allowResizing is passed as an argument.
Declaration
public RTEpropertiesBuilder EnableResize(bool allowResizing)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | allowResizing | allowResizing |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns boolean value |
EnableRTL()
Shows the RTE in the RTL direction.
Declaration
public RTEpropertiesBuilder EnableRTL()Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns boolean value |
EnableRTL(Boolean)
Shows the RTE in the RTL direction.A boolean variable enableRTL is passed as an argument.
Declaration
public RTEpropertiesBuilder EnableRTL(bool enableRTL)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | enableRTL | enableRTL |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns boolean value |
EnableTabKeyNavigation(Boolean)
Specifies the tab key navigation.
Declaration
public RTEpropertiesBuilder EnableTabKeyNavigation(bool enableTabKeyNavigation)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | enableTabKeyNavigation | enableTabKeyNavigation |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns boolean value |
EnableXHTML()
Formats the contents based on the XHTML rules.
Declaration
public RTEpropertiesBuilder EnableXHTML()Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns boolean value |
EnableXHTML(Boolean)
Formats the contents based on the XHTML rules.A boolean variable enableXHTML is passed as an argument.
Declaration
public RTEpropertiesBuilder EnableXHTML(bool enableXHTML)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | enableXHTML | enableXHTML |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns boolean value |
Execute(String)
Occurs when the commands are executed successfully.
Declaration
public RTEpropertiesBuilder Execute(string execute)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | execute | execute |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns string value |
ExportToPdfSettings(Action<ExportToPdfSettingsBuilder>)
Sets the exportToPdfSettings in the RTE.
Declaration
public RTEpropertiesBuilder ExportToPdfSettings(Action<ExportToPdfSettingsBuilder> exportToPdfSettings)Parameters
| Type | Name | Description |
|---|---|---|
| System.Action<ExportToPdfSettingsBuilder> | exportToPdfSettings | exportToPdfSettings |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns object value |
ExportToWordSettings(Action<ExportToWordSettingsBuilder>)
Sets the exportToWordSettings in the RTE.
Declaration
public RTEpropertiesBuilder ExportToWordSettings(Action<ExportToWordSettingsBuilder> exportToWordSettings)Parameters
| Type | Name | Description |
|---|---|---|
| System.Action<ExportToWordSettingsBuilder> | exportToWordSettings | exportToWordSettings |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns object value |
ExternalCSS(String)
Load the external CSS file inside Iframe.
Declaration
public RTEpropertiesBuilder ExternalCSS(string externalCSS)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | externalCSS | externalCSS |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns string value |
FileBrowser(Action<FileBrowserBuilder>)
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
public RTEpropertiesBuilder FileBrowser(Action<FileBrowserBuilder> ajaxOptions)Parameters
| Type | Name | Description |
|---|---|---|
| System.Action<FileBrowserBuilder> | ajaxOptions | ajaxOptions |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns object value |
FocusOnLoad()
When the property is set to true, it focuses the RTE at the time of rendering. Note:
Declaration
[Obsolete("This method has been deprecated with AutoFocus method.")]
public RTEpropertiesBuilder FocusOnLoad()Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns boolean value |
FocusOnLoad(Boolean)
When the property is set to true, it focuses the RTE at the time of rendering. Note: this method has been deprecated with AutoFocus method.
Declaration
[Obsolete("This method has been deprecated with AutoFocus method.")]
public RTEpropertiesBuilder FocusOnLoad(bool focusOnLoad)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | focusOnLoad | focusOnLoad |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns boolean value |
FontName(Action<FontNameBuilder>)
Sets the fontName in the RTE.
Declaration
public RTEpropertiesBuilder FontName(Action<FontNameBuilder> fontName)Parameters
| Type | Name | Description |
|---|---|---|
| System.Action<FontNameBuilder> | fontName | fontName |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns object value |
FontName(List<FontName>)
Sets the fontName in the RTE.
Declaration
public RTEpropertiesBuilder FontName(List<FontName> fontName)Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.List<FontName> | fontName | fontName |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns object value |
FontSize(Action<FontSizeBuilder>)
Sets the fontSize in the RTE.
Declaration
public RTEpropertiesBuilder FontSize(Action<FontSizeBuilder> fontSize)Parameters
| Type | Name | Description |
|---|---|---|
| System.Action<FontSizeBuilder> | fontSize | fontSize |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns object value |
FontSize(List<FontSize>)
Sets the fontSize in the RTE.
Declaration
public RTEpropertiesBuilder FontSize(List<FontSize> fontSize)Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.List<FontSize> | fontSize | fontSize |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns string value |
Format(Action<FormatBuilder>)
Sets the format in the RTE.
Declaration
public RTEpropertiesBuilder Format(Action<FormatBuilder> format)Parameters
| Type | Name | Description |
|---|---|---|
| System.Action<FormatBuilder> | format | format |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns object value |
Format(List<Format>)
Sets the format in the RTE.
Declaration
public RTEpropertiesBuilder Format(List<Format> format)Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.List<Format> | format | format |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns object value |
Height(String)
Defines the height of the RTE textbox.
Declaration
public RTEpropertiesBuilder Height(string height)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | height | height |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns string value |
HtmlAttributes(IDictionary<String, Object>)
Specifies the HTML Attributes of the RTE control.
Declaration
public RTEpropertiesBuilder HtmlAttributes(IDictionary<string, object> itemHtmlAttributes)Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.IDictionary<System.String, System.Object> | itemHtmlAttributes | itemHtmlAttributes |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns object value |
IFrameAttributes(IDictionary<String, Object>)
Specifies the HTML Attributes of the RTE control.
Declaration
public RTEpropertiesBuilder IFrameAttributes(IDictionary<string, object> itemIframeAttributes)Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.IDictionary<System.String, System.Object> | itemIframeAttributes | itemIframeAttributes |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns object value |
ImageBrowser(Action<ImageBrowserBuilder>)
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
public RTEpropertiesBuilder ImageBrowser(Action<ImageBrowserBuilder> ajaxOptions)Parameters
| Type | Name | Description |
|---|---|---|
| System.Action<ImageBrowserBuilder> | ajaxOptions | ajaxOptions |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns object value |
ImportSettings(Action<ImportSettingsBuilder>)
Sets the importSettings in the RTE.
Declaration
public RTEpropertiesBuilder ImportSettings(Action<ImportSettingsBuilder> importSettings)Parameters
| Type | Name | Description |
|---|---|---|
| System.Action<ImportSettingsBuilder> | importSettings | importSettings |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns object value |
IsResponsive()
Enables/disables responsive support for the RTE control toolbar items during the window resizing time.
Declaration
public RTEpropertiesBuilder IsResponsive()Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns boolean value |
IsResponsive(Boolean)
Enables/disables responsive support for the RTE control toolbar items during the window resizing time.
Declaration
public RTEpropertiesBuilder IsResponsive(bool isResponsive)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | isResponsive | isResponsive |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns boolean value |
Keydown(String)
Occurs when the keydown action is successful.
Declaration
public RTEpropertiesBuilder Keydown(string keydown)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | keydown | keydown |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns string value |
Keyup(String)
Occurs when the keyup action is successful.
Declaration
public RTEpropertiesBuilder Keyup(string keyup)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | keyup | keyup |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns string value |
Locale(String)
Sets the culture in the RTE when you set the localization values are needs to be assigned to the corresponding text as follows.
Declaration
public RTEpropertiesBuilder Locale(string locale)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | locale | locale |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns string value |
MaxHeight(String)
Sets the maximum height for the RTE outer wrapper element.
Declaration
public RTEpropertiesBuilder MaxHeight(string maxHeight)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | maxHeight | maxHeight |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns string value |
MaxLength(Int32)
Sets the maximum length for the RTE outer wrapper element.
Declaration
public RTEpropertiesBuilder MaxLength(int maxLength)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | maxLength | maxLength |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns number value |
MaxWidth(String)
Sets the maximum width for the RTE outer wrapper element.
Declaration
public RTEpropertiesBuilder MaxWidth(string maxWidth)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | maxWidth | maxWidth |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns string value |
MinHeight(String)
Sets the minimum height for the RTE outer wrapper element.
Declaration
public RTEpropertiesBuilder MinHeight(string minHeight)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | minHeight | minHeight |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns string value |
MinWidth(String)
Sets the minimum width for the RTE outer wrapper element.
Declaration
public RTEpropertiesBuilder MinWidth(string minWidth)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | minWidth | minWidth |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns string value |
Name(String)
Sets the name in the RTE. When the name value is not initialized, the ID value is assigned to the name.
Declaration
public RTEpropertiesBuilder Name(string name)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | name |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns string value |
PasteCleanupSettings(Action<CleanupFilterBuilder>)
sets the PasteCleanup filter settings in the RTE.
Declaration
public RTEpropertiesBuilder PasteCleanupSettings(Action<CleanupFilterBuilder> option)Parameters
| Type | Name | Description |
|---|---|---|
| System.Action<CleanupFilterBuilder> | option | option |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns the property builder |
Render()
Specifies the Render method of RTE.
Declaration
public void Render()Select(String)
Occurs when selected successfully.
Declaration
public RTEpropertiesBuilder Select(string select)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | select | select |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns string value |
ShowCharCount()
Counts the total characters and displays it in the RTE footer.
Declaration
public RTEpropertiesBuilder ShowCharCount()Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns boolean value |
ShowCharCount(Boolean)
Counts the total characters and displays it in the RTE footer.A boolean variable showCharCount is passed as an argument.
Declaration
public RTEpropertiesBuilder ShowCharCount(bool showCharCount)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | showCharCount |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns boolean value |
ShowClearAll()
Shows ClearAll icon in the RTE footer.
Declaration
public RTEpropertiesBuilder ShowClearAll()Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns boolean value |
ShowClearAll(Boolean)
Shows ClearAll icon in the RTE footer.showClearAll is the boolean variable that is passed as an argument.
Declaration
public RTEpropertiesBuilder ShowClearAll(bool showClearAll)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | showClearAll | showClearAll |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns boolean value |
ShowClearFormat()
Shows the clear format in the RTE footer.
Declaration
public RTEpropertiesBuilder ShowClearFormat()Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns boolean value |
ShowClearFormat(Boolean)
Shows the clear format in the RTE footer.A boolean variable showClearFormat is passed as an argument.
Declaration
public RTEpropertiesBuilder ShowClearFormat(bool showClearFormat)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | showClearFormat | showClearFormat |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns boolean value |
ShowContextMenu(Boolean)
Shows the context menu in the RTE.
Declaration
public RTEpropertiesBuilder ShowContextMenu(bool showContextMenu)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | showContextMenu | showContextMenu |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns boolean value |
ShowCustomTable()
Shows the Custom Table in the RTE.
Declaration
public RTEpropertiesBuilder ShowCustomTable()Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns boolean value |
ShowCustomTable(Boolean)
Shows the Custom Table in the RTE.showCustomTable is passed as an argument here.
Declaration
public RTEpropertiesBuilder ShowCustomTable(bool showCustomTable)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | showCustomTable | showCustomTable |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns boolean value |
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
public RTEpropertiesBuilder ShowDimensions()Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns boolean value |
ShowDimensions(Boolean)
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.showDimensions is the boolean variable passed.
Declaration
public RTEpropertiesBuilder ShowDimensions(bool showDimensions)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | showDimensions | showDimensions |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns boolean value |
ShowFontOption()
Shows the FontOption in the RTE.
Declaration
public RTEpropertiesBuilder ShowFontOption()Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns boolean value |
ShowFontOption(Boolean)
Shows the FontOption in the RTE.A boolean variable showFontOption is passed as an argument.
Declaration
public RTEpropertiesBuilder ShowFontOption(bool showFontOption)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | showFontOption | showFontOption |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns boolean value |
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
public RTEpropertiesBuilder ShowFooter()Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns boolean value |
ShowFooter(Boolean)
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.A boolean variable showFooter is passed as an argument.
Declaration
public RTEpropertiesBuilder ShowFooter(bool showFooter)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | showFooter | showFooter |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns boolean value |
ShowHtmlSource()
Shows the HtmlSource in the RTE footer.
Declaration
public RTEpropertiesBuilder ShowHtmlSource()Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns boolean value |
ShowHtmlSource(Boolean)
Shows the HtmlSource in the RTE footer.showHtmlSource is the boolean variable passed.
Declaration
public RTEpropertiesBuilder ShowHtmlSource(bool showHtmlSource)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | showHtmlSource | showHtmlSource |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns boolean value |
ShowHtmlTagInfo()
When the cursor is placed or when the text is selected in the RTE, it displays the tag info in the footer.
Declaration
public RTEpropertiesBuilder ShowHtmlTagInfo()Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns boolean value |
ShowHtmlTagInfo(Boolean)
When the cursor is placed or when the text is selected in the RTE, it displays the tag info in the footer.A boolean variable showHtmlTagInfo is passed as an argument.
Declaration
public RTEpropertiesBuilder ShowHtmlTagInfo(bool showHtmlTagInfo)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | showHtmlTagInfo | showHtmlTagInfo |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns boolean value |
ShowRoundedCorner()
Specifies the rounded corner in RTE.
Declaration
public RTEpropertiesBuilder ShowRoundedCorner()Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns boolean value |
ShowRoundedCorner(Boolean)
Specifies the rounded corner in RTE.
Declaration
public RTEpropertiesBuilder ShowRoundedCorner(bool showRoundedCorner)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | showRoundedCorner | showRoundedCorner |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns boolean value |
ShowToolbar()
Shows the toolbar in the RTE.
Declaration
public RTEpropertiesBuilder ShowToolbar()Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns boolean value |
ShowToolbar(Boolean)
Shows the toolbar in the RTE.A boolean variable showToolbar is passed as an argument.
Declaration
public RTEpropertiesBuilder ShowToolbar(bool showToolbar)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | showToolbar | showToolbar |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns boolean value |
ShowWordCount()
Counts the total words and displays it in the RTE footer.
Declaration
public RTEpropertiesBuilder ShowWordCount()Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns boolean value |
ShowWordCount(Boolean)
Counts the total words and displays it in the RTE footer.A boolean variable showWordCount is passed as an argument.
Declaration
public RTEpropertiesBuilder ShowWordCount(bool showWordCount)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | showWordCount | showWordCount |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns boolean value |
TableColumns(Int32)
The given number of columns render the insert table pop.
Declaration
public RTEpropertiesBuilder TableColumns(int tableColumns)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | tableColumns | tableColumns |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns number value |
TableRows(Int32)
The given number of rows render the insert table pop.
Declaration
public RTEpropertiesBuilder TableRows(int tableRows)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | tableRows | tableRows |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns number value |
ToHtmlString()
Specifies the ToHtmlString method of RTE.
Declaration
public string ToHtmlString()Returns
| Type | Description |
|---|---|
| System.String | This method returns string value |
ToolbarOverflowMode(ToolbarOverflowMode)
Specifies the RTE Toolbar Type.
Declaration
public RTEpropertiesBuilder ToolbarOverflowMode(ToolbarOverflowMode toolbarOverflowMode)Parameters
| Type | Name | Description |
|---|---|---|
| ToolbarOverflowMode | toolbarOverflowMode | toolbarOverflowMode |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns enum|string value |
Tools(Action<RTEtoolsBuilder>)
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
public RTEpropertiesBuilder Tools(Action<RTEtoolsBuilder> tools)Parameters
| Type | Name | Description |
|---|---|---|
| System.Action<RTEtoolsBuilder> | tools | tools |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns object value |
ToolsList(List<String>)
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
public RTEpropertiesBuilder ToolsList(List<string> toolsList)Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.List<System.String> | toolsList | toolsList |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns object value |
TooltipSettings(Action<TooltipPropertiesBuilder>)
Sets the tooltipSettings in the RTE.
Declaration
public RTEpropertiesBuilder TooltipSettings(Action<TooltipPropertiesBuilder> tooltipSettings)Parameters
| Type | Name | Description |
|---|---|---|
| System.Action<TooltipPropertiesBuilder> | tooltipSettings |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns object value |
UndoStackLimit(Int32)
Gets the undo stack limit.
Declaration
public RTEpropertiesBuilder UndoStackLimit(int undoStackLimit)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | undoStackLimit | undoStackLimit |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns number value |
ValidationMessage(Action<RTEValidationMessageBuilder>)
Declaration
public RTEpropertiesBuilder ValidationMessage(Action<RTEValidationMessageBuilder> validationMessage)Parameters
| Type | Name | Description |
|---|---|---|
| System.Action<RTEValidationMessageBuilder> | validationMessage |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder |
ValidationMessage(Dictionary<String, Object>)
Declaration
public RTEpropertiesBuilder ValidationMessage(Dictionary<string, object> validationMessage)Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.Dictionary<System.String, System.Object> | validationMessage |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder |
ValidationRules(Action<RTEValidationRuleBuilder>)
Declaration
public RTEpropertiesBuilder ValidationRules(Action<RTEValidationRuleBuilder> validationRule)Parameters
| Type | Name | Description |
|---|---|---|
| System.Action<RTEValidationRuleBuilder> | validationRule |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder |
ValidationRules(Dictionary<String, Object>)
Declaration
public RTEpropertiesBuilder ValidationRules(Dictionary<string, object> validationRule)Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.Dictionary<System.String, System.Object> | validationRule |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder |
Value(String)
The given string value is displayed in the editable area.
Declaration
public RTEpropertiesBuilder Value(string value)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | value | value |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns string value |
Width(String)
Defines the width of the RTE textbox.
Declaration
public RTEpropertiesBuilder Width(string width)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | width | width |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns string value |
ZoomStep(String)
Specifies the zoom step.
Declaration
public RTEpropertiesBuilder ZoomStep(string zoomStep)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | zoomStep | zoomStep |
Returns
| Type | Description |
|---|---|
| RTEpropertiesBuilder | This method returns string value |