Click or drag to resize
KaxEditor Properties

The KaxEditor type exposes the following members.

Properties
  Name Description
Public property AllowScripts Obsolete.
Gets or sets the value indicating whether script tags will be allowed in the editor content. This property is now obsolete. Please use the ContentFilters property or the EnableFilter and DisableFilter methods
Public property AutoResizeHeight
Gets or sets the value indicating whether the KaxEditor will auto-resize its height to match content height
Public property Code example Colors
Gets the collection containing the colors to put in the Foreground and Background color dropdowns.
Public property Code example Content
Gets or sets the text content of the KaxEditor control inlcuding the HTML markup.
Public property ContentAreaCssFile
Gets or sets a string, containing the location of the content area CSS styles. You need to set this property only if you are using a custom skin.
Public property ContentAreaMode
Gets or sets the rendering mode of the editor content area. When set to Iframe, the content area is a separate document (suitable for CMS solutions or when editing a whole page). When set to Div, the content area is in the main page. The default value is Iframe.
Public property ContentFilters
Gets or sets a value indicating which content filters will be active when the editor is loaded in the browser.
Public property ContextMenus
Public property CssClasses
Gets the collection containing the CSS classes to put in the [Apply CSS Class] dropdown.
Public property CssFiles
Gets a reference to a EditorCssFileCollection that can be used to add external CSS files in the editor content area.
Public property DialogHandlerUrl
Gets or sets the URL which the AJAX call will be made to. Check the help for more information.
Public property DialogOpener
A read-only property that returns the DialogOpener instance used in the editor control.
Public property DialogsCssFile
Gets or sets the location of a CSS file, that will be added in the dialog window. If you need to include more than one file, use the CSS @import url(); rule to add the other files from the first.
Remarks
This property is needed if you are using a custom skin. It allows you to include your custom skin CSS in the dialogs, which are separate from the main page.
Public property DialogsScriptFile
Gets or sets the location of a JavaScript file, that will be added in the dialog window. If you need to include more than one file, you will need to combine the scripts into one first.
Remarks
This property is needed if want to override some of the default functionality without loading the dialog from an external ascx file.
Public property DocumentManager
Contains the configuration of the DocumentManager dialog.
Public property EditModes
Gets or sets the value indicating which will be the available EditModes.
Public property EnableAjaxSkinRendering
Gets or sets a Boolean value that indicates whether render the skin CSS at AJAX request. The default value is true.
(Overrides KaxWebControl.EnableAjaxSkinRendering.)
Public property EnableEmbeddedBaseStylesheet
Gets or sets the value, indicating whether to render the link to the embedded base stylesheet of the control or not.
(Overrides KaxWebControl.EnableEmbeddedBaseStylesheet.)
Public property EnableEmbeddedScripts
Gets or sets a Boolean value that indicates whether enable the embedded script.
(Overrides KaxWebControl.EnableEmbeddedScripts.)
Public property EnableEmbeddedSkins
Gets or sets a Boolean value that indicates whether enable the embedded skin for the control..
(Overrides KaxWebControl.EnableEmbeddedSkins.)
Public property EnableResize
Gets or sets the value indicating whether the users will be able to resize the KaxEditor control on the client
Public property ExportSettings

Gets a reference to the EditorExportSettings object that allows you to set the export file properties

Public property ExternalDialogsPath
Gets or sets a value indicating where the editor will look for its dialogs.
Public property FlashManager
Contains the configuration of the FlashManager dialog.
Public property Code example FontNames
Gets the collection containing the custom font names to put in the Font dropdown.
Public property Code example FontSizes
Gets the collection containing the custom font sizes to put in the [Size] dropdown.
Public property Height
Gets or sets the height of the Web server control. The default height is 400 pixels.
(Overrides KaxWebControl.Height.)
Public property Html Obsolete.
Gets or sets the text content of the KaxEditor control inlcuding the HTML markup. The Html property is deprecated in KaxEditor. Use Content instead.
Public property ImageManager
Contains the configuration of the ImageManager dialog.
Public property Language
Gets or sets a string containing the localization language for the KaxEditor UI
Public property Code example Languages
Gets the collection containing the available languages for spellchecking.
Public property Code example Links
Gets the collection containing the links to put in the Custom Links dropdown.
Public property Localization
Public property LocalizationPath
Gets or sets a value indicating where the editor will look for its .resx localization files. By default these files should be in the App_GlobalResources folder. However, if you cannot put the resource files in the default location or .resx files compilation is disabled for some reason (e.g. in a DotNetNuke environment), this property should be set to the location of the resource files.
Public property MaxHtmlLength
Gets or sets the max length (in symbols) of the HTML inserted in the KaxEditor. When the value is 0 the property is disabled.
Public property MaxTextLength
Gets or sets the max length (in symbols) of the text inserted in the KaxEditor. When the value is 0 the property is disabled.
Public property MediaManager
Contains the configuration of the MediaManager dialog.
Public property Modules
Public property NewLineBr
Gets or sets the value indicating whether the KaxEditor will insert a new line or a paragraph when the [Enter] key is pressed.
Public property Code example OnClientCommandExecuted
Gets or sets a value indicating the client-side event handler that is called after an editor command was executed.
Public property Code example OnClientCommandExecuting
Gets or sets a value indicating the client-side event handler that is called before an editor command starts executing.
Public property Code example OnClientInit
Gets or sets a value indicating the client-side event handler that is called when editor starts to load on the client.
Public property Code example OnClientLoad
Gets or sets a value indicating the client-side event handler that is called when editor is loaded on the client.
Public property Code example OnClientModeChange
Gets or sets a value indicating the client-side event handler that is called when the content is submitted.
Public property Code example OnClientPasteHtml
Gets or sets a value indicating the client-side event handler that is called when a dialog is closed, but before its value returned would be pasted into the editor.
Public property Code example OnClientSelectionChange
Gets or sets a value indicating the client-side event handler that is called when selection inside editor content area changes
Public property Code example OnClientSubmit
Gets or sets a value indicating the client-side event handler that is called when the content is submitted.
Public property Code example Paragraphs
Gets the collection containing the paragraph styles to put in the Paragraph Style dropdown.
Public property Code example RealFontSizes
Gets the collection containing the custom real font sizes to put in the RealFontSize dropdown.
Public property SilverlightManager
Contains the configuration of the SilverlightManager dialog.
Public property Skin
Gets or sets the skin name for the control user interface.
(Overrides KaxWebControl.Skin.)
Public property Snippets
Gets the collection containing the snippets to put in the Code Snippet dropdown.
Public property SpellCheckSettings
Contains the configuration of the spell checker.
Public property StripFormattingOnPaste Obsolete.
This property is obsolete. Please, use the StripFormattingOptions property instead.
Public property StripFormattingOptions
Gets or sets the value indicating how the editor should clear the HTML formatting when the user pastes data into the content area.
Public property Code example Symbols
Gets the collection containing the symbols to put in the Symbols dropdown.
Public property TableLayoutCssFile
Gets or sets a string, containing the location of the CSS styles for table css style layout tool in the TableProperties dialogue.
Public property TemplateManager
Contains the configuration of the TemplateManager dialog.
Public property Code example Text
Gets the text content of the KaxEditor control without the HTML markup.
Public property ToolAdapter
Public property ToolbarMode
Gets or sets the value indicating how the editor toolbar will be rendered and will act on the client
Public property ToolProviderID
Gets or sets a string containing the ID (will search for both server or client ID) of a client object that should be used as a tool provider.
Public property Tools
Public property ToolsFile
Gets or sets a string containing the path to the XML toolbar configuration file.
Public property ToolsWidth
Gets or sets the width of the editor's toolbar (should be used when ToolbarMode != Default).
Public property Width
Gets or sets the width of the Web server control. The default width is 680 pixels.
(Overrides KaxWebControl.Width.)
Top
See Also