You’re viewing outdated documentation. View the latest Customer’s Canvas On-Premises documentation.

IRichTextDialogConfigParsed Interface

Applies to: Customer's Canvas On-Premises; Design Editor 4.4.25, 4.x (may differ) · Archived documentation

The dialog providing text formatting options. For details, see the Rich Text Editor topic.

example

configuration = {
    widgets: {
        RichTextDialog: {
            bgColor: "lightgray",
            ckeditorConfig:{
                specialChars: ["&quot;", "&rsquo;", [ "@", "Custom label" ] ]
            },
            fitTextRectangle: {
                onAdd: "shrinkOrStretchToContentHeight",
                onUpdate: "stretchToContentHeight"
            },
            richComboValues: {
                padding: {
                    max: 50,
                    min: 5,
                    step: 5
                }
            },
            textOutline: {
                enabled: true
            },
            toolbarConfig: [
                { name: "clipboard", items: ["Cut", "Copy", "Paste", "-", "Undo", "Redo"] }, "/",
                { name: "basicstyles", items: ["Bold", "Italic", "Underline", "-", "RemoveFormat"] }
            ],
            wysiwygMode: true
        }
    }
};

Properties

Optional applyToAllTextMode

applyToAllTextMode: boolean

Allows you to apply formatting to a whole text field despite a text selection. This text mode is turned off by default.

Optional bgColor

bgColor: string

The text background color in the Rich Text dialog. The default value is "white".

Optional ckeditorConfig

ckeditorConfig: any

An array defining the Special character list. The default list is:

["!", "&quot;", "#", "$", "%", "&amp;", "'", "(", ")", "*", "+", "-", ".", "/",
"0", "1", "2", "3", "4", "5", "6", "7", "8", "9", ":", ";", "&lt;", "=", "&gt;", "?", "@",
"A", "B", "C", "D", "E", "F", "G", "H", "I", "J", "K", "L", "M", "N", "O", "P", "Q", "R","S",
"T", "U", "V", "W", "X", "Y", "Z", "[", "]", "^", "_", "`", "a", "b", "c", "d", "e", "f", "g",
"h", "i", "j", "k", "l", "m", "n", "o", "p", "q", "r", "s", "t", "u", "v", "w", "x", "y", "z",
"{", "|", "}", "~", "&euro;", "&lsquo;", "&rsquo;", "&ldquo;", "&rdquo;", "&ndash;", "&mdash;",
"&iexcl;", "&cent;", "&pound;", "&curren;", "&yen;", "&brvbar;", "&sect;", "&uml;", "&copy;",
"&ordf;", "&laquo;", "&not;", "&reg;", "&macr;", "&deg;", "&sup2;", "&sup3;", "&acute;",
"&micro;", "&para;", "&middot;", "&cedil;", "&sup1;", "&ordm;", "&raquo;", "&frac14;",
"&frac12;", "&frac34;", "&iquest;", "&Agrave;", "&Aacute;", "&Acirc;", "&Atilde;", "&Auml;",
"&Aring;", "&AElig;", "&Ccedil;", "&Egrave;", "&Eacute;", "&Ecirc;", "&Euml;", "&Igrave;",
"&Iacute;", "&Icirc;", "&Iuml;", "&ETH;", "&Ntilde;", "&Ograve;", "&Oacute;", "&Ocirc;",
"&Otilde;", "&Ouml;", "&times;", "&Oslash;", "&Ugrave;", "&Uacute;", "&Ucirc;", "&Uuml;",
"&Yacute;", "&THORN;", "&szlig;", "&agrave;", "&aacute;", "&acirc;", "&atilde;", "&auml;",
"&aring;", "&aelig;", "&ccedil;", "&egrave;", "&eacute;", "&ecirc;", "&euml;", "&igrave;",
"&iacute;", "&icirc;", "&iuml;", "&eth;", "&ntilde;", "&ograve;", "&oacute;", "&ocirc;",
"&otilde;", "&ouml;", "&divide;", "&oslash;", "&ugrave;", "&uacute;", "&ucirc;", "&uuml;",
"&yacute;", "&thorn;", "&yuml;", "&OElig;", "&oelig;", "&#372;", "&#374", "&#373", "&#375;",
"&sbquo;", "&#8219;", "&bdquo;", "&hellip;", "&trade;", "&#9658;", "&bull;", "&rarr;", "&rArr;",
"&hArr;", "&diams;", "&asymp;"]

Optional createMultiColumnText

createMultiColumnText: boolean

Allows for creating multicolumn text. If true, the Columns drop-down list appears in the Top toolbar for formatted text elements. The default value is false.

Optional fitTextRectangle

fitTextRectangle: IFitTextRectangleSettings

Allows for fitting the bounding rectangle to the text size.

Optional richComboValues

richComboValues: IRichComboValuesConfigParsed

An object defining the indent and padding values for the Rich text dialog.

Optional showHint

showHint: IShowHintSettingsParsed

Enables hints in the drop-down lists. By default, the hints are enabled.

Optional showInput

showInput: IShowInputSettings

Enables user input in the drop-down lists. By default, the user input is enabled.

Optional textOutline

textOutline: ITextOutlineParsed

Enables the text outline for low-contrast texts in the Rich Text dialog. The feature is turned off by default.

Optional toolbarConfig

toolbarConfig: ( string | object ) []

An array defining configuration of the toolbar. The default configuration is:

[
    { name: "clipboard", items: ["Cut", "Copy", "Paste", "PasteText", "PasteFromWord", "-", "Undo", "Redo"] },
    { name: "editing", items: ["Find", "Replace", "-", "SelectAll"] },
    { name: "insert", items: ["SpecialChar"] },
    "/",
    { name: "basicstyles", items: ["Bold", "Italic", "Underline", "-", "RemoveFormat"] },
    { name: "styles", items: ["Font", "FontStyle", "FontSize"] },
    { name: "colors", items: ["cc_textcolor_button"] },
    { name: "tracking", items: ["cctracking"] },
    "/",
    { name: "paragraph", items: ["JustifyLeft", "JustifyCenter", "JustifyRight"] },
    { name: "lists", items: ["NumberedList", "BulletedList"] },
    { name: "customerscanvas", items: ["ccleading", "cctextindent"] },
    "/",
    { name: "customerscanvas", items: ["ccpaddingtop", "ccpaddingbottom", "ccpaddingleft", "ccpaddingright"] }
]

Optional wysiwygMode

wysiwygMode: boolean

If true, the editor adjusts the text in the Rich Text dialog to the appearance on the canvas as close as possible. The default value is false.

Optional zoom

zoom: IZoomConfigParsed

A structure containing text zoom configuration.