IRichTextDialogConfig Interface

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

example
configuration = {
    widgets: {
        RichTextDialog: {
            bgColor: "lightgray",
            ckeditorConfig:{
                specialChars: [""", "’", [ "@", "Custom label" ] ]
            },
            fitTextRectangle: {
                onAdd: "shrinkOrStretchToContentHeight",
                onUpdate: "stretchToContentHeight"
            },
            richComboValues: {
                padding: {
                    max: 50,
                    min: 5,
                    step: 5
                }
            },
            textOutline: {
                enabled: true
            },
            wysiwygMode: true
        }
    }
};

Properties

Optional applyToAllTextMode

applyToAllTextMode: boolean

Allows you to apply formatting to a whole rich 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:

["!", """, "#", "$", "%", "&", "'", "(", ")", "*", "+", "-", ".", "/",
"0", "1", "2", "3", "4", "5", "6", "7", "8", "9", ":", ";", "<", "=", ">", "?", "@",
"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",
"{", "|", "}", "~", "€", "‘", "’", "“", "”", "–", "—",
"¡", "¢", "£", "¤", "¥", "¦", "§", "¨", "©",
"ª", "«", "¬", "®", "¯", "°", "²", "³", "´",
"µ", "¶", "·", "¸", "¹", "º", "»", "¼",
"½", "¾", "¿", "À", "Á", "Â", "Ã", "Ä",
"Å", "Æ", "Ç", "È", "É", "Ê", "Ë", "Ì",
"Í", "Î", "Ï", "Ð", "Ñ", "Ò", "Ó", "Ô",
"Õ", "Ö", "×", "Ø", "Ù", "Ú", "Û", "Ü",
"Ý", "Þ", "ß", "à", "á", "â", "ã", "ä",
"å", "æ", "ç", "è", "é", "ê", "ë", "ì",
"í", "î", "ï", "ð", "ñ", "ò", "ó", "ô",
"õ", "ö", "÷", "ø", "ù", "ú", "û", "ü",
"ý", "þ", "ÿ", "Œ", "œ", "Ŵ", "&#374", "&#373", "ŷ",
"‚", "‛", "„", "…", "™", "►", "•", "→", "⇒",
"⇔", "♦", "≈"]

Optional createMultiColumnText

createMultiColumnText: boolean

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

Optional fitTextRectangle

fitTextRectangle: IFitTextRectangleSettings

Allows for fitting the bounding rectangle to the text size.

Optional richComboValues

richComboValues: IRichComboValuesConfig

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

Optional showHint

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: ITextOutline

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

A structure defining configuration of rich text toolbar.

Optional wysiwygMode

wysiwygMode: boolean

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

Optional zoom

A structure containing text zoom configuration.