Class BackgroundColorSettings

Inheritance

System.Object

Syncfusion.EJ2.EJTagHelper

BackgroundColorSettings

Namespace: Syncfusion.EJ2.BlockEditor

Assembly: Syncfusion.EJ2.dll

Syntax

public class BackgroundColorSettings : EJTagHelper

Constructors

BackgroundColorSettings()

Declaration

public BackgroundColorSettings()

Properties

ColorCode

Specifies custom background color codes organized in named groups as key-value pairs. Keys represent color group names (e.g., 'Standard', 'Light', 'Dark'), and values are arrays of hex color codes to display in each group for background highlighting purposes. This allows developers to create branded color palettes with organized background color categories for users to apply emphasis and visual hierarchy to content.

Declaration

public object ColorCode { get; set; }

Property Value

Type	Description
System.Object	The default value is null

Columns

Specifies the number of columns in the background color palette grid layout. This property controls how many color swatches appear per row when using palette mode. Higher values create wider grids with more columns for easier color selection.

Declaration

public double Columns { get; set; }

Property Value

Type	Description
System.Double	The default value is 10

ContentTemplate

To get or set value for ContentTemplate.

Declaration

public MvcTemplate<object> ContentTemplate { get; set; }

Property Value

Type
Syncfusion.EJ2.MvcTemplate<System.Object>

Default

Specifies the default background color to apply when users click the background color button without making a selection. Accepts hex color codes (e.g., '#ffff00' for yellow). This color is used as the initial selected color in the palette for background highlighting.

Declaration

public string Default { get; set; }

Property Value

Type	Description
System.String	The default value is "#ffff00"

Mode

Specifies the background color display mode for the color picker interface. Set to 'Palette' to display a predefined grid of colors, or 'Picker' to display a custom color picker widget for RGB/HEX selection and custom background color creation.

Declaration

public ColorModeType Mode { get; set; }

Property Value

Type	Description
ColorModeType	The default value is ColorModeType.Palette

ModeSwitcher

Specifies whether users can toggle between Palette and Picker modes in the background color interface. Set to true to display a mode switcher button that allows users to switch between predefined background color palettes and custom color picker for maximum flexibility. Set to false to lock the interface to a single mode defined by the mode property.

Declaration

public bool ModeSwitcher { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false