Class RibbonColorPickerSettingsBuilder
Inheritance
System.Object
Syncfusion.EJ2.ControlBuilder
RibbonColorPickerSettingsBuilder
Assembly: Syncfusion.EJ2.dll
Syntax
public class RibbonColorPickerSettingsBuilder : ControlBuilder
Constructors
RibbonColorPickerSettingsBuilder()
Declaration
public RibbonColorPickerSettingsBuilder()
RibbonColorPickerSettingsBuilder(RibbonColorPickerSettings)
Declaration
public RibbonColorPickerSettingsBuilder(RibbonColorPickerSettings model)
Parameters
Methods
BeforeClose(String)
Event triggers before closing the ColorPicker popup.
Declaration
public RibbonColorPickerSettingsBuilder BeforeClose(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
BeforeOpen(String)
Event triggers before opening the ColorPicker popup.
Declaration
public RibbonColorPickerSettingsBuilder BeforeOpen(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
BeforeTileRender(String)
Event triggers while rendering each palette tile.
Declaration
public RibbonColorPickerSettingsBuilder BeforeTileRender(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
Change(String)
Event triggers while changing the colors. It will be triggered based on the showButtons property.
If the property is false, the event will be triggered while selecting the colors.
If the property is true, the event will be triggered while apply the selected color.
Declaration
public RibbonColorPickerSettingsBuilder Change(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
Columns(Double)
Defines the number of columns to be rendered in the color picker palette.
Declaration
public RibbonColorPickerSettingsBuilder Columns(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
Created(String)
Event triggers once the color picker is created.
Declaration
public RibbonColorPickerSettingsBuilder Created(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
CssClass(String)
Defines one or more CSS classes to customize the appearance of the color picker.
Declaration
public RibbonColorPickerSettingsBuilder CssClass(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
EnableOpacity(Boolean)
Defines whether to enable the opacity option in the color picker.
Declaration
public RibbonColorPickerSettingsBuilder EnableOpacity(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
HtmlAttributes(Object)
Specifies additional HTML attributes to be applied to the color picker.
Declaration
public RibbonColorPickerSettingsBuilder HtmlAttributes(object value)
Parameters
| Type |
Name |
Description |
| System.Object |
value |
|
Returns
Label(String)
Specifies the label text for the overflow item.
Declaration
public RibbonColorPickerSettingsBuilder Label(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
Mode(Object)
Defines the rendering mode of the color picker.
Declaration
public RibbonColorPickerSettingsBuilder Mode(object value)
Parameters
| Type |
Name |
Description |
| System.Object |
value |
|
Returns
ModeSwitcher(Boolean)
Defines whether to show / hide the mode switcher button in the color picker.
Declaration
public RibbonColorPickerSettingsBuilder ModeSwitcher(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
NoColor(Boolean)
Defines whether to enable / disable the palette section in the color picker.
Declaration
public RibbonColorPickerSettingsBuilder NoColor(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
Open(String)
Event triggers while opening the ColorPicker popup.
Declaration
public RibbonColorPickerSettingsBuilder Open(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
PresetColors(Object)
Defines the custom colors to load in the color picker palette.
Declaration
public RibbonColorPickerSettingsBuilder PresetColors(object value)
Parameters
| Type |
Name |
Description |
| System.Object |
value |
|
Returns
Select(String)
Event triggers while selecting the color in picker / palette, when showButtons property is enabled.
Declaration
public RibbonColorPickerSettingsBuilder Select(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
Defines whether to show / hide the control buttons (apply / cancel) in the color picker.
Declaration
public RibbonColorPickerSettingsBuilder ShowButtons(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
Value(String)
Specifies the value of the color picker.
The value should be a valid hex color code.
Declaration
public RibbonColorPickerSettingsBuilder Value(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
