2022 April Release

Control FSCTEXTEDITOR@1.1001:CTRLTextEditor Permanent link for this heading

This control is used to edit and display formatted text. The current implementation leverages the open source software CKEditor (http://ckeditor.com/).

Example:
layout {
  row {
    CTRLTextEditor MYSWC@200.300:myeditor {
      controloptions = expression {
        dictionary dict = {
          toolbarGroups: "basicstyles,paragraph",
          // allow headings and links
          extraAllowedContent: "h1; h2; h3; h4; a",
          height: "10em"
        };
        return dict;
      }
    }
  }
}
Possible control options are:
  • toolbarGroups (string): Defines which button groups are available to edit the text. Multiple values are separated with ",". Currently available values are:
    • clipboard
    • basicstyles
    • paragraph
  • toolbarGroups (array): Defines which button groups are available to edit the text. This parameter is passed through to CKEditor. [{ name: "/" }] acts as a line break.
    http://docs.ckeditor.com/#!/api/CKEDITOR.config-cfg-toolbarGroups
  • removeButtons (string): List of toolbar button names that must not be rendered. Multiple values are separated with ",".
    http://docs.ckeditor.com/#!/api/CKEDITOR.config-cfg-removeButtons Currently available values are:
    • clipboard
      • Undo
      • Redo
    • basicstyles
      • Bold
      • Italic
      • Underline
      • Strike
      • Subscript
      • Superscript
      • RemoveFormat
    • paragraph
      • NumberedList
      • BulletedList
      • Outdent
      • Indent
      • JustifyLeft
      • JustifyCenter
      • JustifyRight
      • JustifyBlock
  • allowedContent (string): Allowed content rules. Default is defined by the available tools in the toolbar. The value "all" defines all valid HTML. It is possible to reduce the possibilities with disallowedContent.
    http://docs.ckeditor.com/#!/api/CKEDITOR.config-cfg-allowedContent
  • allowColorEditing (boolean): Allows colorbutton-plugin in editor https://ckeditor.com/cke4/addon/colorbutton
  • extraAllowedContent (string): This option makes it possible to set additional allowed content rules.
    http://docs.ckeditor.com/#!/api/CKEDITOR.config-cfg-extraAllowedContent
  • disallowedContent (string): Disallowed content rules. They have precedence over allowed content rules. Default for read only mode is "iframe; style; script; *[on*]".
    http://docs.ckeditor.com/#!/api/CKEDITOR.config-cfg-disallowedContent
  • width (string): Defines the width of the editor area. Default is 100%. If the content exceeds the width of the editor area scrollbars are shown.
  • height (string): Defines the height of the editor area. Default height is defined by the content. If the content exceeds the height of the editor area scrollbars are shown.

FSCTEXTEDITOR@1.1001:CTRLTextEditor()

Additional Information