obout inc - ASP.NET Editor - Server component - Editor properties and events

Editor properties and events

<%@ Register TagPrefix="ed" Namespace="OboutInc.Editor" Assembly="obout_Editor" %>

New: All properties can be used inside template XML files, except Template.

OboutInc.Editor.Editor properties

ID	String. Component Id.
Height	Int. Editor component height in pixels. Default 400. Optional See also working example.
Width	Int. Editor component width in pixels. Default value is set in style.css file in HC_div class height property (top of the CSS file). Initialy it is set 100%. Optional See also working example.
MaxSuggestions	Int. Maximum of suggestions for each incorrect word in Spell checker popup window. Default 25. Optional
Content	String. Editor's HTML content. Default empty. Optional Preferably this property should be set and retrieved in Page_Load method of the Page. If content can be changed on some callback events, use Page_PreRender method of the Page. See also working example.
PlainText	String. Plain text of Editor's content. ReadOnly See also working example.
CallbackContent	Bool. Indicates that Editor's HTML content should be replaced with a value passed on callback. true - content is replaced with a value passed on callback false - content callback is suppressed Default "true". Optional See also working example.
Language	String. Language name used in Editor component. Every accessible language name is corresponded with <name>.xml file located in LocalizationFolder directory. User can take file en.xml as a template and create his own localization XML file for his native language (for example de.xml). Default "en". Optional See also working example.
LocalizationFolder	String. Path to directory with localization XML files. Default "ed_localization". Optional
ScriptFolder	String. Path to directory with JavaScript files. Default "ed_scripts". Optional
QuickFormatFolder	String. Path to directory with Quick Format CSS file. Default "ed_quickformat". Optional
QuickFormatFile	String. Name of Quick Format CSS file in QuickFormatFolder directory. Default "QuickFormat.css". Optional See also working example .
StyleFolder	String. Path to directory with Editor's style file and images. Default "ed_styles". Optional
StyleFile	String. Name of the Editor's style file in StyleFolder directory. Default "style.css". Optional
IconFolder	String. Path to directory with Editor's icons subdirectories. Every such subdirectory name appears in TABs of Insert Icon popup window. This window is opened on toolbar's Insert Icon button click. Icon images are contained in these subdirectories. Default "ed_icons". Optional
DictionariesFolder	String. Path to directory with Editor's spell checker dictionaries. Default "ed_dictionaries". Optional
TemplateFolder	String. Path to directory with Editor's templates XML files. Default "ed_templates". Optional
PathPrefix	String. Path prefix for QuickFormatFolder, StyleFolder, DictionariesFolder, IconFolder and ScriptFolder directories. Default empty. Optional editor.PathPrefix = "../" See also How to set PathPrefix correctly?
Template	String. Name (without extension) of Editor's template XML file in TemplateFolder directory. If you set this property, it should be set after PathPrefix and TemplateFolder properties. Note: This property is ignored if used inside template XML file. By default no template is used. Optional See also working example.
ModeSwitch	Bool. Indicates that user can switch the editing mode. true - user can use both Design and HTML text editing modes. false - user can use Design editing mode only Depending on this value the corresponding mode switch buttons will be shown or not in the editor's bottom bar. Default "true". Optional See also working example.
Submit	Bool. Indicates that Submit button will be shown or not in the editor's bottom bar. true - show the Submit button false - don't show the Submit button Default "true". Optional See also working example.
Cancel	Bool. Indicates that Cancel button will be shown or not in the editor's bottom bar. true - show the Cancel button false - don't show the Cancel button Default "false". Optional See also working example.
ClientCancel	String. Name of client-side function that will be executed on Cancel button click. This function has one parameter - client-side Editor object. This function should return true if you want to continue Cancel operation (ClickCancel server-side event is set). If this function returns false the Cancel operation will be terminated. See also working example.
PreviewMode	Bool. Indicates that Preview button will be shown or not in the editor's bottom bar. true - show the Preview button false - don't show the Preview button Default "false". Optional See also working example.
Show	Bool. Indicates that Editor component will be initially shown on client side. true - component is shown initialy false - component isn't shown initialy Default "true". Optional See also working example. On client side the visibility of Editor's component can be changed by setVisibility method. See For JavaScript Developers.
ShowQuickFormat	Bool. Indicates that Quick Formatting panel will be shown in Editor. true - is shown false - isn't shown Default "true". Optional See also working example.
ShowAnchors	Bool. Indicates that initialy special image will be shown in place of each Anchor in Editor's panel. true - is shown false - isn't shown Default "true". Optional
ShowPlaceHolders	Bool. Indicates that initialy special image will be shown in place of each PlaceHolder in Editor's panel. true - is shown false - isn't shown Default "true". Optional
AutoFocus	Bool. Indicates initial Editor focusing. true - get focus false - get no focus Default "true". Optional See also working example.
AjaxWait	Bool. Indicates that "wait" image will appear in the middle of Editor on MS ASP.NET AJAX post back till the final rerendering. true - "wait" image appears false - "wait" image doesn't appear Default "true". Optional
AjaxCurrentContent	Bool. Indicates that Server-Side will get the current Editor's content on MS ASP.NET AJAX post back when Editor component is outside any UpdatePanel. true - current Editor's content will be sent to Server-Side. Some time will be spent for this operation on Client-Side. "Please wait..." message can appear in Editor false - Server-Side will not get the current Editor's content Default "true". Optional
NoScript	Bool. Indicates that any Java Script code will be suppressed in Editor's content. true - Java Script code is suppressed false - Java Script code is not suppressed Default "false". Optional
NoUnicode	Bool. Indicates that Editor's content will contain Unicode characters. false - Editor's content will contain Unicode characters true - Editor's content will contain &#code; instead of Unicode characters Default "false". Optional
SuppressTab	Bool. Indicates that Editor will ignore Tab key in Design mode. true - ignores Tab key false - processes Tab key as a set of spaces Default "false". Optional
IgnoreTab New	Bool. Suppress Tab key navigation inside Editor control. true - Tab key doesn't navigate inside Editor false - navigation as usual Default "false". Optional
FullHTML	Bool. Indicates that Editor will generate its content as entire page HTML code with <HTML>, <HEAD> and <BODY> tags. true - generates entire page HTML code false - generates <BODY>'s content only Default "false". Optional See also working example.
RemainLfOnSubmit	Bool. Indicates whether Editor remain Line feed characters in submitted content. true - Line feed characters will be remained in content false - Line feed characters will be removed Default "false". Optional
Rtl	Bool. Indicates that right to left direction of content is set initially. true - right to left false - left to right Default "false". Optional See also working example.
ScrollIntoView	Bool. Indicates that the top of Editor component will be visible on Page load. It is usefull in large pages when Editor is far from page top. true - page scrolls to Editor if it is invisible false - page doesn't scroll to Editor if it is invisible Default "false". Optional
RelImgUrls	Bool. Indicates manner of Images's src property representation when relative URL was setted in Image properties popup window. true - relative URL false - absolute URL Default "false". Optional
CaretPosition	Bool. Indicates caret position in content on Editor loaded. true - beginning of content false - end of content Default "false". Optional See also working example.
NoDrop	Bool. Prohibits any dropping to Editor's panel. true - dropping is prohibited false - dropping is not prohibited Default "false". Optional
NoPaste	Bool. Prohibits any pasting (except Plain Text) to Editor's panel in Design mode. true - pasting is prohibited false - pasting is not prohibited Default "false". Optional