Class Editor
The TinyMCE web editor. Converts your TextArea to a rich text box.
Inheritance
Namespace: EPiServer.Editor.TinyMCE
Assembly: EPiServer.dll
Version: 7.19.2Syntax
public class Editor : TextBoxConstructors
Editor()
Initializes a new instance of the Editor class.
Declaration
public Editor()Editor(TinyMCESettings, IContent, TinyMCEInitOptions.InitType)
Initializes a new instance of the Editor class.
Declaration
public Editor(TinyMCESettings settings, IContent content, TinyMCEInitOptions.InitType initType)Parameters
| Type | Name | Description |
|---|---|---|
| TinyMCESettings | settings | The settings. |
| IContent | content | The content. |
| TinyMCEInitOptions.InitType | initType | Type of the init. |
Editor(TinyMCESettings, PageBase, TinyMCEInitOptions.InitType)
Initializes a new instance of the Editor class.
Declaration
public Editor(TinyMCESettings settings, PageBase page, TinyMCEInitOptions.InitType initType)Parameters
| Type | Name | Description |
|---|---|---|
| TinyMCESettings | settings | The settings. |
| PageBase | page | The page. |
| TinyMCEInitOptions.InitType | initType | Type of the init. |
Properties
InitOptions
Gets the settings dictionary used to initialize tinyMCE.
Declaration
public virtual IDictionary<string, object> InitOptions { get; protected set; }Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IDictionary<System.String, System.Object> |
NonVisualPlugins
A collection of non visual plugins to load in this editor.
Declaration
public IList<string> NonVisualPlugins { get; }Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IList<System.String> | The non visual plugins. |
PropertySettings
Gets or Sets the property settings.
Declaration
public TinyMCESettings PropertySettings { get; set; }Property Value
| Type | Description |
|---|---|
| TinyMCESettings | The property settings. |
ToolbarRows
Editor toolbar configuration.
Declaration
public IList<ToolbarRow> ToolbarRows { get; }Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IList<ToolbarRow> | A list of toolbar rows. |
Methods
AddPluginConfiguration()
Adds the Toolbar and plugin configuration to the Settings dictionary.
Declaration
protected virtual void AddPluginConfiguration()CreateDefaultInitOptions()
Creates the default settings dictionary used for initializing tinyMCE.
Declaration
public static IDictionary<string, object> CreateDefaultInitOptions()Returns
| Type | Description |
|---|---|
| System.Collections.Generic.IDictionary<System.String, System.Object> | A dictionary with configuration options for tinyMCE. |
Remarks
Primarily for control developers.
OnInit(EventArgs)
Overridden to propagate unknown attributes to the Settings property.
Declaration
protected override void OnInit(EventArgs e)Parameters
| Type | Name | Description |
|---|---|---|
| System.EventArgs | e | An System.EventArgs object that contains the event data. |
OnPreRender(EventArgs)
Registers client script for generating postback events prior to rendering on the client, if System.Web.UI.WebControls.TextBox.AutoPostBack is true.
Declaration
protected override void OnPreRender(EventArgs e)Parameters
| Type | Name | Description |
|---|---|---|
| System.EventArgs | e | An System.EventArgs that contains the event data. |
Render(HtmlTextWriter)
Renders the System.Web.UI.WebControls.TextBox control to the specified System.Web.UI.HtmlTextWriter object.
Declaration
protected override void Render(HtmlTextWriter writer)Parameters
| Type | Name | Description |
|---|---|---|
| System.Web.UI.HtmlTextWriter | writer | The System.Web.UI.HtmlTextWriter that receives the rendered output. |
SetPageDataContext(PageBase)
Sets the epi_page_context and the UIEditorCssPaths based on the supplied page.
Declaration
public void SetPageDataContext(PageBase page)Parameters
| Type | Name | Description |
|---|---|---|
| PageBase | page | The PageBase instance to set context from. |
