Class ColorPickerProperties
Inherited Members
Namespace: Syncfusion.JavaScript.Models
Assembly: Syncfusion.EJ.dll
Syntax
public class ColorPickerProperties : EJTagHelper
Constructors
ColorPickerProperties()
Initializes a new instance of the ColorPickerProperties class.
Declaration
public ColorPickerProperties()
Properties
ButtonMode
Gets or sets the mode of the color picker button. Mode can be 'dropdown' or 'split' button.
Declaration
[JsonConverter(typeof(StringEnumConverter))]
[JsonProperty("buttonMode")]
public ButtonMode ButtonMode { get; set; }
Property Value
Type | Description |
---|---|
ButtonMode |
Change
Gets or sets a value indicating this event gets fired after color value has been changed successfully.
Declaration
[JsonProperty("change")]
public string Change { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Close
Gets or sets a value indicating this event gets fired after the color picker popup closes.
Declaration
[JsonProperty("close")]
public string Close { get; set; }
Property Value
Type | Description |
---|---|
System.String |
ColorPickerButtonText
Gets or sets a value to customize the 'Apply', 'Cancel', 'Swatches' button text in the color picker popup.
Declaration
[JsonProperty("buttonText")]
public ColorPickerButtonText ColorPickerButtonText { get; set; }
Property Value
Type | Description |
---|---|
ColorPickerButtonText |
ColorPickerTooltipText
Gets or sets a value to customize tooltip text for each button in swatches, add button, last selected color and current color element.
Declaration
[JsonProperty("tooltipText")]
public ColorPickerTooltipText ColorPickerTooltipText { get; set; }
Property Value
Type | Description |
---|---|
ColorPickerTooltipText |
Columns
Gets or sets the number of columns to display the colors in the color palette.
Declaration
[JsonProperty("columns")]
public int Columns { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
Create
Gets or sets a value indicating this event gets fired after color picker is created.
Declaration
[JsonProperty("create")]
public string Create { get; set; }
Property Value
Type | Description |
---|---|
System.String |
CssClass
Gets or sets root CSS class to color picker for theme customization.
Declaration
[JsonProperty("cssClass")]
public string CssClass { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Custom
Gets or sets the custom colors in the palette model. Custom palettes are created by passing a comma delimited string of HEX values or an array of colors.
Declaration
[JsonProperty("custom")]
public List<string> Custom { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<System.String> |
Destroy
Gets or sets a value indicating this event gets fired after color picker control has been destroyed.
Declaration
[JsonProperty("destroy")]
public string Destroy { get; set; }
Property Value
Type | Description |
---|---|
System.String |
DisplayInline
Gets or sets a value indicating colorpicker popup always in visible state or not.
Declaration
[JsonProperty("displayInline")]
public bool DisplayInline { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Enabled
Gets or sets a value indicating whether the control can respond to user interaction.
Declaration
[JsonProperty("enabled")]
public bool Enabled { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
EnableOpacity
Gets or sets a value indicating the opacity slider to be shown or not.
Declaration
[JsonProperty("enableOpacity")]
public bool EnableOpacity { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
HtmlAttributes
Gets or sets the value to map the field of HTML attributes.
Declaration
[JsonProperty("htmlAttributes")]
public IDictionary<string, object> HtmlAttributes { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IDictionary<System.String, System.Object> |
Locale
Gets or sets the culture to display the colorpicker in the specified culture.
Declaration
[JsonProperty("locale")]
public string Locale { get; set; }
Property Value
Type | Description |
---|---|
System.String |
ModelType
Gets or sets the model type of the color picker popup. Model type can be 'picker' or 'palette'.
Declaration
[JsonProperty("modelType")]
[JsonConverter(typeof(StringEnumConverter))]
public ModelType ModelType { get; set; }
Property Value
Type | Description |
---|---|
ModelType |
OpacityValue
Gets or sets the opacity value of the selected color.
Declaration
[JsonProperty("opacityValue")]
public int OpacityValue { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
Open
Gets or sets a value indicating this event gets fired after the color picker popup opens.
Declaration
[JsonProperty("open")]
public string Open { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Palette
Gets or sets the palette type to be displayed in the popup. Palette type can be 'basicpalette' or 'custompalette'. This property applicable if 'model type' set as 'palette'.
Declaration
[JsonProperty("palette")]
[JsonConverter(typeof(StringEnumConverter))]
public PaletteType Palette { get; set; }
Property Value
Type | Description |
---|---|
PaletteType |
PresetType
Gets or sets the preset type of the palette among 12 different types. Each presets have 50 colors. This property applicable if 'model type' set as 'palette'.
Declaration
[JsonConverter(typeof(StringEnumConverter))]
[JsonProperty("presetType")]
public PresetsType PresetType { get; set; }
Property Value
Type | Description |
---|---|
PresetsType |
Select
Gets or sets a value indicating this event gets fired after color value has been selected successfully.
Declaration
[JsonProperty("select")]
public string Select { get; set; }
Property Value
Type | Description |
---|---|
System.String |
ShowApplyCancel
Gets or sets a value to show/hide the 'Apply' and 'Cancel' buttons in color picker popup.
Declaration
[JsonProperty("showApplyCancel")]
public bool ShowApplyCancel { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
ShowClearButton
Gets or sets a value to show or hide the close button in the rgba field of the color picker popup.
Declaration
[JsonProperty("showClearButton")]
public bool ShowClearButton { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
ShowPreview
Gets or sets a value indicating the live preview support for current cursor selection color and selected color.
Declaration
[JsonProperty("showPreview")]
public bool ShowPreview { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
ShowRecentColors
Gets or sets a value indicating the recent colors to be shown or not.
Declaration
[JsonProperty("showRecentColors")]
public bool ShowRecentColors { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
ShowSwitcher
Gets or sets a value to show or hide switcher button in color picker popup.
Declaration
[JsonProperty("showSwitcher")]
public bool ShowSwitcher { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
ShowTooltip
Gets or sets a value to show or hide the tooltip to notify the slider value.
Declaration
[JsonProperty("showTooltip")]
public bool ShowTooltip { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
TagName
Gets or sets the name of the tag.
Declaration
[JsonProperty("tagName")]
public string TagName { get; set; }
Property Value
Type | Description |
---|---|
System.String |
ToolIcon
Gets or sets the tool icon to be displayed in dropdown control color area.
Declaration
[JsonProperty("toolIcon")]
public string ToolIcon { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Value
Gets or sets the color value in hexadecimal prefixed with '#'.
Declaration
[JsonProperty("value")]
public string Value { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Methods
GetControlDetails()
Declaration
protected override object GetControlDetails()
Returns
Type | Description |
---|---|
System.Object |
Overrides
ShouldSerializeColorPickerButtonText()
Should serialize method for ColorPickerButtonText
Declaration
public bool ShouldSerializeColorPickerButtonText()
Returns
Type | Description |
---|---|
System.Boolean |