neoEdit
WYSIWYG text editor based on Quill editor:
https://quilljs.com
Description
The neoEdit plugin for VisualNEO Web is a WYSIWYG text editor based on the Quill editor, offering customizable text editing capabilities within applications. Here’s a breakdown of its main features:
- Editor Initialization:
- neoEditInitialize: Initializes the editor with common settings in a specified container.
- neoEditInitializeMini and neoEditInitializeFull: These commands initialize the editor with minimal or full editing options, allowing developers to select the level of functionality depending on user needs.
- Text and HTML Content Management:
- neoEditSetText and neoEditGetText: Allow setting and retrieving plain text content in the editor, useful for managing user-generated text data.
- neoEditSetHtml and neoEditGetHtml: These commands set and retrieve HTML content, enabling structured and styled text input/output, making it ideal for applications where HTML-formatted text is necessary.
- Character Limit and Content Length:
- neoEditSetMaxLength: Sets a maximum character count, restricting user input to a defined limit, helpful for form-based applications or text fields with size constraints.
- neoEditGetLength: Retrieves the length of the content within the editor, including handling blank lines, which return a minimum value of 1.
- Change Event Handling:
- neoEditOnChange: Triggers a subroutine whenever the editor content changes, allowing real-time updates or actions based on user input.
The neoEdit plugin is ideal for applications needing interactive and structured text editing capabilities, such as content management systems, blogs, and text-based user interfaces.
neoEditInitialize
Purpose: |
Initialize neoEditor with common options |
Category: |
neoEdit |
Syntax: |
neoEditInitialize "objId"
objId Select a Container object |
neoEditInitializeFull
Purpose: |
Initialize neoEditor with full options |
Category: |
neoEdit |
Syntax: |
neoEditInitializeFull "objId"
objId Select a Container object |
neoEditInitializeMini
Purpose: |
Initialize neoEditor with minimal options |
Category: |
neoEdit |
Syntax: |
neoEditInitializeMini "objId"
objId Select a Container object |
neoEditGetHtml
Purpose: |
Get HTML content |
Category: |
neoEdit |
Syntax: |
neoEditGetHtml "objId" retVar
objId Container object retVar Variable to store result |
neoEditSetHtml
Purpose: |
Set HTML content |
Category: |
neoEdit |
Syntax: |
neoEditSetHtml "objId" theHtml
objId Container object theHtml HTML content |
neoEditGetText
Purpose: |
Get text content |
Category: |
neoEdit |
Syntax: |
neoEditGetText "objId" retVar
objId Container object retVar Variable to store result |
neoEditSetText
Purpose: |
Set text content |
Category: |
neoEdit |
Syntax: |
neoEditSetText "objId" theText
objId Container object theText Text content |
neoEditGetLength
Purpose: |
Retrieves the length of the editor contents. Note even when the editor is empty, there is still a blank line represented by ‘\n’, so getLength will return 1. |
Category: |
neoEdit |
Syntax: |
neoEditGetLength "objId" retVar
objId Container name retVar Variable to store result |
neoEditOnChange
Purpose: |
Execute a subroutine whenever the text content changes within the editor. |
Category: |
neoEdit |
Syntax: |
neoEditOnChange "objId" callBack
objId Container name callBack Callback subroutine |
neoEditSetMaxLength
Purpose: |
Limit the number of characters that can be entered in the editor |
Category: |
neoEdit |
Syntax: |
neoEditSetMaxLength "objId" theMaxLength
objId Container name theMaxLength Max number of characters |
Created with the Personal Edition of HelpNDoc: Generate Kindle eBooks with ease