Class ColorPickerUIAdv

Represents a class contains the color palette user interface for selecting standard and custom theme colors for ColorPickerUIAdv.

Inheritance
System.Object
BaseControl
ColorPickerUIAdv
Implements
System.IDisposable
System.Runtime.Serialization.ISerializable
Inherited Members
Namespace: Syncfusion.Windows.Forms.Tools
Assembly: Syncfusion.Tools.Windows.dll
Syntax
public class ColorPickerUIAdv : BaseControl, IThemeProvider, IVisualStyle, IDisposable, ISerializable

Constructors

ColorPickerUIAdv()

Initialize a new instance of the ColorPickerUIAdv class.

Declaration
public ColorPickerUIAdv()

ColorPickerUIAdv(SerializationInfo, StreamingContext)

Declaration
protected ColorPickerUIAdv(SerializationInfo info, StreamingContext context)
Parameters
Type Name Description
System.Runtime.Serialization.SerializationInfo info
System.Runtime.Serialization.StreamingContext context

Properties

ActiveGroup

Gets or sets the active group value.

Declaration
public ColorUIAdvGroup ActiveGroup { get; set; }
Property Value
Type
ColorUIAdvGroup

AutomaticColor

Gets or sets color, which is selected after automatic button click.

Declaration
public Color AutomaticColor { get; set; }
Property Value
Type
System.Drawing.Color
Remarks

Default value is black color.

BackColor

Gets or sets the background color for the control.

Declaration
public override Color BackColor { get; set; }
Property Value
Type
System.Drawing.Color

BackgroundImage

Gets or sets the background image of ColorPickerUIAdv.

Declaration
public override Image BackgroundImage { get; set; }
Property Value
Type
System.Drawing.Image

BackgroundImageLayout

Gets or sets the background image layout of ColorPickerUIAdv.

Declaration
public override ImageLayout BackgroundImageLayout { get; set; }
Property Value
Type
System.Windows.Forms.ImageLayout

BeforeTouchSize

Gets or sets Control size before touch enabled.

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

BorderOffset

Gets or sets border offset for ColorItems.

Declaration
public int BorderOffset { get; set; }
Property Value
Type
System.Int32

BorderStyle

Gets or sets the border style of the control.

Declaration
public BorderStyle BorderStyle { get; set; }
Property Value
Type Description
System.Windows.Forms.BorderStyle

A System.Windows.Forms.BorderStyle value. The default is BorderStyle.None.

ButtonsHeight

Gets or sets the height of the buttons.

Declaration
public int ButtonsHeight { get; set; }
Property Value
Type
System.Int32

ColorItemSize

Gets or sets the size for ColorItems.

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

CreateParams

Gets the required creation parameters when the control handle is created.

Declaration
protected override CreateParams CreateParams { get; }
Property Value
Type
System.Windows.Forms.CreateParams

CustomGroups

Gets or sets the Custom Groups collection of the control.

Declaration
public ColorUIAdvGroupsCollection CustomGroups { get; }
Property Value
Type
ColorUIAdvGroupsCollection

EnableTouchMode

Gets or sets value to enable or disable the Touchmode to the controls.

Declaration
public bool EnableTouchMode { get; set; }
Property Value
Type
System.Boolean
Remarks

Scale factor will be updated automatically if scalefactor is equal to 1

Font

Declaration
public override Font Font { get; set; }
Property Value
Type
System.Drawing.Font

Groups

Gets or sets groups collection of the control.

Declaration
protected ColorUIAdvGroupsCollection Groups { get; set; }
Property Value
Type
ColorUIAdvGroupsCollection

HighLightedItem

Gets the highlighted color item.

Declaration
public ColorItem HighLightedItem { get; }
Property Value
Type
ColorItem

HorizontalItemsSpacing

Gets or sets horizontal spacing between ColorItems.

Declaration
public int HorizontalItemsSpacing { get; set; }
Property Value
Type
System.Int32

MetroColor

Gets or sets the metrocolor.

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

MinimumSize

Gets or sets the size that is the lower limit that System.Windows.Forms.Control.GetPreferredSize(System.Drawing.Size) can specify.

Declaration
public override Size MinimumSize { get; }
Property Value
Type
System.Drawing.Size

MoreColorsButton

Gets the instance of MoreColorButton.

Declaration
public ButtonAdv MoreColorsButton { get; }
Property Value
Type
ButtonAdv

Office2007Theme

Gets or sets Office2007 theme for control drawing.

Declaration
public Office2007Theme Office2007Theme { get; set; }
Property Value
Type
Office2007Theme
Remarks

Default is blue color theme.

Office2010Theme

Gets or sets Office2010 theme for control drawing.

Declaration
public Office2010Theme Office2010Theme { get; set; }
Property Value
Type
Office2010Theme
Remarks

Default is blue color theme.

RecentGroup

Gets the RecentGroup of ColorPickerUIAdv.

Declaration
public ColorUIAdvGroup RecentGroup { get; }
Property Value
Type
ColorUIAdvGroup

SelectedColor

Gets or sets the selected color.

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

If color isn't found in any group it's added to recent colors group.

SelectedItem

Gets the selected item of color value.

Declaration
public ColorItem SelectedItem { get; }
Property Value
Type
ColorItem

SelectedTabIndex

Gets or sets index of TabPageAdv, that was selected in previous selection.

Declaration
public int SelectedTabIndex { get; set; }
Property Value
Type
System.Int32

StandardGroup

Gets the StandardGroup of ColorPickerUIAdv.

Declaration
public ColorUIAdvGroup StandardGroup { get; }
Property Value
Type
ColorUIAdvGroup

StateButton

Gets the instance of StateButton.

Declaration
public ButtonAdv StateButton { get; }
Property Value
Type
ButtonAdv

Style

Gets or sets the style of ColorPickerUIAdv.

Declaration
public ColorPickerUIAdv.visualstyle Style { get; set; }
Property Value
Type
ColorPickerUIAdv.visualstyle

TextAlign

Gets or sets the text alignment.

Declaration
public ContentAlignment TextAlign { get; set; }
Property Value
Type
System.Drawing.ContentAlignment
Remarks

Default value is MiddleLeft alignment.

ThemeGroup

Gets the ThemeGroup of ColorPickerUIAdv.

Declaration
public ColorUIAdvGroup ThemeGroup { get; }
Property Value
Type
ColorUIAdvGroup

ThemeStyle

Gets or sets the ColorPickerUIAdvVisualStyle value used to customize the appearance of the ColorPickerUIAdv.

Declaration
public ColorPickerUIAdvVisualStyle ThemeStyle { get; set; }
Property Value
Type
ColorPickerUIAdvVisualStyle
Remarks

This ThemeStyle settings will be applied only when the VisualStyleBased theme has been applied to the control.

UseOffice2007Style

Gets or sets a value indicating whether to use Office2007 style for control drawing.

Declaration
public bool UseOffice2007Style { get; set; }
Property Value
Type
System.Boolean
Remarks

Default value is true.

VerticalItemsSpacing

Gets or sets vertical spacing between ColorItems.

Declaration
public int VerticalItemsSpacing { get; set; }
Property Value
Type
System.Int32

Methods

ApplyScaleToControl(Single)

Scale the control based on the scale factor passed in the argument.

Declaration
public void ApplyScaleToControl(float scaleFactor)
Parameters
Type Name Description
System.Single scaleFactor

value to scale the factor based upon.

CreateAccessibilityInstance()

Creates a new accessibility object in ColorPickerUIAdv.

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

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

Dispose(Boolean)

Releases the unmanaged resources used by the System.Windows.Forms.Control and its child controls and optionally releases the managed resources.

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

true to release both managed and unmanaged resources; false to release only unmanaged resources.

GetControlName(String)

Helps to apply the ControlName settings in control

Declaration
public override string GetControlName(string controlName)
Parameters
Type Name Description
System.String controlName

ControlName
Returns
Type
System.String
Overrides

InitDefaultGroups()

Fills default groups with colors.

Declaration
public void InitDefaultGroups()

OnFontChanged(EventArgs)

Font changed

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

OnItemSelection(ColorPickerUIAdv.ColorPickedEventArgs)

Declaration
protected virtual void OnItemSelection(ColorPickerUIAdv.ColorPickedEventArgs e)
Parameters
Type Name Description
ColorPickerUIAdv.ColorPickedEventArgs e

OnMouseMove(MouseEventArgs)

Raises the System.Windows.Forms.Control.MouseMove event.

Declaration
protected override void OnMouseMove(MouseEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.MouseEventArgs e

A System.Windows.Forms.MouseEventArgs that contains the event data.

OnMouseUp(MouseEventArgs)

Raises the System.Windows.Forms.Control.MouseUp event.

Declaration
protected override void OnMouseUp(MouseEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.MouseEventArgs e

A System.Windows.Forms.MouseEventArgs that contains the event data.

OnPaint(PaintEventArgs)

Raises the System.Windows.Forms.Control.Paint event.

Declaration
protected override void OnPaint(PaintEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.PaintEventArgs e

A System.Windows.Forms.PaintEventArgs that contains the event data.

OnPicked(ColorPickerUIAdv.ColorPickedEventArgs)

Declaration
protected virtual void OnPicked(ColorPickerUIAdv.ColorPickedEventArgs e)
Parameters
Type Name Description
ColorPickerUIAdv.ColorPickedEventArgs e

OnSizeChanged(EventArgs)

Raises the System.Windows.Forms.Control.SizeChanged event.

Declaration
protected override void OnSizeChanged(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

An System.EventArgs that contains the event data.

OnThemeNameChanged(String)

Declaration
public override void OnThemeNameChanged(string themeName)
Parameters
Type Name Description
System.String themeName
Overrides

OnVisibleChanged(EventArgs)

Raises the System.Windows.Forms.Control.VisibleChanged event.

Declaration
protected override void OnVisibleChanged(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

An System.EventArgs that contains the event data.

ProcessDialogKey(Keys)

Processes the dialog key.

Declaration
protected override bool ProcessDialogKey(Keys keys)
Parameters
Type Name Description
System.Windows.Forms.Keys keys

The keys.
Returns
Type Description
System.Boolean

Returns bool value

SetBoundsCore(Int32, Int32, Int32, Int32, BoundsSpecified)

Performs the work of setting the specified bounds of this control.

Declaration
protected override void SetBoundsCore(int x, int y, int width, int height, BoundsSpecified specified)
Parameters
Type Name Description
System.Int32 x

The new System.Windows.Forms.Control.Left property value of the control.
System.Int32 y

The new System.Windows.Forms.Control.Top property value of the control.
System.Int32 width

The new System.Windows.Forms.Control.Width property value of the control.
System.Int32 height

The new System.Windows.Forms.Control.Height property value of the control.
System.Windows.Forms.BoundsSpecified specified

A bitwise combination of the System.Windows.Forms.BoundsSpecified values.

ShouldSerializeCustomGroups()

Indicates should or not we serialize the custom groups of ColorPickerUIAdv.

Declaration
public bool ShouldSerializeCustomGroups()
Returns
Type
System.Boolean

UpdateControl()

Updates layout and invalidates control.

Declaration
public void UpdateControl()

Events

ItemSelection

Raised when mouse hovers over ColorItem.

Declaration
public event ColorPickerUIAdv.ColorPickedEventHandler ItemSelection
Event Type
Type
ColorPickerUIAdv.ColorPickedEventHandler

Picked

Raised when ColorItem is picked or new ColorItem was added from ColorDlgAdv.

Declaration
public event ColorPickerUIAdv.ColorPickedEventHandler Picked
Event Type
Type
ColorPickerUIAdv.ColorPickedEventHandler

Explicit Interface Implementations

ISerializable.GetObjectData(SerializationInfo, StreamingContext)

Declaration
void ISerializable.GetObjectData(SerializationInfo info, StreamingContext context)
Parameters
Type Name Description
System.Runtime.Serialization.SerializationInfo info
System.Runtime.Serialization.StreamingContext context

Implements

System.IDisposable
System.Runtime.Serialization.ISerializable