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

Ui Module

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

Widget configuration interfaces

Modules

Name	Description
IAssetManagerConfig	A structure defining tabs of the Asset Manager.
IAssetSources	A structure defining sources for the Asset Manager. For details, see The Asset Manager topic.
IToolboxConfigParsed	A structure defining the configuration of the Toolbox (former Left toolbar). For details, see the Customizing the Toolbox topic.

Enumerations

Name	Description
AssetSelectWidgetType	Widgets allowing your users to select assets. You can enable either the Asset Manager or Gallery Dialog.

Interfaces

Name	Description
IActionModeParsed	A structure defining how the Image Gallery should import SVG, PDF, and PSD graphics.
IAutoZoomConfigParsed	A structure containing auto-zoom configuration of the Rich text editor.
IBarcodeDialogConfigParsed	A structure containing the configuration of the Barcode dialog.
IBottomToolbarConfigParsed	A structure containing the configuration of the Bottom toolbar.
IColorPickerConfigParsed	The color picker providing color selection in the editor. For details, see the Colors topic.
ICommonConfigParsed	A structure for common settings of widgets.
IFinishButtonConfigParsed	The configuration of the Finish design button.
IFitTextRectangleSettings	A structure defining when and how the editor fits bounding rectangles to rich formatted text.
IGalleryDialogConfigParsed	A structure defining settings of the Image Gallery. For details, refer to the Using the Image Gallery topic.
IImageEditorDialogConfigParsed	A structure defining settings of the Image editor dialog.
IItemMenuConfigParsed	A structure defining settings of the Item menu.
ILeftToolbarConfigParsed	A structure containing the configuration of the Left toolbar.
IObjectInspectorConfigParsed	A structure containing the configuration of the Object inspector.
IPerSurfaceConfiguration	A configuration of widgets, that is defined for separate surfaces. For an example, you can refer to the Customizing Widgets on a Per-page Basis topic.
IRangeParamsParsed	A structure defining a range of values.
IRichComboValuesConfigParsed	An object defining the indent and padding values for the Rich Text editor.
IRichTextDialogConfigParsed	The dialog providing text formatting options. For details, see the Rich Text Editor topic.
IShowHintSettingsParsed	The settings enabling hints for drop-down lists in the toolbar of the Rich Text editor. These hints are turned on by default.
IShowInputSettings	The settings enabling the user input for drop-down lists in the toolbar of the Rich Text editor. The user input is turned on by default.
ISocialNetworkAppIdsParsed	The Instagram and/or Facebook identifiers for your application. For details, see the Integration with Facebook and Instagram topic.
ISurfaceSwitchConfigParsed	A structure defining the configuration of the navigation area in the Bottom toolbar.
ITabDescriptorParsed	A structure defining tubs of the Image Gallery.
ITextOutlineParsed	The text outline for low-contrast texts in the Rich Text editor. This feature is turned off by default.
ITextShadowParamParsed	A structure defining a range of values.
ITopToolbarConfigParsed	A structure containing the configuration of the Top toolbar.
IWidgetConfigsForSurface	A structure defining the configuration of widgets for a separate surface.
IWidgetsConfig	The configuration of the editor widgets. For details, see the Customizing the User Interface topic.
IZOrderConfigParsed	A structure containing the configuration of the z-order control.
IZoomConfigParsed	A structure containing text zoom configuration of the Rich text editor.

Type aliases

TextRectangleFitMode