WinForms

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class ColorPickerButton - WindowsForms API Reference | Syncfusion

    Show / Hide Table of Contents

    Class ColorPickerButton

    Implements a drop-down button control for selecting colors.

    Inheritance
    System.Object
    ButtonAdv
    ColorPickerButton
    Implements
    IThemeProvider
    IVisualStyle
    ISupportOffice2007Theme
    ISupportThemeChanged
    System.Windows.Forms.IMessageFilter
    Inherited Members
    ButtonAdv.isLastLeftButton
    ButtonAdv.isFirstRightButton
    ButtonAdv.GetActiveThemeName()
    ButtonAdv.PaintButton(Graphics, ButtonAdv, Point)
    ButtonAdv.ShouldSerializeMetroColor()
    ButtonAdv.ResetMetroColor()
    ButtonAdv.ApplyScaleToControl(Single)
    ButtonAdv.ResetIsDropDownButton()
    ButtonAdv.ShouldSerializaIsDropDownButton()
    ButtonAdv.ShouldSerializeIsDropDownButton()
    ButtonAdv.OnPaint(PaintEventArgs)
    ButtonAdv.SetIgnoreMouse(Boolean)
    ButtonAdv.SuspendMouseState()
    ButtonAdv.ResumeMouseState()
    ButtonAdv.SetIsLastLeftButton(Boolean)
    ButtonAdv.SetIsFirstRightButton(Boolean)
    ButtonAdv.GetIsLastLeftButton()
    ButtonAdv.GetIsFirstRightButton()
    ButtonAdv.OnSystemColorsChanged(EventArgs)
    ButtonAdv.OnSizeChanged(EventArgs)
    ButtonAdv.OnButtonChanged(EventArgs)
    ButtonAdv.OnMouseEnter(EventArgs)
    ButtonAdv.OnMouseLeave(EventArgs)
    ButtonAdv.OnLostFocus(EventArgs)
    ButtonAdv.OnMouseDown(MouseEventArgs)
    ButtonAdv.OnMouseMove(MouseEventArgs)
    ButtonAdv.OnMouseUp(MouseEventArgs)
    ButtonAdv.OnHandleCreated(EventArgs)
    ButtonAdv.OnHandleDestroyed(EventArgs)
    ButtonAdv.OnKeyUp(KeyEventArgs)
    ButtonAdv.ResetUseVisualStyle()
    ButtonAdv.ShouldSerializeUseVisualStyle()
    ButtonAdv.ResetComboEditBackColor()
    ButtonAdv.ShouldSerializeComboEditBackColor()
    ButtonAdv.ResetForeColor()
    ButtonAdv.ShouldSerializeForeColor()
    ButtonAdv.ResetBackColor()
    ButtonAdv.ShouldSerializeBackColor()
    ButtonAdv.RaisePaintEvent(PaintEventArgs)
    ButtonAdv.ISupportOffice2007Theme.EnableOffice2007Style()
    ButtonAdv.ISupportThemeChanged.ThemeChanged(Object, EventArgs)
    ButtonAdv.CanApplyTheme
    ButtonAdv.ThemeName
    ButtonAdv.CanOverrideStyle
    ButtonAdv.IThemeProvider.BaseThemeName
    ButtonAdv.IsVisualStyleEnabled
    ButtonAdv.ThemeStyle
    ButtonAdv.IThemeProvider.ControlName
    ButtonAdv.IVisualStyle.VisualTheme
    ButtonAdv.Office2007ColorScheme
    ButtonAdv.Office2010ColorScheme
    ButtonAdv.BorderStyleAdv
    ButtonAdv.KeepFocusRectangle
    ButtonAdv.Appearance
    ButtonAdv.MetroColor
    ButtonAdv.ForeColor
    ButtonAdv.BackColor
    ButtonAdv.ImageListAdv
    ButtonAdv.CustomManagedColor
    ButtonAdv.OverrideFormManagedColor
    ButtonAdv.UseVisualStyle
    ButtonAdv.ButtonType
    ButtonAdv.Text
    ButtonAdv.State
    ButtonAdv.PushButton
    ButtonAdv.ResetStateOnLostFocus
    ButtonAdv.IsMouseDown
    ButtonAdv.IsComboButton
    ButtonAdv.ComboEditBackColor
    ButtonAdv.IsBackStageButton
    ButtonAdv.IsDropDownButton
    ButtonAdv.BeforeTouchSize
    ButtonAdv.ISupportOffice2007Theme.Office2007ColorTheme
    ButtonAdv.ThemeNameChanged
    ButtonAdv.ButtonChanged
    Namespace: Syncfusion.Windows.Forms
    Assembly: Syncfusion.Shared.Base.dll
    Syntax
    public class ColorPickerButton : ButtonAdv, IThemeProvider, IVisualStyle, ISupportOffice2007Theme, ISupportThemeChanged, IMessageFilter
    Remarks

    The ColorPickerButton class is a button-type control that pops-up an instance of the Syncfusion ColorUIControl when clicked. This class derives from the Windows Forms Button class and hence can be used in place of a regular button control. The ColorPickerButton's ColorUIControl component can be accessed through the ColorUI property. ColorUIControl

    Constructors

    ColorPickerButton()

    Creates a new instance of the ColorPickerButton class.

    Declaration
    public ColorPickerButton()

    Properties

    ColorGroups

    Gets or sets the tab associated with this colorgroup in the drop-down ColorUIControl.

    Declaration
    public ColorUIGroups ColorGroups { get; set; }
    Property Value
    Type Description
    ColorUIGroups

    A ColorUIGroups value. The default is ColorUIGroups.All.

    ColorUI

    Gets a reference to the drop-down ColorUIControl.

    Declaration
    public ColorUIControl ColorUI { get; }
    Property Value
    Type Description
    ColorUIControl

    A reference to the ColorUIControl instance.

    ColorUISize

    Gets or sets the size of the drop-down ColorUIControl.

    Declaration
    public Size ColorUISize { get; set; }
    Property Value
    Type Description
    System.Drawing.Size

    A Size value.

    CustomTabName

    Gets or sets the text displayed on the drop-down ColorUIControl's custom colors tab.

    Declaration
    public string CustomTabName { get; set; }
    Property Value
    Type Description
    System.String

    A String value.

    DropDownContainer

    Gets a reference to the PopupControlContainer that will contain the ColorUIControl.

    Declaration
    public PopupControlContainer DropDownContainer { get; }
    Property Value
    Type Description
    PopupControlContainer

    A reference to the PopupControlContainer instance.

    DroppedDown

    Gets or sets the visibility ColorUIControl drop down.

    Declaration
    public virtual bool DroppedDown { get; set; }
    Property Value
    Type Description
    System.Boolean

    True if the drop-down is visible; False otherwise. By default, it is False.

    EnableTouchMode

    Gets or sets the touchmode of ColorUIControl is enable.

    Declaration
    public override bool EnableTouchMode { get; set; }
    Property Value
    Type Description
    System.Boolean
    Overrides
    ButtonAdv.EnableTouchMode

    SelectedAsBackcolor

    Gets or sets a value whether SelectedColor is set as the backcolor.

    Declaration
    public bool SelectedAsBackcolor { get; set; }
    Property Value
    Type Description
    System.Boolean

    True if the SelectedColor is used; False otherwise. By default, it is False.

    SelectedAsText

    Gets or sets a value whether SelectedColor is set as the text.

    Declaration
    public bool SelectedAsText { get; set; }
    Property Value
    Type Description
    System.Boolean

    True if the SelectedColor is used; false otherwise. By default, it is False.

    SelectedColor

    Gets or sets the current selected color.

    Declaration
    public Color SelectedColor { get; set; }
    Property Value
    Type Description
    System.Drawing.Color

    A color value.

    SelectedColorGroup

    Gets or sets the tab associated with this colorgroup as the selected tab in the drop-down ColorUIControl.

    Declaration
    public ColorUISelectedGroup SelectedColorGroup { get; set; }
    Property Value
    Type Description
    ColorUISelectedGroup

    A ColorUISelectedGroup value.

    StandardTabName

    Gets or sets the text displayed on the drop-down ColorUIControl's standard colors tab.

    Declaration
    public string StandardTabName { get; set; }
    Property Value
    Type Description
    System.String

    A String value.

    SystemTabName

    Gets or sets the text displayed on the drop-down ColorUIControl's system colors tab.

    Declaration
    public string SystemTabName { get; set; }
    Property Value
    Type Description
    System.String

    A String value.

    Methods

    ArgToRadians(Int64)

    Declaration
    protected static double ArgToRadians(long arg)
    Parameters
    Type Name Description
    System.Int64 arg
    Returns
    Type Description
    System.Double

    CreateAccessibilityInstance()

    Creates a new accessibility object in ColorPickerButton.

    Declaration
    protected override AccessibleObject CreateAccessibilityInstance()
    Returns
    Type Description
    System.Windows.Forms.AccessibleObject

    Returns a new System.Windows.Forms.AccessibleObject for the ColorPickerButton

    CreateDropdownContainer()

    Creates a default instance of a PopupControlContainer.

    Declaration
    protected virtual PopupControlContainer CreateDropdownContainer()
    Returns
    Type Description
    PopupControlContainer

    The PopupControlContainer instance.

    Dispose(Boolean)

    Overridden. See System.Windows.Forms.Control.Dispose.

    Declaration
    protected override void Dispose(bool disposing)
    Parameters
    Type Name Description
    System.Boolean disposing
    Overrides
    ButtonAdv.Dispose(Boolean)

    DropdownContainerBeforePopup(Object, CancelEventArgs)

    Declaration
    protected virtual void DropdownContainerBeforePopup(object sender, CancelEventArgs e)
    Parameters
    Type Name Description
    System.Object sender
    System.ComponentModel.CancelEventArgs e

    DropdownContainerCloseUp(Object, PopupClosedEventArgs)

    Declaration
    protected virtual void DropdownContainerCloseUp(object sender, PopupClosedEventArgs e)
    Parameters
    Type Name Description
    System.Object sender
    PopupClosedEventArgs e

    DropdownContainerPopup(Object, EventArgs)

    Declaration
    protected virtual void DropdownContainerPopup(object sender, EventArgs e)
    Parameters
    Type Name Description
    System.Object sender
    System.EventArgs e

    GetControlName()

    Returns the name of the control.

    Declaration
    protected override string GetControlName()
    Returns
    Type Description
    System.String
    Overrides
    ButtonAdv.GetControlName()

    InitializeDropdownContainer()

    Initializes the drop-down container. Adds a ColorUIControl.

    Declaration
    protected virtual void InitializeDropdownContainer()

    OnClick(EventArgs)

    Overridden. See System.Windows.Forms.Control.OnClick.

    Declaration
    protected override void OnClick(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e
    Overrides
    ButtonAdv.OnClick(EventArgs)

    OnFontChanged(EventArgs)

    Sets the font to ColorUI control

    Declaration
    protected override void OnFontChanged(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e
    Overrides
    ButtonAdv.OnFontChanged(EventArgs)

    OnKeyDown(KeyEventArgs)

    Declaration
    protected override void OnKeyDown(KeyEventArgs e)
    Parameters
    Type Name Description
    System.Windows.Forms.KeyEventArgs e
    Overrides
    ButtonAdv.OnKeyDown(KeyEventArgs)

    ResetCustomTabName()

    Resets the CustomTabName property to its default value.

    Declaration
    public virtual void ResetCustomTabName()

    ResetSelectedColor()

    Resets the SelectedColor property to its default value.

    Declaration
    public virtual void ResetSelectedColor()

    ResetStandardTabName()

    Resets the StandardTabName property to its default value.

    Declaration
    public virtual void ResetStandardTabName()

    ResetSystemTabName()

    Resets the SystemTabName property to its default value.

    Declaration
    public virtual void ResetSystemTabName()

    ShouldSerializeCustomTabName()

    Declaration
    protected bool ShouldSerializeCustomTabName()
    Returns
    Type Description
    System.Boolean

    ShouldSerializeSelectedColor()

    Declaration
    protected bool ShouldSerializeSelectedColor()
    Returns
    Type Description
    System.Boolean

    ShouldSerializeStandardTabName()

    Declaration
    protected bool ShouldSerializeStandardTabName()
    Returns
    Type Description
    System.Boolean

    ShouldSerializeSystemTabName()

    Declaration
    protected bool ShouldSerializeSystemTabName()
    Returns
    Type Description
    System.Boolean

    WndProc(ref Message)

    Declaration
    protected override void WndProc(ref Message m)
    Parameters
    Type Name Description
    System.Windows.Forms.Message m

    Events

    ColorSelected

    The ColorSelected event occurs when a color is selected from the drop-down ColorUIControl.

    Declaration
    public event EventHandler ColorSelected
    Event Type
    Type Description
    System.EventHandler

    Implements

    IThemeProvider
    IVisualStyle
    ISupportOffice2007Theme
    ISupportThemeChanged
    System.Windows.Forms.IMessageFilter
    Back to top Generated by DocFX
    Copyright © 2001 - 2021 Syncfusion Inc. All Rights Reserved