ColorSpectrum Class
Definition
A two dimensional spectrum for color selection.
public class ColorSpectrum
Remarks
The control class extends Avalonia.Input.InputElement and adds the following features:
- A Avalonia.Controls.Control.Tag property to allow user-defined data to be attached to the control.
Constructors
| Name | Description |
|---|---|
| ColorSpectrum | Initializes a new instance of the Avalonia.Controls.Primitives.ColorSpectrum class. |
ColorSpectrum Constructor
Initializes a new instance of the Avalonia.Controls.Primitives.ColorSpectrum class.
public ColorSpectrum()
Methods
| Name | Description |
|---|---|
| RaiseColorChanged | No summary available. |
| ApplyTemplate | Creates the visual children of the control, if necessary Inherited from TemplatedControl. |
| GetIsTemplateFocusTarget | Gets the value of the IsTemplateFocusTargetProperty attached property on a control. Inherited from TemplatedControl. |
| SetIsTemplateFocusTarget | Sets the value of the IsTemplateFocusTargetProperty attached property on a control. Inherited from TemplatedControl. |
| Focus | Focuses the control. Inherited from InputElement. |
| GetIsHoldWithMouseEnabled | Inherited from InputElement. |
| GetIsHoldingEnabled | Inherited from InputElement. |
| SetIsHoldWithMouseEnabled | Inherited from InputElement. |
| SetIsHoldingEnabled | Inherited from InputElement. |
| AddHandler (2 overloads) | Adds a handler for the specified routed event. Inherited from Interactive. |
| RaiseEvent | Raises a routed event. Inherited from Interactive. |
| RemoveHandler (2 overloads) | Removes a handler for the specified routed event. Inherited from Interactive. |
| Arrange | Arranges the control and its children. Inherited from Layoutable. |
| InvalidateArrange | Invalidates the arrangement of the control and queues a new layout pass. Inherited from Layoutable. |
| InvalidateMeasure | Invalidates the measurement of the control and queues a new layout pass. Inherited from Layoutable. |
| Measure | Carries out a measure of the control. Inherited from Layoutable. |
| UpdateLayout | Executes a layout pass. Inherited from Layoutable. |
| GetFlowDirection | Gets the value of the attached Avalonia.Visual.FlowDirectionProperty on a control. Inherited from Visual. |
| InvalidateVisual | Invalidates the visual and queues a repaint. Inherited from Visual. |
| Render | Renders the visual to a Avalonia.Media.DrawingContext. Inherited from Visual. |
| SetFlowDirection | Sets the value of the attached Avalonia.Visual.FlowDirectionProperty on a control. Inherited from Visual. |
| ApplyStyling | Applies styling to the control if the control is initialized and styling is not already applied. Inherited from StyledElement. |
| BeginInit | Inherited from StyledElement. |
| EndInit | Inherited from StyledElement. |
| TryGetResource | Inherited from StyledElement. |
| Bind (8 overloads) | Binds a Avalonia.AvaloniaProperty to an Avalonia.Data.BindingBase. Inherited from AvaloniaObject. |
| CheckAccess | Returns a value indicating whether the current thread is the UI thread. Inherited from AvaloniaObject. |
| ClearValue (4 overloads) | Clears a Avalonia.AvaloniaProperty's local value. Inherited from AvaloniaObject. |
| CoerceValue | Coerces the specified Avalonia.AvaloniaProperty. Inherited from AvaloniaObject. |
| Equals | Compares two objects using reference equality. Inherited from AvaloniaObject. |
| GetBaseValue | Inherited from AvaloniaObject. |
| GetHashCode | Gets the hash code for the object. Inherited from AvaloniaObject. |
| GetValue (3 overloads) | Gets a Avalonia.AvaloniaProperty value. Inherited from AvaloniaObject. |
| IsAnimating | Checks whether a Avalonia.AvaloniaProperty is animating. Inherited from AvaloniaObject. |
| IsSet | Checks whether a Avalonia.AvaloniaProperty is set on this object. Inherited from AvaloniaObject. |
| SetCurrentValue (2 overloads) | Sets the value of a dependency property without changing its value source. Inherited from AvaloniaObject. |
| SetValue (3 overloads) | Sets a Avalonia.AvaloniaProperty value. Inherited from AvaloniaObject. |
| VerifyAccess | Checks that the current thread is the UI thread and throws if not. Inherited from AvaloniaObject. |
RaiseColorChanged Method
public void RaiseColorChanged()
Properties
| Name | Description |
|---|---|
| Color | Gets or sets the currently selected color in the RGB color model. |
| Components | Gets or sets the two HSV color components displayed by the spectrum. |
| HsvColor | Gets or sets the currently selected color in the HSV color model. |
| MaxHue | Gets or sets the maximum value of the Hue component in the range from 0..359. This property must be greater than Avalonia.Controls.Primitives.ColorSpectrum.MinHue. |
| MaxSaturation | Gets or sets the maximum value of the Saturation component in the range from 0..100. This property must be greater than Avalonia.Controls.Primitives.ColorSpectrum.MinSaturation. |
| MaxValue | Gets or sets the maximum value of the Value component in the range from 0..100. This property must be greater than Avalonia.Controls.Primitives.ColorSpectrum.MinValue. |
| MinHue | Gets or sets the minimum value of the Hue component in the range from 0..359. This property must be less than Avalonia.Controls.Primitives.ColorSpectrum.MaxHue. |
| MinSaturation | Gets or sets the minimum value of the Saturation component in the range from 0..100. This property must be less than Avalonia.Controls.Primitives.ColorSpectrum.MaxSaturation. |
| MinValue | Gets or sets the minimum value of the Value component in the range from 0..100. This property must be less than Avalonia.Controls.Primitives.ColorSpectrum.MaxValue. |
| Shape | Gets or sets the displayed shape of the spectrum. |
| ThirdComponent | Gets the third HSV color component that is NOT displayed by the spectrum. This is automatically calculated from the Avalonia.Controls.Primitives.ColorSpectrum.Components property. |
| Background | Gets or sets the brush used to draw the control's background. Inherited from TemplatedControl. |
| BackgroundSizing | Gets or sets how the control's background is drawn relative to the control's border. Inherited from TemplatedControl. |
| BorderBrush | Gets or sets the brush used to draw the control's border. Inherited from TemplatedControl. |
| BorderThickness | Gets or sets the thickness of the control's border. Inherited from TemplatedControl. |
| CornerRadius | Gets or sets the radius of the border rounded corners. Inherited from TemplatedControl. |
| FontFamily | Gets or sets the font family used to draw the control's text. Inherited from TemplatedControl. |
| FontFeatures | Gets or sets the font features turned on/off. Inherited from TemplatedControl. |
| FontSize | Gets or sets the size of the control's text in points. Inherited from TemplatedControl. |
| FontStretch | Gets or sets the font stretch used to draw the control's text. Inherited from TemplatedControl. |
| FontStyle | Gets or sets the font style used to draw the control's text. Inherited from TemplatedControl. |
| FontWeight | Gets or sets the font weight used to draw the control's text. Inherited from TemplatedControl. |
| Foreground | Gets or sets the brush used to draw the control's text and other foreground elements. Inherited from TemplatedControl. |
| LetterSpacing | Gets or sets the letter spacing for the control's text content. Inherited from TemplatedControl. |
| Padding | Gets or sets the padding placed between the border of the control and its content. Inherited from TemplatedControl. |
| Template | Gets or sets the template that defines the control's appearance. Inherited from TemplatedControl. |
| ContextFlyout | Gets or sets a context flyout to the control Inherited from Control. |
| ContextMenu | Gets or sets a context menu to the control. Inherited from Control. |
| DataTemplates | Gets or sets the data templates for the control. Inherited from Control. |
| FocusAdorner | Gets or sets the control's focus adorner. Inherited from Control. |
| IsLoaded | Gets a value indicating whether the control is fully constructed in the visual tree and both layout and render are complete. Inherited from Control. |
| Tag | Gets or sets a user-defined object attached to the control. Inherited from Control. |
| Cursor | Gets or sets associated mouse cursor. Inherited from InputElement. |
| Focusable | Gets or sets a value indicating whether the control can receive focus. Inherited from InputElement. |
| GestureRecognizers | Inherited from InputElement. |
| IsEffectivelyEnabled | Gets a value indicating whether this control and all its parents are enabled. Inherited from InputElement. |
| IsEnabled | Gets or sets a value indicating whether the control is enabled for user interaction. Inherited from InputElement. |
| IsFocused | Gets a value indicating whether the control is focused. Inherited from InputElement. |
| IsHitTestVisible | Gets or sets a value indicating whether the control is considered for hit testing. Inherited from InputElement. |
| IsKeyboardFocusWithin | Gets a value indicating whether keyboard focus is anywhere within the element or its visual tree child elements. Inherited from InputElement. |
| IsPointerOver | Gets a value indicating whether the pointer is currently over the control. Inherited from InputElement. |
| IsTabStop | Gets or sets a value that indicates whether the control is included in tab navigation. Inherited from InputElement. |
| KeyBindings | Inherited from InputElement. |
| TabIndex | Gets or sets a value that determines the order in which elements receive focus when the user navigates through controls by pressing the Tab key. Inherited from InputElement. |
| DesiredSize | Gets the size that this element computed during the measure pass of the layout process. Inherited from Layoutable. |
| Height | Gets or sets the height of the element. Inherited from Layoutable. |
| HorizontalAlignment | Gets or sets the element's preferred horizontal alignment in its parent. Inherited from Layoutable. |
| IsArrangeValid | Gets a value indicating whether the control's layouts arrange is valid. Inherited from Layoutable. |
| IsMeasureValid | Gets a value indicating whether the control's layout measure is valid. Inherited from Layoutable. |
| Margin | Gets or sets the margin around the element. Inherited from Layoutable. |
| MaxHeight | Gets or sets the maximum height of the element. Inherited from Layoutable. |
| MaxWidth | Gets or sets the maximum width of the element. Inherited from Layoutable. |
| MinHeight | Gets or sets the minimum height of the element. Inherited from Layoutable. |
| MinWidth | Gets or sets the minimum width of the element. Inherited from Layoutable. |
| UseLayoutRounding | Gets or sets a value that determines whether the element should be snapped to pixel boundaries at layout time. Inherited from Layoutable. |
| VerticalAlignment | Gets or sets the element's preferred vertical alignment in its parent. Inherited from Layoutable. |
| Width | Gets or sets the width of the element. Inherited from Layoutable. |
| Bounds | Gets the bounds of the control relative to its parent. Inherited from Visual. |
| CacheMode | Gets or sets the cache mode of the visual. Inherited from Visual. |
| Clip | Gets or sets the geometry clip for this visual. Inherited from Visual. |
| ClipToBounds | Gets or sets a value indicating whether the control should be clipped to its bounds. Inherited from Visual. |
| Effect | Gets or sets the effect of the control. Inherited from Visual. |
| FlowDirection | Gets or sets the text flow direction. Inherited from Visual. |
| HasMirrorTransform | Gets or sets a value indicating whether to apply mirror transform on this control. Inherited from Visual. |
| IsEffectivelyVisible | Gets a value indicating whether this control and all its parents are visible. Inherited from Visual. |
| IsVisible | Gets or sets a value indicating whether this control is visible. Inherited from Visual. |
| Opacity | Gets or sets the opacity of the control. Inherited from Visual. |
| OpacityMask | Gets or sets the opacity mask of the control. Inherited from Visual. |
| RenderTransform | Gets or sets the render transform of the control. Inherited from Visual. |
| RenderTransformOrigin | Gets or sets the transform origin of the control. Inherited from Visual. |
| ZIndex | Gets or sets the Z index of the control. Inherited from Visual. |
| ActualThemeVariant | Gets the UI theme that is currently used by the element, which might be different than the RequestedThemeVariantProperty. Inherited from StyledElement. |
| Classes | Gets or sets the styled element's classes. Inherited from StyledElement. |
| DataContext | Gets or sets the control's data context. Inherited from StyledElement. |
| IsInitialized | Gets a value that indicates whether the element has finished initialization. Inherited from StyledElement. |
| Name | Gets or sets the name of the styled element. Inherited from StyledElement. |
| Parent | Gets the styled element's logical parent. Inherited from StyledElement. |
| Resources | Gets or sets the styled element's resource dictionary. Inherited from StyledElement. |
| StyleKey | Gets the type by which the element is styled. Inherited from StyledElement. |
| Styles | Gets the styles for the styled element. Inherited from StyledElement. |
| TemplatedParent | Gets the styled element whose lookless template this styled element is part of. Inherited from StyledElement. |
| Theme | Gets or sets the theme to be applied to the element. Inherited from StyledElement. |
| Transitions | Gets or sets the property transitions for the control. Inherited from Animatable. |
| Dispatcher | Returns the Avalonia.AvaloniaObject.Dispatcher that this Avalonia.AvaloniaObject is associated with. Inherited from AvaloniaObject. |
| Item | Inherited from AvaloniaObject. |
Color Property
Gets or sets the currently selected color in the RGB color model.
public Avalonia.Media.Color Color { get; set; }
Remarks
For control authors, use Avalonia.Controls.Primitives.ColorSpectrum.HsvColor instead to avoid loss of precision and color drifting.
Components Property
Gets or sets the two HSV color components displayed by the spectrum.
public Avalonia.Controls.ColorSpectrumComponents Components { get; set; }
Remarks
Internally, the Avalonia.Controls.Primitives.ColorSpectrum uses the HSV color model.
HsvColor Property
Gets or sets the currently selected color in the HSV color model.
public Avalonia.Media.HsvColor HsvColor { get; set; }
Remarks
This should be used in all cases instead of the Avalonia.Controls.Primitives.ColorSpectrum.Color property. Internally, the Avalonia.Controls.Primitives.ColorSpectrum uses the HSV color model and using this property will avoid loss of precision and color drifting.
MaxHue Property
Gets or sets the maximum value of the Hue component in the range from 0..359. This property must be greater than Avalonia.Controls.Primitives.ColorSpectrum.MinHue.
public int MaxHue { get; set; }
Remarks
Internally, the Avalonia.Controls.Primitives.ColorSpectrum uses the HSV color model.
MaxSaturation Property
Gets or sets the maximum value of the Saturation component in the range from 0..100. This property must be greater than Avalonia.Controls.Primitives.ColorSpectrum.MinSaturation.
public int MaxSaturation { get; set; }
Remarks
Internally, the Avalonia.Controls.Primitives.ColorSpectrum uses the HSV color model.
MaxValue Property
Gets or sets the maximum value of the Value component in the range from 0..100. This property must be greater than Avalonia.Controls.Primitives.ColorSpectrum.MinValue.
public int MaxValue { get; set; }
Remarks
Internally, the Avalonia.Controls.Primitives.ColorSpectrum uses the HSV color model.
MinHue Property
Gets or sets the minimum value of the Hue component in the range from 0..359. This property must be less than Avalonia.Controls.Primitives.ColorSpectrum.MaxHue.
public int MinHue { get; set; }
Remarks
Internally, the Avalonia.Controls.Primitives.ColorSpectrum uses the HSV color model.
MinSaturation Property
Gets or sets the minimum value of the Saturation component in the range from 0..100. This property must be less than Avalonia.Controls.Primitives.ColorSpectrum.MaxSaturation.
public int MinSaturation { get; set; }
Remarks
Internally, the Avalonia.Controls.Primitives.ColorSpectrum uses the HSV color model.
MinValue Property
Gets or sets the minimum value of the Value component in the range from 0..100. This property must be less than Avalonia.Controls.Primitives.ColorSpectrum.MaxValue.
public int MinValue { get; set; }
Remarks
Internally, the Avalonia.Controls.Primitives.ColorSpectrum uses the HSV color model.
Shape Property
Gets or sets the displayed shape of the spectrum.
public Avalonia.Controls.ColorSpectrumShape Shape { get; set; }
ThirdComponent Property
Gets the third HSV color component that is NOT displayed by the spectrum. This is automatically calculated from the Avalonia.Controls.Primitives.ColorSpectrum.Components property.
public Avalonia.Controls.ColorComponent ThirdComponent { get; set; }
Remarks
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 Avalonia.Controls.ColorComponent type instead of the more accurate Avalonia.Controls.HsvComponent to allow direct usage by the generalized color sliders.
Fields
ColorProperty Field
Defines the Avalonia.Controls.Primitives.ColorSpectrum.Color property.
public Avalonia.StyledProperty<Avalonia.Media.Color> ColorProperty
ComponentsProperty Field
Defines the Avalonia.Controls.Primitives.ColorSpectrum.Components property.
public Avalonia.StyledProperty<Avalonia.Controls.ColorSpectrumComponents> ComponentsProperty
HsvColorProperty Field
Defines the Avalonia.Controls.Primitives.ColorSpectrum.HsvColor property.
public Avalonia.StyledProperty<Avalonia.Media.HsvColor> HsvColorProperty
MaxHueProperty Field
Defines the Avalonia.Controls.Primitives.ColorSpectrum.MaxHue property.
public Avalonia.StyledProperty<int> MaxHueProperty
MaxSaturationProperty Field
Defines the Avalonia.Controls.Primitives.ColorSpectrum.MaxSaturation property.
public Avalonia.StyledProperty<int> MaxSaturationProperty
MaxValueProperty Field
Defines the Avalonia.Controls.Primitives.ColorSpectrum.MaxValue property.
public Avalonia.StyledProperty<int> MaxValueProperty
MinHueProperty Field
Defines the Avalonia.Controls.Primitives.ColorSpectrum.MinHue property.
public Avalonia.StyledProperty<int> MinHueProperty
MinSaturationProperty Field
Defines the Avalonia.Controls.Primitives.ColorSpectrum.MinSaturation property.
public Avalonia.StyledProperty<int> MinSaturationProperty
MinValueProperty Field
Defines the Avalonia.Controls.Primitives.ColorSpectrum.MinValue property.
public Avalonia.StyledProperty<int> MinValueProperty
ShapeProperty Field
Defines the Avalonia.Controls.Primitives.ColorSpectrum.Shape property.
public Avalonia.StyledProperty<Avalonia.Controls.ColorSpectrumShape> ShapeProperty
ThirdComponentProperty Field
Defines the Avalonia.Controls.Primitives.ColorSpectrum.ThirdComponent property.
public Avalonia.DirectProperty<Avalonia.Controls.Primitives.ColorSpectrum, Avalonia.Controls.ColorComponent> ThirdComponentProperty
Events
| Name | Description |
|---|---|
| ColorChanged | Event for when the selected color changes within the spectrum. |
| TemplateApplied | Raised when the control's template is applied. Inherited from TemplatedControl. |
| Loaded | Occurs when the control has been fully constructed in the visual tree and both layout and render are complete. Inherited from Control. |
| SizeChanged | Occurs when the bounds (actual size) of the control have changed. Inherited from Control. |
| Unloaded | Occurs when the control is removed from the visual tree. Inherited from Control. |
| ContextCanceled | Occurs when the context input gesture continues into another gesture, to notify the element that the context flyout should not be opened. Inherited from InputElement. |
| ContextRequested | Occurs when the user has completed a context input gesture, such as a right-click. Inherited from InputElement. |
| DoubleTapped | Occurs when a double-tap gesture occurs on the control. Inherited from InputElement. |
| GettingFocus | Occurs before the control receives focus. Inherited from InputElement. |
| GotFocus | Occurs when the control receives focus. Inherited from InputElement. |
| Holding | Occurs when a hold gesture occurs on the control. Inherited from InputElement. |
| KeyDown | Occurs when a key is pressed while the control has focus. Inherited from InputElement. |
| KeyUp | Occurs when a key is released while the control has focus. Inherited from InputElement. |
| LosingFocus | Occurs before the control loses focus. Inherited from InputElement. |
| LostFocus | Occurs when the control loses focus. Inherited from InputElement. |
| Pinch | Occurs when a pinch gesture occurs on the control. Inherited from InputElement. |
| PinchEnded | Occurs when a pinch gesture ends on the control. Inherited from InputElement. |
| PointerCaptureLost | Occurs when the control or its child control loses the pointer capture for any reason, event will not be triggered for a parent control if capture was transferred to another child of that parent control. Inherited from InputElement. |
| PointerEntered | Occurs when the pointer enters the control. Inherited from InputElement. |
| PointerExited | Occurs when the pointer leaves the control. Inherited from InputElement. |
| PointerMoved | Occurs when the pointer moves over the control. Inherited from InputElement. |
| PointerPressed | Occurs when the pointer is pressed over the control. Inherited from InputElement. |
| PointerReleased | Occurs when the pointer is released over the control. Inherited from InputElement. |
| PointerTouchPadGestureMagnify | Occurs when a touchpad magnify gesture occurs on the control. Inherited from InputElement. |
| PointerTouchPadGestureRotate | Occurs when a touchpad rotate gesture occurs on the control. Inherited from InputElement. |
| PointerTouchPadGestureSwipe | Occurs when a touchpad swipe gesture occurs on the control. Inherited from InputElement. |
| PointerWheelChanged | Occurs when the mouse is scrolled over the control. Inherited from InputElement. |
| PullGesture | Occurs when a pull gesture occurs on the control. Inherited from InputElement. |
| PullGestureEnded | Occurs when a pull gesture ends on the control. Inherited from InputElement. |
| RightTapped | Occurs when a right tap gesture occurs on the control. Inherited from InputElement. |
| ScrollGesture | Occurs when a scroll gesture occurs on the control. Inherited from InputElement. |
| ScrollGestureEnded | Occurs when a scroll gesture ends on the control. Inherited from InputElement. |
| ScrollGestureInertiaStarting | Occurs when a scroll gesture inertia starts on the control. Inherited from InputElement. |
| SwipeGesture | Occurs when a swipe gesture occurs on the control. Inherited from InputElement. |
| Tapped | Occurs when a tap gesture occurs on the control. Inherited from InputElement. |
| TextInput | Occurs when a user typed some text while the control has focus. Inherited from InputElement. |
| TextInputMethodClientRequested | Occurs when an input element gains input focus and input method is looking for the corresponding client Inherited from InputElement. |
| EffectiveViewportChanged | Occurs when the element's effective viewport changes. Inherited from Layoutable. |
| LayoutUpdated | Occurs when a layout pass completes for the control. Inherited from Layoutable. |
| AttachedToVisualTree | Raised when the control is attached to a rooted visual tree. Inherited from Visual. |
| DetachedFromVisualTree | Raised when the control is detached from a rooted visual tree. Inherited from Visual. |
| ActualThemeVariantChanged | Raised when the theme variant is changed on the element or an ancestor of the element. Inherited from StyledElement. |
| AttachedToLogicalTree | Raised when the styled element is attached to a rooted logical tree. Inherited from StyledElement. |
| DataContextChanged | Occurs when the Avalonia.StyledElement.DataContext property changes. Inherited from StyledElement. |
| DetachedFromLogicalTree | Raised when the styled element is detached from a rooted logical tree. Inherited from StyledElement. |
| Initialized | Occurs when the styled element has finished initialization. Inherited from StyledElement. |
| ResourcesChanged | Occurs when a resource in this styled element or a parent styled element has changed. Inherited from StyledElement. |
| PropertyChanged | Raised when a Avalonia.AvaloniaProperty value changes on this object. Inherited from AvaloniaObject. |
ColorChanged Event
Event for when the selected color changes within the spectrum.
public event EventHandler<Avalonia.Controls.ColorChangedEventArgs> ColorChanged