KTML 4 API Documentation for ASP .NET

Ktml Members

Ktml overview

Public Instance Constructors

Ktml Constructor Initializes a new instance of the Ktml class.

Public Instance Fields

AutomateTestingMode Set to true when Ktml is in the automate testing environment.
ServiceTestingMode Set to true when testing KtmlServiceProvider.

Public Instance Properties

AccessKey (inherited from WebControl) Gets or sets the access key (underlined letter) that allows you to quickly navigate to the Web server control.
AllowedDocumentTypes Array with the extensions allowed for upload as document files.
AllowedMediaTypes Array with the extensions allowed for upload as media files.
AllowedModuleFilebrowser Sets permissions for running commands on documents and media folders (read files, subfolders) and performing image manipulations (resize, crop, etc).
AllowedModuleSpellchecker Sets permissions for running Spellcheck commands.
AllowedModuleTemplates Sets permissions for running commands on template folders (read files, subfolders) and performing templates operations (save, read).
AllowedModuleXhtml Sets permissions for running Xhtml commands.
Attributes (inherited from WebControl) Gets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control.
AutoFocus Set to true if you want the editor to receive focus when page loads in browser.
AutoPostBack (inherited from TextBox) Gets or sets a value indicating whether an automatic postback to the server will occur whenever the user modifies the text in the TextBox control and then tabs out of the control.
BackColor Property that sets the background color for the editable area of the editor.
BindingContainer (inherited from Control) 
BorderColor (inherited from WebControl) Gets or sets the border color of the Web control.
BorderStyle (inherited from WebControl) Gets or sets the border style of the Web server control.
BorderWidth (inherited from WebControl) Gets or sets the border width of the Web server control.
ClientID (inherited from Control) Gets the server control identifier generated by ASP.NET.
ClientIDToBindTo Similar to ControlToBindTo, it sets Ktml in pluginable mode but it uses an id of a <input type="text"> or <textarea> HTML element.
ColorPickerCallback Sets a javascript function that returns a specific set of colors to be used with color picker.
Columns (inherited from TextBox) Gets or sets the display width of the text box in characters.
ConfigFile Sets the path to the ktml config file used to configuration settings.
Controls (inherited from Control) Gets a ControlCollection object that represents the child controls for a specified server control in the UI hierarchy.
ControlStyle (inherited from WebControl) Gets the style of the Web server control. This property is used primarily by control developers.
ControlStyleCreated (inherited from WebControl) Gets a value indicating whether a Style object has been created for the ControlStyle property. This property is primarily used by control developers.
ControlToBindTo Set this property to use Ktml in the pluginable mode.
ControlToBindTo can be set to any control of type TextBox, HtmlInputText or HtmlTextArea.
CssClass (inherited from WebControl) Gets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client.
CssFile Sets the path to the css file to be used when content is displayed in the editable area.
DebuggerParams Used for javascript debugging only.
DevelopmentMode Set to true when Ktml is used with javascript development files.
DocumentsFolder Sets the folder path used for uploading document files.
DocumentsFolderUrl Sets an url to point to the physical path set by DocumentsFolder. Set this property only if the two properties (DocumentsFolder and DocumentsFolderUrl) have different values.
Enabled (inherited from WebControl) Gets or sets a value indicating whether the Web server control is enabled.
EnableViewState (inherited from Control) Gets or sets a value indicating whether the server control persists its view state, and the view state of any child controls it contains, to the requesting client.
Font (inherited from WebControl) Gets the font properties associated with the Web server control.
ForeColor (inherited from WebControl) Gets or sets the foreground color (typically the color of the text) of the Web server control.
Height Specifies the height of the Ktml Control on the page.
HideFolders Array with the folder names to be hidden in editor's filebrowser.
HyperlinkManagerFile Points to an aspx file that renderes javascript serialized urls to be used with InsertLink button.
ID (inherited from Control) Gets or sets the programmatic identifier assigned to the server control.
IncludesUrl Points to the url that has /includes folder with Ktml required files.
MaximumFileSize The maximum size (in kilobytes) allowed for file upload.
MaxLength (inherited from TextBox) Gets or sets the maximum number of characters allowed in the text box.
MediaFolder Sets the folder path used for uploading media files.
MediaFolderUrl Sets an url to point to the physical path set by MediaFolder. Set this property only if the two properties (MediaFolder and MediaFolderUrl) have different values.
NamingContainer (inherited from Control) Gets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same ID property value.
Page (inherited from Control) Gets a reference to the Page instance that contains the server control.
Parent (inherited from Control) Gets a reference to the server control's parent control in the page control hierarchy.
ReadOnly (inherited from TextBox) Gets or sets a value indicating whether the contents of the TextBox control can be changed.
RenderRichEditor When Ktml is used in standard mode, setting this property to false doesn't render the rich interface in browser, but the default <textarea> element.
Rows (inherited from TextBox) Gets or sets the number of rows displayed in a multiline text box.
SaveCodeAsXhtml When set to true, submitting the form will trigger the transformation of the content using the Xhtml module.
ShowPropertyInspector Controls the display of Property Inspector for the editor in browser.
ShowToolbars Shows how Toolbars are rendered for editor when page loads.
Site (inherited from Control) Gets information about the Web site to which the server control belongs.
StripServerLocation Controls the way links are generated in the edited content. Generated links can start with either http://servername/ or /
Style (inherited from WebControl) Gets a collection of text attributes that will be rendered as a style attribute on the outer tag of the Web server control.
TabIndex (inherited from WebControl) Gets or sets the tab index of the Web server control.
TemplatesFolder Sets the folder path used for saving template files.
TemplateSourceDirectory (inherited from Control) Gets the virtual directory of the Page or UserControl that contains the current server control.
Text Sets or returns the text to display when Ktml is used in standard mode. The default value is an empty string ("").
TextMode (inherited from TextBox) Gets or sets the behavior mode (single-line, multiline, or password) of the TextBox control.
ToolbarPresets Shows which Toolbars are rendered for editor.
Toolbars The collection of toolbars to be rendered by the editor when ToolbarPresets property is set to ToolbarPresets.Custom.
ToolTip (inherited from WebControl) Gets or sets the text displayed when the mouse pointer hovers over the Web server control.
UniqueID (inherited from Control) Gets the unique, hierarchically-qualified identifier for the server control.
ViewCodeAsXhtml When set to true, switching to Source View will trigger the transformation of the content using the Xhtml module.
Visible (inherited from Control) Gets or sets a value that indicates whether a server control is rendered as UI on the page.
Width Specifies the width of the Ktml Control on the page.
Wrap (inherited from TextBox) Gets or sets a value indicating whether the text content wraps within a multiline text box.

Public Instance Methods

ApplyStyle (inherited from WebControl) Copies any nonblank elements of the specified style to the Web control, overwriting any existing style elements of the control. This method is primarily used by control developers.
CopyBaseAttributes (inherited from WebControl) Copies the properties not encapsulated by the Style object from the specified Web server control to the Web server control that this method is called from. This method is used primarily by control developers.
DataBind (inherited from Control) Binds a data source to the invoked server control and all its child controls.
Dispose (inherited from Control) Enables a server control to perform final clean up before it is released from memory.
Equals (inherited from Object) Determines whether the specified Object is equal to the current Object.
FindControl (inherited from Control)Overloaded. Searches the current naming container for a server control with the specified id parameter.
GetHashCode (inherited from Object) Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetType (inherited from Object) Gets the Type of the current instance.
HasControls (inherited from Control) Determines if the server control contains any child controls.
MergeStyle (inherited from WebControl) Copies any nonblank elements of the specified style to the Web control, but will not overwrite any existing style elements of the control. This method is used primarily by control developers.
RenderBeginTag (inherited from WebControl) Renders the HTML opening tag of the control into the specified writer. This method is used primarily by control developers.
RenderControl (inherited from Control) Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled.
RenderEndTag (inherited from WebControl) Renders the HTML closing tag of the control into the specified writer. This method is used primarily by control developers.
ResolveUrl (inherited from Control) Converts a URL into one that is usable on the requesting client.
SetRenderMethodDelegate (inherited from Control) 
ToString (inherited from Object) Returns a String that represents the current Object.

Public Instance Events

DataBinding (inherited from Control) Occurs when the server control binds to a data source.
Disposed (inherited from Control) Occurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested.
Init (inherited from Control) Occurs when the server control is initialized, which is the first step in the its lifecycle.
Load (inherited from Control) Occurs when the server control is loaded into the Page object.
PreRender (inherited from Control) Occurs when the server control is about to render to its containing Page object.
TextChanged (inherited from TextBox) Occurs when the content of the text box changes between posts to the server.
Unload (inherited from Control) Occurs when the server control is unloaded from memory.

Protected Instance Properties

ChildControlsCreated (inherited from Control) Gets a value that indicates whether the server control's child controls have been created.
Context (inherited from Control) Gets the HttpContext object associated with the server control for the current Web request.
Events (inherited from Control) Gets a list of event handler delegates for the control. This property is read-only.
HasChildViewState (inherited from Control) Gets a value indicating whether the current server control's child controls have any saved view-state settings.
IsTrackingViewState (inherited from Control) Gets a value that indicates whether the server control is saving changes to its view state.
TagKey (inherited from TextBox) 
TagName (inherited from WebControl) Gets the name of the control tag. This property is used primarily by control developers.
ViewState (inherited from Control) Gets a dictionary of state information that allows you to save and restore the view state of a server control across multiple requests for the same page.
ViewStateIgnoresCase (inherited from Control) Gets a value that indicates whether the StateBag object is case-insensitive.

Protected Instance Methods

AddAttributesToRender (inherited from TextBox) 
AddParsedSubObject (inherited from TextBox) 
BuildProfileTree (inherited from Control) 
ClearChildViewState (inherited from Control) Deletes the view-state information for all the server control's child controls.
CreateChildControls (inherited from Control) Notifies server controls that use composition-based implementation to create any child controls they contain in preparation for posting back or rendering.
CreateControlCollection (inherited from Control) Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control.
CreateControlStyle (inherited from WebControl) Creates the style object that is used internally by the WebControl class to implement all style related properties. This method is used primarily by control developers.
EnsureChildControls (inherited from Control) Determines whether the server control contains child controls. If it does not, it creates child controls.
Finalize (inherited from Object) Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
FindControl (inherited from Control)Overloaded.  
IsLiteralContent (inherited from Control) Determines if the server control holds only literal content.
LoadViewState (inherited from WebControl) 
MapPathSecure (inherited from Control) Retrieves the physical path that a virtual path, either absolute or relative, maps to.
MemberwiseClone (inherited from Object) Creates a shallow copy of the current Object.
OnBubbleEvent (inherited from Control) Determines whether the event for the server control is passed up the page's UI server control hierarchy.
OnDataBinding (inherited from Control) Raises the DataBinding event.
OnInit (inherited from Control) Raises the Init event.
OnLoad (inherited from Control) Raises the Load event.
OnPreRender Registers javascript include files required by Ktml editor.
OnTextChanged (inherited from TextBox) Raises the TextChanged event. This allows you to handle the event directly.
OnUnload (inherited from Control) Raises the Unload event.
Note    Server controls should perform any final cleanup, such as closing files, closing database connections, and discarding objects, during this stage of the server control lifecycle.
RaiseBubbleEvent (inherited from Control) Assigns any sources of the event and its information to the control's parent.
Render Renders the HTML container for Ktml Editor, when used in standard mode.
RenderChildren (inherited from Control) Outputs the content of a server control's children to a provided HtmlTextWriter object, which writes the content to be rendered on the client.
RenderContents (inherited from WebControl) Renders the contents of the control into the specified writer. This method is used primarily by control developers.
SaveViewState (inherited from WebControl) 
TrackViewState (inherited from WebControl) 

Protected Internal Instance Methods

AddedControl (inherited from Control) Called after a control is added to the Controls collection of another control.
RemovedControl (inherited from Control) Called after a control is removed from the Controls collection of another control.

See Also

Ktml Class | InterAKT.WebControls Namespace