The attributes below are optional when calling soEditor. Attributes that are new to this release are bold.
|
Attribute |
Default |
Description |
|
align |
true |
Toggles whether to display the align button. |
|
allowAbsoluteImagePath |
false |
Toggles whether or not the image manager should return an absolute url including the domain to the image property window when an image is opened in the image manager. |
|
allowFolderCreation |
true |
Toggles whether to allow image folder creation on the server. |
|
allowFolderDelete |
false |
Toggles whether to allow image folder to be deleted on the server. |
|
allowImageDelete |
false |
Toggles whether to allow image files to be deleted from the server. |
|
allowUpload |
true |
Toggles whether to allow uploading of image files to the server. |
|
anchor |
true |
Toggles whether to display the anchor button. |
|
autoSweep |
false |
Sets whether to automatically sweep the HTML source and remove hideous tags and elements Microsoft Word adds to documents saved as HTML. |
|
baseBGColor |
|
Sets the default background color to be used in soEditor. |
|
baseCSS |
|
Sets the URL pointer to the style sheet to be applied to the editor's content. |
|
baseFont |
|
Sets the default font to be used in soEditor. |
|
baseFontColor |
|
Sets the default font size to be used in soEditor. |
|
baseFontSize |
|
Sets the default font color to be used in soEditor. |
|
baseURL |
|
Sets the base URL used to resolve relative links. |
|
bgColor |
true |
Toggles whether to display the background color button. |
|
bold |
true |
Toggles whether to display the bold button. |
|
borders |
true |
Toggles whether to display the border button. |
|
cellProp |
true |
Toggles whether to display the cell property button. |
|
checkBox |
true |
Toggles whether to display the check box button. |
|
codeSweeper |
true |
Toggles whether to display the code sweeper button. |
|
cols |
60 |
Sets the number of columns to display for the textarea field when the editor is viewed by non-supporting browsers. |
|
copy |
true |
Toggles whether to display the copy button. |
|
cssList |
|
Sets the css documents to be included in the css pull down. |
|
cssListLabels |
|
Sets the labels of the cssList in the respective order. |
|
cut |
true |
Toggles whether to display the cut button. |
|
cssField |
|
The form field name that the selected CSS document is posted as. This can be read by the template declared as the action of the FORM as a typical HTML form field. |
|
delete |
true |
Toggles whether to display the delete button. |
|
deleteCell |
true |
Toggles whether to display the delete cell button. |
|
deleteColumn |
true |
Toggles whether to display the delete column button. |
|
deleteRow |
true |
Toggles whether to display the delete row button. |
|
details |
true |
Toggles whether to display the document details button. |
|
fgColor |
true |
Toggles whether to display the foreground color button. |
|
find |
true |
Toggles whether to display the find button. |
|
font |
true |
Toggles whether to display the font select box. |
|
fontDialog |
true |
Toggles whether to display the font dialog button. |
|
fontList |
Arial, Tahoma, Courier New, Times New Roman, Verdana, Wingdings |
Sets the list of font values to be included in the font pull down. |
|
fontListLabels |
|
Sets the labels of the fontList in the respective order. |
|
format |
true |
Toggles whether to display the format button. |
|
formatList |
none, h1, h2, h3, ,h5, h6, pre |
Sets the format values to be included in the format list pull down. |
|
formatListLabels |
Normal, Heading 1, Heading 2, Heading 3, Heading 4, Heading 5, Heading 6, Formatted |
Sets the labels of the formatList in the respective order. |
|
formButton |
true |
Toggles whether to display the form button. |
|
genericForm |
true |
Toggles whether to display the insert generic form button. |
|
height |
250px |
Sets the height of the editor. This can be a relative measurement such as "75%" or absolute as in "300px". |
|
help |
true |
Toggles whether to display the help button. |
|
hiddenBox |
true |
Toggles whether to display the hidden form field button. |
|
hr |
true |
Toggles whether to display the horizontal rule button. |
|
html |
|
Sets the HTML content to be loaded into the editor to be edited. |
|
htmlEdit |
true |
Toggles whether to display the HTML/Text edit button. |
|
image |
true |
Toggles whether to display the image button. |
|
imagePath |
|
Sets the URL pointer to the desired image directory where soimgkernel.cfm is located. imagePath must include a starting and trailing slash. For example: "/images/" |
|
indent |
true |
Toggles whether to display the indent button. |
|
initialFocus |
false |
Toggles whether or not to give focus to the editor when the page loads. initialFocus can also be used to set focus to another field in the same form. For example: initialFocus="name" would give focus to the name field after loading. |
|
insertCell |
true |
Toggles whether to display the insert cell button. |
|
insertColumn |
true |
Toggles whether to display the insert column button. |
|
insertImageOnUpload |
true |
Toggles whether to have the checkbox on the upload utility that allows an image after being uploaded to be automatically inserted into the editor by default. |
|
insertRow |
true |
Toggles whether to display the insert row button. |
|
italic |
true |
Toggles whether to display the italic button. |
|
link |
true |
Toggles whether to display the link button. |
|
linkList |
|
Sets the href values for a dynamic list of links available from the toolbar. |
|
linkListLabels |
|
Sets the labels of the linkList in the respective order. |
|
list |
true |
Toggles whether to display the list button. |
|
mailForm |
true |
Toggles whether to display the insert mail form button. |
|
mergeCell |
true |
Toggles whether to display the merge cell button. |
|
new |
true |
Toggles whether to display the new button. |
|
openImageFolders |
false |
Toggles whether to open the image folder view by default. |
|
pageEdit |
false |
Sets whether the html being edited includes the HTML, HEAD, and BODY elements. Set this attribute to true if you are editing an entire HTML document. |
|
paste |
true |
Toggles whether to display the paste button. Defaults to true. |
|
radioBox |
true |
Toggles whether to display the radio box button. |
|
redo |
true |
Toggles whether to display the redo button. |
|
resetButton |
true |
Toggles whether to display the reset form button. |
|
rows |
10 |
Sets the number of rows to display for the textarea field when the editor is viewed by non-supporting browsers. |
|
save |
true |
Toggles whether to display the save button. |
|
selectBox |
true |
Toggles whether to display the select box button. |
|
showBorders |
false |
Toggles whether to show table borders by default. |
|
singleSpaced |
false |
When set to true, soEditor will break to the next line when enter is pressed. If set to false, soEditor will treat all breaks as new block elements, thus simulating the double spacing effect. Pressing Shift-Enter will also insert the alterative spacing. |
|
size |
true |
Toggles whether to display the size button. |
|
sizeList |
1,2,3,4,5,6,7 |
Sets the size values to be included in the size list pull down. |
|
sizeListLabels |
1,2,3,4,5,6,7 |
Sets the labels of the sizeList in the respective order. |
|
specialCharacter |
true |
Toggles whether to display the special character button. |
|
spellCheck |
false |
Toggles whether to display the spellcheck button. |
|
splitCell |
true |
Toggles whether to display the split cell button. |
|
styleList |
|
Sets the styles to be included in the style pulldown. |
|
styleListLabels |
|
Sets the labels of the styleList in the respective order. |
|
submitButton |
true |
Toggles whether to display the submit form button. |
|
subScript |
true |
Toggles whether to display the subscript button. |
|
superScript |
true |
Toggles whether to display the superscript button. |
|
tables |
true |
Toggles whether to display the table toolbar. |
|
templatePath |
|
Sets the URL pointer to the desired html template directory. All templates must have a .html extension. In ColdFusion MX the templatePath value can be an absolute path such as "/templates/html/" but in ColdFusion 5 and below this value must be a relative path such as "../templates/html/". In both cases a trailing slash "/" is required. |
|
textArea |
true |
Toggles whether to display the text area button. |
|
textBox |
true |
Toggles whether to display the text box button. |
|
underline |
true |
Toggles whether to display the underline button. |
|
undo |
true |
Toggles whether to display the undo button. |
|
unindent |
true |
Toggles whether to display the unindent button. |
|
unlink |
true |
Toggles whether to display the unlink button. |
|
validateOnSave
|
false |
When set to true soEditor will throw an exception displaying the value of the validationMessage attribute if the editor does not contain any text when the form is submitted. |
|
validationMessage |
"Content is Required" |
Sets the text displayed to the user when trying to submit an empty editor with the validateOnSave attribute set to true. |
|
width |
100% |
Sets the width of the editor. This can be a relative measurement such as "100%" or absolute as in "500px". |
|
wordCount |
true |
Toggles whether the word counter is displayed. |