HTML Rich Text Area


	Home
	Requirements
	Whats New
	Features
	Architechure
	Security
	License Agreement


	Evaluation


	Deployment


	Using
	Interface
	ASP
	Submitting
	Customization
	Settings
	Programming
	DB Integration
	Image Library
	Custom Buttons
	Presentation


	Contact Us

Programming

The HTML Rich Text Area provides many functions that can be called from your javascript.

Function	Description
Draw	Displays the HTML Rich Text Area
DrawReadOnly	Displays the HTML Rich Text Area in a read only format. Call [HTMLRTAObject].MakeReadOnly(false) from javascript to make it read/write.
MakeReadOnly(blnReadOnly)	MakeReadOnly makes the HTML Rich Text Area read only if the parameter is set to true and read-write if it is set to false. This is useful for web pages that are part of some database driven web application in which the user may not have permission to edit the information.
GetHTML	GetHTML returns the HTML that is currently being edited in the HTML Rich Text Area.
SetHTML(strHTML)	SetHTML sets the HTML at run time.
InsertHTML(strHTML)	Inserts the HTML at the current insertion point
SetHeight(intHeightPx)	Modifies the height of the HTML Rich Text.
WrapHTMLParent(strOpenTag, strCloseTag)	Wraps the selected text's parent with the specified opening and closing tags.
WrapHTMLSelection(strOpenTag, strCloseTag)	Wraps the selected text with the specified opening and closing tags.
EVENTCATCHER	In the settings file change the EVENTCATCHER constant to receive a call back whenever the text changes in the HTML Rich Text Area.
EVENTHTMLRTALOADED	In the settings file change the EVENTHTMLRTALOADED constant to receive a call back when the HTML RTA is loaded.
EVENTONKEYUP	In the settings file change the EVENTONKEYUP constant to receive a call back a key up event is raised.
EVENTONKEYDOWN	In the settings file change the EVENTONKEYDOWN constant to receive a call back a key down event is raised.
EVENTFOCUSIN	In the settings file change the EVENTFOCUSIN constant to receive a call back when the HTML RTA receives the focus.
EVENTFOCUSOUT	In the settings file change the EVENTFOCUSOUT constant to receive a call back when the HTML RTA loses the focus.

These functions need a reference to the HTML Rich Text Area object to work. You get this reference by declaring the HTML Rich Text Area in the following manner:

An example of the code is seen below.

<form method='post' action='Submit.asp' name='Details'>
<p align='center'>
<script LANGUAGE="javascript" SRC="../../inc/HTMLRichTextArea.js" ></script>
<script LANGUAGE="javascript" SRC="../../inc/HTMLRichTextAreaFactorySettings.js" ></script>
<script LANGUAGE="javascript">
	<!--
		var strDefaultHTML = "<h1>Test</h1>";
		var myHTMLRTA = new HTMLRichTextArea("details",85,200,strDefaultHTML);
		myHTMLRTA.Draw();
	
		document.write("<br><br>")
		
		var strDefaultHTML = "<h1>Test</h1>";
		var myHTMLRTA2 = new HTMLRichTextArea("details2",85,200,strDefaultHTML);
		myHTMLRTA2.DrawReadOnly();

var blnReadOnly = false;
		function ToggleReadOnly()
		{
			blnReadOnly = !blnReadOnly;
			myHTMLRTA.MakeReadOnly(blnReadOnly);
			myHTMLRTA2.MakeReadOnly(!blnReadOnly);
		}

function GetHTML()
		{
			alert(myHTMLRTA.GetHTML()); 
		}

function SetHTML()
		{
			myHTMLRTA.SetHTML('<h1>Set the HTML to whatever you want at run time</h1>'); 
		}

function InsertHTML()
		{
			myHTMLRTA.InsertHTML("<font color='red'>HTML inserted at the cursor</font>"); 
		}

function SetHeight()
		{
			myHTMLRTA.SetHeight(Details.HeightUI.value);
		}

function WrapHTMLParent()
		{
			myHTMLRTA.WrapHTMLParent("<code>","</code>");
		}

function WrapHTMLSelection()
		{
			myHTMLRTA.WrapHTMLSelection("<code>","</code>");
		}
	//-->
</script>
</p>

<p align='center'>
<input type='button' onclick='ToggleReadOnly();' value='Toggle read only state' id='button'1 name='button'1>
<input type='button' onclick='GetHTML();' value='Get HTML' id='button'1 name='button'1>
<input type='button' onclick='SetHTML();' value='Set HTML' id='button'1 name='button'1>
<input type='button' onclick='InsertHTML();' value='Insert HTML at the cursor' id='button'1 name='button'1><br><br>
Set the height of the first HTML Rich Text Area: <input type='text' id='HeightUI' value='400'><input type='button' value='Set Height' onclick='SetHeight()' id='button'1 name='button'1>
</p>

This results in the following: