Interface IRichTextDialogConfig

The dialog providing text formatting options.

Package: IframeApi

Remarks

For details, see the Rich text editor topic.

Examples

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
           },
           toolbarConfig: [
               { name: "clipboard", items: ["Cut", "Copy", "Paste", "-", "Undo", "Redo"] }, "/",
               { name: "basicstyles", items: ["Bold", "Italic", "Underline", "-", "RemoveFormat"] }
           ],
           wysiwygMode: true
       }
   }
};

Properties

applyToAllTextMode

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

Declaration

applyToAllTextMode?: boolean

Property Value

Type	Description
boolean

bgColor

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

Declaration

bgColor?: string

Property Value

Type	Description
string

ckeditorConfig

An array defining the Special character list.

Declaration

ckeditorConfig?: any

Property Value

Type	Description
any

createMultiColumnText

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.

Declaration

createMultiColumnText?: boolean

Property Value

Type	Description
boolean

fitTextRectangle

Allows for fitting the bounding rectangle to the text size.

Declaration

fitTextRectangle?: IFitTextRectangleSettings

Property Value

Type	Description
IFitTextRectangleSettings

richComboValues

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

Declaration

richComboValues?: IRichComboValuesConfig

Property Value

Type	Description
IRichComboValuesConfig

showHint

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

Declaration

showHint?: IShowHintSettings

Property Value

Type	Description
IShowHintSettings

showInput

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

Declaration

showInput?: IShowInputSettings

Property Value

Type	Description
IShowInputSettings

textOutline

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

Declaration

textOutline?: ITextOutline

Property Value

Type	Description
ITextOutline

toolbarConfig

An array defining configuration of the toolbar.

Declaration

toolbarConfig?: Object | string[]

Property Value

Type	Description
Object | string[]

wysiwygMode

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.

Declaration

wysiwygMode?: boolean

Property Value

Type	Description
boolean

zoom

A structure containing text zoom configuration.

Declaration

zoom?: IZoomConfig

Property Value

Type	Description
IZoomConfig