Avalonia.Controls.ColorPicker

Defines the position of a color's alpha component relative to all other components.

The alpha component occurs before all other components.

For example, this may indicate the #AARRGGBB or ARGB format which is the default format for XAML itself and the Color struct.

The alpha component occurs after all other components.

For example, this may indicate the #RRGGBBAA or RGBA format which is the default format for CSS.

Holds the details of a ColorChanged event.

HSV color information is intentionally not provided. Use to obtain it.

Initializes a new instance of the class.

The old/original color from before the change event. The new/updated color that triggered the change event.

Gets the old/original color from before the change event.

Gets the new/updated color that triggered the change event.

Defines a specific component within a color model.

Represents the alpha component.

Represents the first color component which is Red when RGB or Hue when HSV.

Represents the second color component which is Green when RGB or Saturation when HSV.

Represents the third color component which is Blue when RGB or Value when HSV.

Defines the model used to represent colors.

Color is represented by hue, saturation, value and alpha components.

Color is represented by red, green, blue and alpha components.

Implements a reduced flat design or flat UI color palette.

See: - https://htmlcolorcodes.com/color-chart/ - https://htmlcolorcodes.com/color-chart/flat-design-color-chart/ - http://designmodo.github.io/Flat-UI/ The GitHub project is licensed as MIT: https://github.com/designmodo/Flat-UI.

Defines all colors in the .

This is done in an enum to ensure it is compiled into the assembly improving startup performance.

Initializes all color chart colors.

Implements half of the for improved usability.

Initializes all color chart colors.

Implements the standard Windows 10 color palette.

Gets the total number of colors in this palette. A color is not necessarily a single value and may be composed of several shades. This has little meaning in this palette as colors are not strictly separated.

Gets the total number of shades for each color in this palette. Shades are usually a variation of the color lightening or darkening it. This has little meaning in this palette as colors are not strictly separated by shade.

Interface to define a color palette.

Gets the total number of colors in this palette. A color is not necessarily a single value and may be composed of several shades.

Represents total columns in a table.

Gets the total number of shades for each color in this palette. Shades are usually a variation of the color lightening or darkening it.

Represents total rows in a table.

Gets a color in the palette by index.

The index of the color in the palette. The index must be between zero and . The index of the color shade in the palette. The index must be between zero and . The color at the specified index or an exception.

Implements a reduced version of the 2014 Material Design color palette.

This palette is based on the one outlined here: https://material.io/design/color/the-color-system.html#tools-for-picking-colors In order to make the palette uniform and rectangular the following alterations were made: 1. The A100-A700 shades of each color are excluded. These shades do not exist for all colors (brown/gray). 2. Black/White are stand-alone and are also excluded.

Defines all colors in the .

This is done in an enum to ensure it is compiled into the assembly improving startup performance.

Initializes all color chart colors.

Implements half of the for improved usability.

Initializes all color chart colors.

Implements the standard sixteen color palette from the HTML 4.01 specification.

See https://en.wikipedia.org/wiki/Web_colors#HTML_color_names.

Presents a color for user editing using a spectrum, palette and component sliders within a drop down. Editing is available when the drop down flyout is opened; otherwise, only the preview content area is shown.

Initializes a new instance of the class.

Defines the property.

Defines the property.

Defines the property.

Defines the property.

Gets or sets any content displayed in the ColorPicker's preview content area.

By default this should show a preview of the currently selected color.

Gets or sets the data template used to display the content of the ColorPicker's preview content area.

Gets or sets the horizontal alignment of the content within the ColorPicker's preview content area.

Gets or sets the vertical alignment of the content within the ColorPicker's preview content area.

Presents a preview color with optional accent colors.

Event for when the selected color changes within the previewer. This occurs when an accent color is pressed.

Initializes a new instance of the class.

Connects or disconnects all control event handlers.

True to connect event handlers, otherwise false.

Called before the event occurs.

The defining old/new colors.

Event handler for when an accent color border is pressed. This will update the color to the background of the pressed panel.

Defines the property.

Defines the property.

Gets or sets the currently previewed color in the HSV color model.

Only an HSV color is supported in this control to ensure there is never any loss of precision or color information. Accent colors, like the color spectrum, only operate with the HSV color model.

Gets or sets a value indicating whether accent colors are visible along with the preview color.

A slider with a background that represents a single color component.

Event for when the selected color changes within the slider.

Defines the maximum hue component value (other components are always 0..100 or 0.255).

This should match the default property.

Initializes a new instance of the class.

Updates the visual state of the control by applying latest PseudoClasses.

Generates a new background image for the color slider and applies it.

Rounds the component values of the given . This is useful for user-display and to ensure a color matches user selection exactly.

The to round component values for. A new with rounded component values.

Updates the slider property values by applying the current color.

Warning: This will trigger property changed updates. Consider using externally.

Gets the current color determined by the slider values.

Gets the actual background color displayed for the given HSV color. This can differ due to the effects of certain properties intended to improve perception.

The actual color to get the equivalent background color for. The equivalent, perceived background color.

Gets the actual background color displayed for the given RGB color. This can differ due to the effects of certain properties intended to improve perception.

The actual color to get the equivalent background color for. The equivalent, perceived background color.

Called before the event occurs.

The defining old/new colors.

Defines the property.

Defines the property.

Defines the property.

Defines the property.

Defines the property.

Defines the property.

Defines the property.

Gets or sets the currently selected color in the RGB color model.

Use this property instead of when in to avoid loss of precision and color drifting.

Gets or sets the color component represented by the slider.

Gets or sets the active color model used by the slider.

Gets or sets the currently selected color in the HSV color model.

Use this property instead of when in to avoid loss of precision and color drifting.

Gets or sets a value indicating whether the alpha component is visible and rendered. When false, this ensures that the gradient is always visible and never transparent regardless of the actual color. This property is ignored when the alpha component itself is being displayed.

Setting to false means the alpha component is always forced to maximum for components other than during rendering. This doesn't change the value of the alpha component in the color – it is only for display.

Gets or sets a value indicating whether the slider adapts rendering to improve user-perception over exactness.

When true in the HSVA color model, this ensures that the gradient is always visible and never washed out regardless of the actual color. When true in the RGBA color model, this ensures the gradient always appears as red, green or blue.

For example, with Hue in the HSVA color model, the Saturation and Value components are always forced to maximum values during rendering. In the RGBA color model, all components other than are forced to minimum values during rendering.

Note this property will only adjust components other than during rendering. This also doesn't change the values of any components in the actual color – it is only for display.

Gets or sets a value indicating whether rounding of color component values is enabled.

This is applicable for the HSV color model only. The struct uses double values while the struct uses byte. Only double types need rounding.

A two dimensional spectrum for color selection.

Event for when the selected color changes within the spectrum.

Initializes a new instance of the class.

Explicitly unregisters all events connected in OnApplyTemplate().

Updates the visual state of the control by applying latest PseudoClasses.

Changes the currently selected color (always in HSV) and applies all necessary updates.

Some additional logic is applied in certain situations to coerce and sync color values. Use this method instead of update the or directly. The new HSV color to change to.

Updates the selected and based on a point within the color spectrum.

The point on the spectrum representing the color.

Updates the position of the selection ellipse on the spectrum which indicates the selected color.

Determines whether the selection ellipse should be light based on the relative luminance of the selected color.

Defines the property.

Defines the property.

Defines the property.

Defines the property.

Defines the property.

Defines the property.

Defines the property.

Defines the property.

Defines the property.

Defines the property.

Defines the property.

Gets or sets the currently selected color in the RGB color model.

For control authors, use instead to avoid loss of precision and color drifting.

Gets or sets the two HSV color components displayed by the spectrum.

Internally, the uses the HSV color model.

Gets or sets the currently selected color in the HSV color model.

This should be used in all cases instead of the property. Internally, the uses the HSV color model and using this property will avoid loss of precision and color drifting.

Gets or sets the maximum value of the Hue component in the range from 0..359. This property must be greater than .

Internally, the uses the HSV color model.

Gets or sets the maximum value of the Saturation component in the range from 0..100. This property must be greater than .

Internally, the uses the HSV color model.

Gets or sets the maximum value of the Value component in the range from 0..100. This property must be greater than .

Internally, the uses the HSV color model.

Gets or sets the minimum value of the Hue component in the range from 0..359. This property must be less than .

Internally, the uses the HSV color model.

Gets or sets the minimum value of the Saturation component in the range from 0..100. This property must be less than .

Internally, the uses the HSV color model.

Gets or sets the minimum value of the Value component in the range from 0..100. This property must be less than .

Internally, the uses the HSV color model.

Gets or sets the displayed shape of the spectrum.

Gets the third HSV color component that is NOT displayed by the spectrum. This is automatically calculated from the property.

This property should be used for any external color slider that represents the third component of the color. Note that this property uses the generic type instead of the more accurate to allow direct usage by the generalized color sliders.

Creates an accent color for a given base color value and step parameter.

This is a highly-specialized converter for the color picker.

The amount to change the Value component for each accent color step.

This does not account for perceptual differences and also does not match with system accent color calculation.

Use the HSV representation as it's more perceptual. In most cases only the value is changed by a fixed percentage so the algorithm is reproducible. The base color to calculate the accent from. The number of accent color steps to move. The new accent color.

Gets a , either black or white, depending on the luminance of the supplied color. A default color supplied in the converter parameter may be returned if alpha is below the set threshold.

This is a highly-specialized converter for the color picker.

Gets or sets the alpha channel threshold below which a default color is used instead of black/white.

Contains helpers useful when working with colors.

Gets the relative (perceptual) luminance/brightness of the given color. 1 is closer to white while 0 is closer to black.

The color to calculate relative luminance for. The relative (perceptual) luminance/brightness of the given color.

Determines if color display names are supported based on the current thread culture.

Only English names are currently supported following known color names. In the future known color names could be localized.

Determines an approximate display name for the given color.

The color to get the display name for. The approximate color display name.

Gets the human-readable display name for the given .

This currently uses the enum value's C# name directly which limits it to the EN language only. In the future this should be localized to other cultures. The to get the display name for. The human-readable display name for the given .

Contains internal, special-purpose helpers used with the color picker.

Generates a new bitmap of the specified size by changing a specific color component. This will produce a gradient representing a sweep of all possible values of the color component.

The target buffer which will contain the bitmap data on return. The pixel width (X, horizontal) of the resulting bitmap. The pixel height (Y, vertical) of the resulting bitmap. The orientation of the resulting bitmap (gradient direction). The color model being used: RGBA or HSVA. The specific color component to sweep. The base HSV color used for components not being changed. Whether the alpha component is visible and rendered in the bitmap. This property is ignored when the alpha component itself is being rendered. Whether the slider adapts rendering to improve user-perception over exactness. This will ensure colors are always discernible. A new bitmap representing a gradient of color component values.

Converts the given raw BGRA pre-multiplied alpha pixel data into a bitmap.

The bitmap (in raw BGRA pre-multiplied alpha pixels). The pixel width of the bitmap. The pixel height of the bitmap. A new .

Contains and allows modification of Hue, Saturation and Value components.

The is a specialized struct optimized for performance and memory: This is not a read-only struct like and allows editing the fields Removes the alpha component unnecessary in core calculations No component bounds checks or clamping is done.

The Hue component in the range from 0..359.

The Saturation component in the range from 0..1.

The Value component in the range from 0..1.

Initializes a new instance of the struct.

The Hue component in the range from 0..360. The Saturation component in the range from 0..1. The Value component in the range from 0..1.

Initializes a new instance of the struct.

An existing to convert to .

Converts this struct into a standard .

The Alpha component in the range from 0..1. A new representing this struct.

Returns the color model equivalent of this color.

The equivalent color.

Defines a relative amount that a color component should be incremented.

A smaller change in value.

A larger change in value.

Defines the direction a color component should be incremented.

Decreasing in value towards zero.

Increasing in value towards positive infinity.

Contains and allows modification of Red, Green and Blue components.

The is a specialized struct optimized for performance and memory: This is not a read-only struct like and allows editing the fields Removes the alpha component unnecessary in core calculations Normalizes RGB components in the range of 0..1 to simplify calculations. No component bounds checks or clamping is done.

The Red component in the range from 0..1.

The Green component in the range from 0..1.

The Blue component in the range from 0..1.

Initializes a new instance of the struct.

The Red component in the range from 0..1. The Green component in the range from 0..1. The Blue component in the range from 0..1.

Initializes a new instance of the struct.

An existing to convert to .

Converts this struct into a standard .

The Alpha component in the range from 0..1. A new representing this struct.

Returns the color model equivalent of this color.

The equivalent color.

Defines the two HSV color components displayed by a .

Order of the color components is important and correspond with an X/Y axis in Box shape or a degree/radius in Ring shape.

The Hue and Value components.

In Box shape, Hue is mapped to the X-axis and Value is mapped to the Y-axis. In Ring shape, Hue is mapped to degrees and Value is mapped to radius.

The Value and Hue components.

In Box shape, Value is mapped to the X-axis and Hue is mapped to the Y-axis. In Ring shape, Value is mapped to degrees and Hue is mapped to radius.

The Hue and Saturation components.

In Box shape, Hue is mapped to the X-axis and Saturation is mapped to the Y-axis. In Ring shape, Hue is mapped to degrees and Saturation is mapped to radius.

The Saturation and Hue components.

In Box shape, Saturation is mapped to the X-axis and Hue is mapped to the Y-axis. In Ring shape, Saturation is mapped to degrees and Hue is mapped to radius.

The Saturation and Value components.

In Box shape, Saturation is mapped to the X-axis and Value is mapped to the Y-axis. In Ring shape, Saturation is mapped to degrees and Value is mapped to radius.

The Value and Saturation components.

In Box shape, Value is mapped to the X-axis and Saturation is mapped to the Y-axis. In Ring shape, Value is mapped to degrees and Saturation is mapped to radius.

Defines the shape of a .

The spectrum is in the shape of a rectangular or square box. Note that more colors are visible to the user in Box shape.

The spectrum is in the shape of an ellipse or circle.

Presents a color for user editing using a spectrum, palette and component sliders.

Event for when the selected color changes within the slider.

Initializes a new instance of the class.

Gets the value of the hex TextBox and sets it as the current . If invalid, the TextBox hex text will revert back to the last valid color.

Sets the current to the hex TextBox.

Validates the tab/panel/page selection taking into account the visibility of each item as well as the current selection.

Derived controls may re-implement this based on their default style / control template and any specialized selection needs.

Called before the event occurs.

The defining old/new colors.

Called when the property has to be coerced.

The value to coerce.

Called when the property has to be coerced.

The value to coerce.

Coerces/validates the property value.

The instance. The value to coerce. The coerced/validated value.

Coerces/validates the property value.

The instance. The value to coerce. The coerced/validated value.

Event handler for when a key is pressed within the Hex RGB value TextBox. This is used to trigger re-evaluation of the color based on the TextBox value.

Event handler for when the Hex RGB value TextBox looses focus. This is used to trigger re-evaluation of the color based on the TextBox value.

Defines the property.

Defines the property.

Defines the property.

Defines the property.

Defines the property.

Defines the property.

Defines the property.

Defines the property.

Defines the property.

Defines the property.

Defines the property.

Defines the property.

Defines the property.

Defines the property.

Defines the property.

Defines the property.

Defines the property.

Defines the property.

Defines the property.

Defines the property.

Defines the property.

Defines the property.

Defines the property.

Defines the property.

Defines the property.

Defines the property.

Defines the property.

Defines the property.

This property is only applicable to the components tab. The spectrum tab must always be in HSV and the palette tab contains only pre-defined colors.

Gets or sets the position of the alpha component in the hexadecimal input box relative to all other color components.

Gets or sets a value indicating whether the alpha component is enabled. When disabled (set to false) the alpha component will be fixed to maximum and editing controls disabled.

Gets or sets a value indicating whether the alpha component editing controls (Slider(s) and TextBox) are visible. When hidden, the existing alpha component value is maintained.

Note that also controls the alpha component TextBox visibility.

Gets or sets a value indicating whether the color components tab/panel/page (subview) is visible.

Gets or sets a value indicating whether the active color model indicator/selector is visible.

Gets or sets a value indicating whether the color palette tab/panel/page (subview) is visible.

Gets or sets a value indicating whether the color preview is visible.

Note that accent color visibility is controlled separately by .

Gets or sets a value indicating whether the color spectrum tab/panel/page (subview) is visible.

Gets or sets a value indicating whether the color spectrum's third component slider is visible.

Gets or sets a value indicating whether color component sliders are visible.

All color components are controlled by this property but alpha can also be controlled with .

Gets or sets a value indicating whether color component text inputs are visible.

All color components are controlled by this property but alpha can also be controlled with .

Gets or sets a value indicating whether the hexadecimal color value text input is visible.

Gets or sets the collection of individual colors in the palette.

This is not commonly set manually. Instead, it should be set automatically by providing an to the property.

Also note that this property is what should be bound in the control template. is too high-level to use on its own.

Gets or sets the number of colors in each row (section) of the color palette. Within a standard palette, rows are shades and columns are colors.

This is not commonly set manually. Instead, it should be set automatically by providing an to the property.

Also note that this property is what should be bound in the control template. is too high-level to use on its own.

Gets or sets the color palette.

This will automatically set both and overwriting any existing values.

Gets or sets the index of the selected tab/panel/page (subview).

When using the default control theme, this property is designed to be used with the enum. The enum defines the index values of each of the three standard tabs. Use like `SelectedIndex = (int)ColorViewTab.Palette`.

Defines a specific tab/page (subview) within the .

This is indexed to match the default control template ordering.

The color spectrum subview with a box/ring spectrum and sliders.

The color palette subview with a grid of selectable colors.

The components subview with sliders and numeric input boxes.

Gets the approximated display name for the color.

Converts a color to a hex string and vice versa.

Gets or sets a value indicating whether the alpha component is visible in the Hex formatted text.

When hidden the existing alpha component value is maintained. Also when hidden the user is still able to input an 8-digit number with alpha. Alpha will be processed but then removed when displayed. Because this property only controls whether alpha is displayed (and it is still processed regardless) it is termed 'Visible' instead of 'Enabled'.

Gets or sets the position of a color's alpha component relative to all other components.

Converts the given color to its hex color value string representation.

The color to represent as a hex value string. The output position of the alpha component. Whether the alpha component will be included in the hex string. Whether the hex symbol '#' will be added. The input color converted to its hex value string.

Parses a hex color value string into a new .

The hex color string to parse. The input position of the alpha component. The parsed ; otherwise, null.

Parses the given span of characters representing a hex color value into a new .

This is based on the Color.TryParseHexFormat() method. It is copied because it needs to be extended to handle alpha position. However, the alpha position enum is only available in the controls namespace with the ColorPicker control.

Converter that will do nothing (not update bound values) when a null value is encountered. This converter enables binding nullable with non-nullable properties in some scenarios.

Converts the given value into an when a conversion is possible.

Converts the given value into a when a conversion is possible.

Defines a specific component in the HSV color model.

The Alpha component.

Also see:

The Hue component.

Also see:

The Saturation component.

Also see:

The Value component.

Also see:

Defines a specific component in the RGB color model.

The Alpha component.

Also see:

The Red component.

Also see:

The Green component.

Also see:

The Blue component.

Also see:

Specifies that null is allowed as an input even if the corresponding type disallows it.

Specifies that null is disallowed as an input even if the corresponding type allows it.

Specifies that an output may be null even if the corresponding type disallows it.

Specifies that an output will not be null even if the corresponding type allows it.

Specifies that when a method returns , the parameter may be null even if the corresponding type disallows it.

Initializes the attribute with the specified return value condition.

The return value condition. If the method returns this value, the associated parameter may be null.

Gets the return value condition.

Specifies that when a method returns , the parameter will not be null even if the corresponding type allows it.

Initializes the attribute with the specified return value condition.

The return value condition. If the method returns this value, the associated parameter will not be null.

Gets the return value condition.

Specifies that the output will be non-null if the named parameter is non-null.

Initializes the attribute with the associated parameter name.

The associated parameter name. The output will be non-null if the argument to the parameter specified is non-null.

Gets the associated parameter name.

Applied to a method that will never return under any circumstance.

Specifies that the method will not return if the associated Boolean parameter is passed the specified value.

Initializes the attribute with the specified parameter value.

The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to the associated parameter matches this value.

Gets the condition parameter value.

Specifies that the method or property will ensure that the listed field and property members have not- values.

Gets field or property member names.

Initializes the attribute with a field or property member.

The field or property member that is promised to be not-null.

Initializes the attribute with the list of field and property members.

The list of field and property members that are promised to be not-null.

Specifies that the method or property will ensure that the listed field and property members have non- values when returning with the specified return value condition.

Gets the return value condition.

Gets field or property member names.

Initializes the attribute with the specified return value condition and a field or property member.

The return value condition. If the method returns this value, the associated parameter will not be . The field or property member that is promised to be not-.

Initializes the attribute with the specified return value condition and list of field and property members.

The return value condition. If the method returns this value, the associated parameter will not be . The list of field and property members that are promised to be not-null.