Not logged in▾
Log In Register
Forgot Password Resend Validation E-mail
In This Article

ColorPalettePicker Class

Namespace:
ActiproSoftware.UI.WinForms.Controls
Assembly:
ActiproSoftware.Shared.WinForms.dll

Represents a control for selecting a Color from a palette.

public class ColorPalettePicker : UIControl, IUIControl, IUIElement, ILogicalTreeNode, IDpiAwareElement, IDisposable
Inheritance:
object MarshalByRefObject Component Control ScrollableControl UIControl object
Implements:
IUIControl IUIElement ILogicalTreeNode IDpiAwareElement IDisposable

Constructors

ColorPalettePicker()

Initializes an instance of the class.

public ColorPalettePicker()

Properties

DefaultSize

Gets the default size of the control.

protected override Size DefaultSize { get; }

Property Value

Size:

The default Size of the control.

SelectedColor

The selected color in the list.

[Browsable(false)]
public Color SelectedColor { get; set; }

Property Value

Color

Methods

ArrangeOverride(Size)

Positions child elements and determines an arrange size.

protected override Size ArrangeOverride(Size finalSize)
Parameter Type Description
finalSize Size

The final area within the parent that this element should use to arrange itself and its children.

Returns

Size:

The actual size used.

Remarks

Element authors should override this method, call Arrange(Rectangle) on each visible child element and position each child element. It is required that a parent element calls Arrange(Rectangle) on each child or they won't be rendered.

CreateChildren()

Invoked when the collection of child elements is to be created.

protected override IList<ILogicalTreeNode>? CreateChildren()

Returns

IList<ILogicalTreeNode>:

The list that should be assigned to the Children property.

Remarks

By default, no child collection is created.

InitializeColors(Color[])

Initializes the list using the specified array of Color objects.

public void InitializeColors(Color[] colors)
Parameter Type Description
colors Color[]

An array of Color objects with which to initialize the list.

MeasureOverride(Graphics?, Size)

Measures the size in layout required for child elements and determines a size for the element itself.

protected override Size MeasureOverride(Graphics? g, Size availableSize)
Parameter Type Description
g Graphics

The Graphics object to use for measurement.
availableSize Size

The available size that this element can give to child elements. Infinity can be specified as a value to indicate that the element will size to whatever content is available.

Returns

Size:

The size that this element determines it needs during layout, based on its calculations of child element sizes.

Remarks

Element authors should override this method, call Measure(Graphics?, Size) on each visible child element and determine the total size required.

OnSelectedColorChanged(EventArgs)

Raises the SelectedColorChanged event.

protected virtual void OnSelectedColorChanged(EventArgs e)
Parameter Type Description
e EventArgs

The event data.

ProcessCmdKey(ref Message, Keys)

Processes a command key.

protected override bool ProcessCmdKey(ref Message m, Keys keyData)
Parameter Type Description
m Message
keyData Keys

One of the Keys values that represents the key to process.

Returns

bool:

true if the character was processed by the control; otherwise, false.

Events

SelectedColorChanged

Occurs after the value of the SelectedColor property changes.

public event EventHandler? SelectedColorChanged

Event Type

EventHandler

Remarks

Use this event to perform any processing that should occur after the selection changes.

Inherited Members

Extension Methods