ASP.NET 3.5 and above only

Obout.Ajax.UI Controls - HTML Editor - Client side

Obout.Ajax.UI.HTMLEditor.EditorEditPanel class

 Inheritance Hierarchy

It is a client-side representation of the server-side Obout.Ajax.UI.HTMLEditor.EditorEditPanel class.
Note Note
To get or set property values for client API properties, you must call property accessor methods that are named with the get_ and set_ prefixes. For example, to get or set a value for a property such as fullHtml, you call the get_fullHtml or set_fullHtml methods:
var editPanelObject = $find("<%= myEditor.ClientID %>").get_editPanel();
var _fullHtml = editPanelObject.get_fullHtml();
...
editPanelObject.set_fullHtml(false);

Properties

Name Description
propertyactiveContextMenu Obout.Ajax.UI.HTMLEditor.ContextMenu.ContextMenu. Gets an object of the context menu if it is opened, otherwise returns null. (Inherited from EditPanel.)
propertyactiveMode ActiveModeType. Gets or sets the active edit mode. (Inherited from EditPanel.)
propertyactivePanel object. Gets an object of the current mode panel. (Inherited from EditPanel.)
Depending on the value of the activeMode property, the object can be one the following types:
Obout.Ajax.UI.HTMLEditor.DesignPanel,
Obout.Ajax.UI.HTMLEditor.HtmlPanel,
Obout.Ajax.UI.HTMLEditor.PreviewPanel.
propertyadditionalCSS object. Gets an array of additioanal CSS files that should be added to the document ('Design' and 'Preview' modes). (Inherited from EditPanel.)
propertyautoFocus boolean. Gets or sets a value indicating whether the Edit Panel will be focused on load. (Inherited from EditPanel.)
Default true.
propertycancelNames string. Gets or sets the semicolon separated names of controls that may cause a postback on which the posted content should be ignored. (Inherited from EditPanel.)
propertycontent string. Gets or sets the HTML content. (Inherited from EditPanel.)
propertycontextMenuClientID string. Gets the identifier of the Obout.Ajax.UI.HTMLEditor.ContextMenu.ContextMenu control object. (Inherited from EditPanel.)
propertydefaultDirection string. Gets the default direction in document. (Inherited from EditPanel.)
Default "ltr".
propertydefaultFontFamily string. Gets or sets the font family used in all edit modes of the control. (Inherited from EditPanel.)
By default (empty) the appropriate CSS is used.

See online example.
propertydefaultFontSize string. Gets or sets the font size used in all edit modes of the control. (Inherited from EditPanel.)
By default (empty) the appropriate CSS is used.

See online example.
propertyelement string. Gets the DOM element that the current Control instance is associated with. (Inherited from Sys.UI.Control.)
propertyfullHtml boolean. Gets or sets a value indicating whether the content will be generated as entire page HTML code with <HTML>, <HEAD> and <BODY> tags. (Inherited from EditPanel.)
Default false.
propertyhistorySizeInDesignMode number. Gets or sets the maximum length of undo/redo history in Design mode. (Inherited from EditPanel.)
Default 30.
propertyid string. Gets the identifier for the current Control object. The default is the id value of the associated Sys.UI.DomElement object. (Inherited from Sys.UI.Control.)
propertyimmediateValidation boolean. Gets or sets a value indicating whether the ASP.NET validation will be run immediately on content set or Design panel blur. (Inherited from EditPanel.)
Default true.
propertyindentInDesignMode number. Gets or sets the width of Indent (pixeles) in Design mode. (Inherited from EditPanel.)
Default 40.
propertyinitialCleanUp boolean. Gets or sets a value indicating whether the inital cleanup (MS Word tags) of the content will be done on the control load. (Inherited from EditPanel.)
Default false.
propertymodePanels object array. Gets an array of the following objects (in this order):
Obout.Ajax.UI.HTMLEditor.DesignPanel,
Obout.Ajax.UI.HTMLEditor.HtmlPanel,
Obout.Ajax.UI.HTMLEditor.PreviewPanel.
(Inherited from EditPanel.)
propertynoDrop boolean. Gets or sets a value indicating whether any dropping in Design mode is prohibited. (Inherited from EditPanel.)
Default false.
propertynoPaste boolean. Gets or sets a value indicating whether any pasting (except Plain Text) in Design mode is prohibited. (Inherited from EditPanel.)
Default false.
propertynoScript boolean. Gets or sets a value indicating whether JavaScript code will be suppressed in EditPanel's content. (Inherited from EditPanel.)
Default false.
propertynoUnicode boolean. Gets or sets a value indicating whether Unicode characters (hex codes from '0080' to 'FFFF') will be replaced with &#code; in EditPanel's content. (Inherited from EditPanel.)
Default false.
propertyoldTags boolean. Gets or sets a value indicating whether to generate old-fashioned tags (bold, em, etc.). (Inherited from EditPanel.)
Default false.
propertyowner object. Gets an object of type Obout.Ajax.UI.HTMLEditor.Editor if this edit panel is a part of Editor control, otherwise - null.
propertyplainText string. Gets the plain text from the content. (Inherited from EditPanel.)
propertyresizeByDraggingEnabled boolean. Gets or sets a value indicating whether the resize-by-dragging tool is enabled in Design mode for <IMG>, <DIV> etc. elements. IE and FireFox have this tool only. (Inherited from EditPanel.)
Default true.
propertyshowAnchors boolean. Gets or sets a value indicating whether anchors are visible in Design mode. (Inherited from EditPanel.)
Default true.
propertystartEnd boolean. Gets or sets a value indicating whether the initial caret position in Design mode will be set at the document's start. (Inherited from EditPanel.)
Default true.
propertysuppressTabInDesignMode boolean. Gets or sets a value indicating whether to ignore 'Tab' key in Design mode. (Inherited from EditPanel.)
Default false.
propertytoolbars Obout.Ajax.UI.HTMLEditor.Toolbar array. Gets an array of linked toolbars. (Inherited from EditPanel.)

Methods

Name Description
propertyclearHistory() Removes the whole history of changings used for undo/redo operations. (Inherited from EditPanel.)
propertycloseActiveContextMenu() Closes the context menu if it is opened. (Inherited from EditPanel.)
propertyensurePopupsClosed() Ensures that all popups and context menu are closed. (Inherited from EditPanel.)
propertypartialUpdate(cmd, args) Send a command to the server with partial update of the EditPanel. (Inherited from EditPanel.)
cmd - command name;
args - argument of the command.
propertyupdateToolbar() Refreshes all associated toolbars. (Inherited from EditPanel.)
Note Note
To add or remove handler functions for client API events, you must call methods that are named with the add_ and remove_ prefixes. For example, to add or remove a handler function for an event such as focused, you call the add_focused or remove_focused methods:
function focusedHandler(sender, args) {
}
...
var editPanelObject = $find("<%= editPanel1.ClientID %>");
editPanelObject.add_focused(focusedHandler);
...
editPanelObject.remove_focused(focusedHandler);

Events

Name Description
propertyactiveModeChanged Raised after the edit mode is changed. (Inherited from EditPanel.)
Event's argument has type Obout.Ajax.UI.HTMLEditor.ActiveModeChangedArgs.
propertybeforeActiveModeChanged Raised before the edit mode is changed. (Inherited from EditPanel.)
Event's argument has type Obout.Ajax.UI.HTMLEditor.ActiveModeChangedArgs.
propertyfocused Raised when the edit panel is focused. (Inherited from EditPanel.)
Event's argument has type Sys.EventArgs.Empty.
propertygetContent Raised before the content be obtained (on submit, on edit mode change or get_content() method call). (Inherited from EditPanel.)
It is a suitable moment to check and modify the content to be submitted.
Event's argument has type Obout.Ajax.UI.HTMLEditor.GetContentArgs.
propertyloaded Raised after the control's loading is completed. (Inherited from EditPanel.)
Event's argument has type Sys.EventArgs.Empty.

"I appreciate your time and your patience. You provided outstanding support. "

Tien Nguyen
Dermalogica, Inc.

Random testimonial   All testimonials