---
title: "IBgButton Interface"
canonical: https://customerscanvas.com/docs/cc6/customerscanvas.baseeditor.configuration.ui.itoolboxconfigparsed.ibgbutton.htm
archived: true
applies_to:
  - product: "Customer's Canvas On-Premises"
  - product: "Design Editor"
    versions: ["6.15.0", "6.x (may differ)"]
---

**You’re viewing outdated documentation.** [View the latest Customer’s Canvas On-Premises documentation](https://customerscanvas.com/docs/on-premises/).

# IBgButton Interface

**Applies to:** Customer's Canvas On-Premises; Design Editor 6.15.0, 6.x (may differ) · **Archived documentation**
 
A structure defining configuration of the Toolbox for customizing the background layer.
  
 - example
     - ```
"Toolbox": {
    "buttons": [
        {
            "translationKey": "Toolbox.CHANGE_BACKGROUND",
            "translationKeyTitle": "Toolbox.TITLE_CHANGE_BACKGROUND",
            "iconClass": "cc-icon-background",
            "action": "Background",
            "onlyImage": false
        }
    ]
}
```
 
## Properties
 
### action
 
action: [ButtonAction](https://customerscanvas.com/docs/cc6/customerscanvas.baseeditor.configuration.ui.itoolboxconfigparsed.htm.md)

Inherited from [ISingleButton](https://customerscanvas.com/docs/cc6/customerscanvas.baseeditor.configuration.ui.itoolboxconfigparsed.isinglebutton.htm.md).[action](https://customerscanvas.com/docs/cc6/customerscanvas.baseeditor.configuration.ui.itoolboxconfigparsed.isinglebutton.htm.md)

The action that the button performs. You can define the Toolbox by using the actions alone.
 
### Optional iconClass
 
iconClass: string

Inherited from [IItem](https://customerscanvas.com/docs/cc6/customerscanvas.baseeditor.configuration.ui.itoolboxconfigparsed.iitem.htm.md).[iconClass](https://customerscanvas.com/docs/cc6/customerscanvas.baseeditor.configuration.ui.itoolboxconfigparsed.iitem.htm.md)

The class of the button icon. You can find the complete list of available icon classes in `\src\design-editor\Styles\ControlStyles\sp-icons.less`.
 
### Optional itemConfig
 
itemConfig: [ITextConfig](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.defaultconfig.itextconfig.htm.md)  |  [IImageItemDefaultConfig](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.defaultconfig.iimageitemdefaultconfig.htm.md)  |  [IBarcodeDefaultConfig](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.defaultconfig.ibarcodedefaultconfig.htm.md)

Inherited from [IItem](https://customerscanvas.com/docs/cc6/customerscanvas.baseeditor.configuration.ui.itoolboxconfigparsed.iitem.htm.md).[itemConfig](https://customerscanvas.com/docs/cc6/customerscanvas.baseeditor.configuration.ui.itoolboxconfigparsed.iitem.htm.md)

A structure containing the configuration of new design elements. For an example, you can refer to [ILocationDefaultConfig](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.defaultconfig.ilocationdefaultconfig.htm.md) or [IBarcodeDefaultConfig](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.defaultconfig.ibarcodedefaultconfig.htm.md).
 
### Optional nameDialogEnabled
 
nameDialogEnabled: boolean

Inherited from [IItem](https://customerscanvas.com/docs/cc6/customerscanvas.baseeditor.configuration.ui.itoolboxconfigparsed.iitem.htm.md).[nameDialogEnabled](https://customerscanvas.com/docs/cc6/customerscanvas.baseeditor.configuration.ui.itoolboxconfigparsed.iitem.htm.md)

Enables a dialog box to type in the name of a new design element. The default value is `false`.
 
### Optional onlyImage
 
onlyImage: boolean

If `false`, allows users to select an image in the Asset Manager or a color in the picker. By default, this property is `true`, and users can only select an image.
 
### Optional translationKey
 
translationKey: string

Inherited from [IItem](https://customerscanvas.com/docs/cc6/customerscanvas.baseeditor.configuration.ui.itoolboxconfigparsed.iitem.htm.md).[translationKey](https://customerscanvas.com/docs/cc6/customerscanvas.baseeditor.configuration.ui.itoolboxconfigparsed.iitem.htm.md)

The translation key of the button caption. The corresponding string should be defined in the `~\Configuration\translations.json` file.
 
### Optional translationKeyTitle
 
translationKeyTitle: string

Inherited from [IItem](https://customerscanvas.com/docs/cc6/customerscanvas.baseeditor.configuration.ui.itoolboxconfigparsed.iitem.htm.md).[translationKeyTitle](https://customerscanvas.com/docs/cc6/customerscanvas.baseeditor.configuration.ui.itoolboxconfigparsed.iitem.htm.md)

The translation key of the button tooltip. The corresponding string should be defined in the `~\Configuration\translations.json` file.