Class BackgroundColorSettingsBuilder
Inheritance
System.Object
Syncfusion.EJ2.ControlBuilder
BackgroundColorSettingsBuilder
Assembly: Syncfusion.EJ2.dll
Syntax
public class BackgroundColorSettingsBuilder : ControlBuilder
Constructors
BackgroundColorSettingsBuilder()
Declaration
public BackgroundColorSettingsBuilder()
BackgroundColorSettingsBuilder(BackgroundColorSettings)
Declaration
public BackgroundColorSettingsBuilder(BackgroundColorSettings model)
Parameters
Methods
ColorCode(Object)
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 BackgroundColorSettingsBuilder ColorCode(object value)
Parameters
| Type |
Name |
Description |
| System.Object |
value |
|
Returns
Columns(Double)
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 BackgroundColorSettingsBuilder Columns(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
Default(String)
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 BackgroundColorSettingsBuilder Default(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
Mode(ColorModeType)
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 BackgroundColorSettingsBuilder Mode(ColorModeType value)
Parameters
Returns
ModeSwitcher(Boolean)
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 BackgroundColorSettingsBuilder ModeSwitcher(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns