Example applications

To learn how to use soEditor in your applications, we recommend studying the example applications that are included in the soEditor installation file.  These applications contain simple real-world examples of using soEditor in your applications.  In order to provide a solid understanding of how to use soEditor, we have also included the ability to view source code within each example.  To view the examples, browse to:

http://{www.yoursite.com}/siteobjects/soeditor/pro/examples/default.asp

(you may have to change this url if soEditor was not installed in the default directory)

Using the image manager
soEditor supports a drive based image manager.  With this utility users have the ability to create and upload images organized in folders.  Pass the directory path to soEditor using the imagePath property.

Using templates
soEditor allows you to access html templates (.html extensions) with the templatePath property. soEditor will read in the template files from this directory and display them for use within the content of the editor.

Style sheet functions
soEditor supports the use of a base style sheet and style sheet document linking and style setting.  There are some important things to keep in mind when using these features.

• When using the baseCSS property and pageEdit is set to false, you must include the CSS LINK reference when displaying the HTML outside of soEditor.  soEditor will not link to the value of the baseCSS, it is up to your application to do so.

• The styles passed using the styleList property must reference valid class styles set in the active style sheet. The active style sheet is the value of the baseCSS property or the selected style sheet from the styleList .

• When dealing with multiple style sheets and multiple styles, soEditor will not validate if a certain style is defined in the active style sheet.  Name the styles accordingly using the styleListLabels property or have all styles defined in each style sheet.

Spellchecking support
soEditor Pro currently supports spellchecking by integrating the Spellchecker.net service into the tag.  An account with Spellchecker.net is no longer required with this release.  Enable spellchecking in soEditor by setting the spellCheck property to "true".

Extending soEditor
soEditor also provides features to allow developers to extend the functionality to include insertion of specific html blocks through the insertText method of the soEditor control.  By calling method with JavaScript one can insert specific text or HTML into the document being created or edited.  This feature can be used to create new functionality based on the soEditor control. With source versions of soEditor, custom buttons and toolbars can be created using this functionality.

soEditorFieldName.insertText(sStart, sEnd, asHTML, bAllowEmpty);

sStart  String to be inserted before the start of the current selection.

sEnd  String to be inserted after the end of the current selection.

asHTML  Boolean variable indicating if the text should be inserted as rendered HTML or as Plain text.

bAllowEmpty  Boolean variable indicating if the text can be inserted without a selection being made.

* FieldName is the name of the field attribute specified when calling soEditor