Click or drag to resize
KaxEditor Class
Kettic KaxEditor
Inheritance Hierarchy
SystemObject
  System.Web.UIControl
    System.Web.UI.WebControlsWebControl
      KaxWebControl
        Kettic.AspNet.ControlsKaxEditor

Namespace: Kettic.AspNet.Controls
Assembly: Kettic.AspNet.Controls (in Kettic.AspNet.Controls.dll) Version: 2014.4.1129.0 (2014.04.1129.0)
Syntax
public class KaxEditor : KaxWebControl, ILocalizableControl, 
	IEditableTextControl, ITextControl, INamingContainer

The KaxEditor type exposes the following members.

Constructors
  NameDescription
Public methodKaxEditor
Top
Methods
  NameDescription
Public methodDisableFilter
Removes a specific filter from the ContentFilters.
Public methodEnableFilter
Add a specific filter to the ContentFilters.
Public methodEnsureToolsFileLoaded
Public methodExportToPdf
Public methodExportToRtf
Public methodFindTool
Finds the tool with the given name.
Public methodLoadRtfContent(Stream)
Public methodLoadRtfContent(String)
Public methodLoadToolsFile
Public methodSetPaths
Used to set the file browser configuration paths for the editor dialogs
Top
Properties
  NameDescription
Public propertyAllowScripts 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 propertyAutoResizeHeight
Gets or sets the value indicating whether the KaxEditor will auto-resize its height to match content height
Public propertyCode exampleColors
Gets the collection containing the colors to put in the Foreground and Background color dropdowns.
Public propertyCode exampleContent
Gets or sets the text content of the KaxEditor control inlcuding the HTML markup.
Public propertyContentAreaCssFile
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 propertyContentAreaMode
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 propertyContentFilters
Gets or sets a value indicating which content filters will be active when the editor is loaded in the browser.
Public propertyContextMenus
Public propertyCssClasses
Gets the collection containing the CSS classes to put in the [Apply CSS Class] dropdown.
Public propertyCssFiles
Gets a reference to a EditorCssFileCollection that can be used to add external CSS files in the editor content area.
Public propertyDialogHandlerUrl
Gets or sets the URL which the AJAX call will be made to. Check the help for more information.
Public propertyDialogOpener
A read-only property that returns the DialogOpener instance used in the editor control.
Public propertyDialogsCssFile
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 propertyDialogsScriptFile
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 propertyDocumentManager
Contains the configuration of the DocumentManager dialog.
Public propertyEditModes
Gets or sets the value indicating which will be the available EditModes.
Public propertyEnableAjaxSkinRendering
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 propertyEnableEmbeddedBaseStylesheet
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 propertyEnableEmbeddedScripts
Gets or sets a Boolean value that indicates whether enable the embedded script.
(Overrides KaxWebControl.EnableEmbeddedScripts.)
Public propertyEnableEmbeddedSkins
Gets or sets a Boolean value that indicates whether enable the embedded skin for the control..
(Overrides KaxWebControl.EnableEmbeddedSkins.)
Public propertyEnableResize
Gets or sets the value indicating whether the users will be able to resize the KaxEditor control on the client
Public propertyExportSettings

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

Public propertyExternalDialogsPath
Gets or sets a value indicating where the editor will look for its dialogs.
Public propertyFlashManager
Contains the configuration of the FlashManager dialog.
Public propertyCode exampleFontNames
Gets the collection containing the custom font names to put in the Font dropdown.
Public propertyCode exampleFontSizes
Gets the collection containing the custom font sizes to put in the [Size] dropdown.
Public propertyHeight
Gets or sets the height of the Web server control. The default height is 400 pixels.
(Overrides KaxWebControl.Height.)
Public propertyHtml 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 propertyImageManager
Contains the configuration of the ImageManager dialog.
Public propertyLanguage
Gets or sets a string containing the localization language for the KaxEditor UI
Public propertyCode exampleLanguages
Gets the collection containing the available languages for spellchecking.
Public propertyCode exampleLinks
Gets the collection containing the links to put in the Custom Links dropdown.
Public propertyLocalization
Public propertyLocalizationPath
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 propertyMaxHtmlLength
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 propertyMaxTextLength
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 propertyMediaManager
Contains the configuration of the MediaManager dialog.
Public propertyModules
Public propertyNewLineBr
Gets or sets the value indicating whether the KaxEditor will insert a new line or a paragraph when the [Enter] key is pressed.
Public propertyCode exampleOnClientCommandExecuted
Gets or sets a value indicating the client-side event handler that is called after an editor command was executed.
Public propertyCode exampleOnClientCommandExecuting
Gets or sets a value indicating the client-side event handler that is called before an editor command starts executing.
Public propertyCode exampleOnClientInit
Gets or sets a value indicating the client-side event handler that is called when editor starts to load on the client.
Public propertyCode exampleOnClientLoad
Gets or sets a value indicating the client-side event handler that is called when editor is loaded on the client.
Public propertyCode exampleOnClientModeChange
Gets or sets a value indicating the client-side event handler that is called when the content is submitted.
Public propertyCode exampleOnClientPasteHtml
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 propertyCode exampleOnClientSelectionChange
Gets or sets a value indicating the client-side event handler that is called when selection inside editor content area changes
Public propertyCode exampleOnClientSubmit
Gets or sets a value indicating the client-side event handler that is called when the content is submitted.
Public propertyCode exampleParagraphs
Gets the collection containing the paragraph styles to put in the Paragraph Style dropdown.
Public propertyCode exampleRealFontSizes
Gets the collection containing the custom real font sizes to put in the RealFontSize dropdown.
Public propertySilverlightManager
Contains the configuration of the SilverlightManager dialog.
Public propertySkin
Gets or sets the skin name for the control user interface.
(Overrides KaxWebControl.Skin.)
Public propertySnippets
Gets the collection containing the snippets to put in the Code Snippet dropdown.
Public propertySpellCheckSettings
Contains the configuration of the spell checker.
Public propertyStripFormattingOnPaste Obsolete.
This property is obsolete. Please, use the StripFormattingOptions property instead.
Public propertyStripFormattingOptions
Gets or sets the value indicating how the editor should clear the HTML formatting when the user pastes data into the content area.
Public propertyCode exampleSymbols
Gets the collection containing the symbols to put in the Symbols dropdown.
Public propertyTableLayoutCssFile
Gets or sets a string, containing the location of the CSS styles for table css style layout tool in the TableProperties dialogue.
Public propertyTemplateManager
Contains the configuration of the TemplateManager dialog.
Public propertyCode exampleText
Gets the text content of the KaxEditor control without the HTML markup.
Public propertyToolAdapter
Public propertyToolbarMode
Gets or sets the value indicating how the editor toolbar will be rendered and will act on the client
Public propertyToolProviderID
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 propertyTools
Public propertyToolsFile
Gets or sets a string containing the path to the XML toolbar configuration file.
Public propertyToolsWidth
Gets or sets the width of the editor's toolbar (should be used when ToolbarMode != Default).
Public propertyWidth
Gets or sets the width of the Web server control. The default width is 680 pixels.
(Overrides KaxWebControl.Width.)
Top
Events
  NameDescription
Public eventExportContent
This event is raised before a file is deleted using the current content provider.
Remarks
The file delete will be canceled if you return false from the event handler.
Public eventFileDelete
This event is raised before a file is deleted using the current content provider.
Remarks
The file delete will be canceled if you return false from the event handler.
Public eventFileUpload
This event is raised before the file is stored using the current content provider.
Remarks
The file upload will be canceled if you return false from the event handler.
Public eventTextChanged
Occurs when the content of the KaxEditor changes between posts to the server.
Top
See Also