Class SolidColorChannelEditor
Represents a control to pick a Microsoft.UI.Xaml.Media.SolidColorBrush using TextInput and Slider.
Inheritance
Implements
Namespace: Syncfusion.UI.Xaml.Editors
Assembly: Syncfusion.Editors.WinUI.dll
Syntax
public class SolidColorChannelEditor : Control, IDisposable
Constructors
SolidColorChannelEditor()
Initializes a new instance of the SolidColorChannelEditor class.
Declaration
public SolidColorChannelEditor()
Fields
AlphaInputOptionsProperty
Identifies AlphaInputOptions dependency property.
Declaration
public static readonly DependencyProperty AlphaInputOptionsProperty
Field Value
Type |
---|
Microsoft.UI.Xaml.DependencyProperty |
ColorChannelInputOptionsProperty
Identifies ColorChannelInputOptions dependency property.
Declaration
public static readonly DependencyProperty ColorChannelInputOptionsProperty
Field Value
Type |
---|
Microsoft.UI.Xaml.DependencyProperty |
ColorChannelOptionsProperty
Identifies ColorChannelOptions dependency property.
Declaration
public static readonly DependencyProperty ColorChannelOptionsProperty
Field Value
Type |
---|
Microsoft.UI.Xaml.DependencyProperty |
ColorEditorsVisibilityModeProperty
Identifies ColorEditorsVisibilityMode dependency property.
Declaration
public static readonly DependencyProperty ColorEditorsVisibilityModeProperty
Field Value
Type |
---|
Microsoft.UI.Xaml.DependencyProperty |
ColorInfoProperty
Identifies ColorInfo dependency property.
Declaration
public static readonly DependencyProperty ColorInfoProperty
Field Value
Type |
---|
Microsoft.UI.Xaml.DependencyProperty |
IsHexInputVisibleProperty
Identifies IsHexInputVisible dependency property.
Declaration
public static readonly DependencyProperty IsHexInputVisibleProperty
Field Value
Type |
---|
Microsoft.UI.Xaml.DependencyProperty |
Properties
AlphaInputOptions
Gets or sets a value that indicates whether the alpha channel can be edited using TextInput, Slider or both.
Declaration
public ColorInputOptions AlphaInputOptions { get; set; }
Property Value
Type | Description |
---|---|
ColorInputOptions | A value of enumeration. The default value is All. |
ColorChannelInputOptions
Gets or sets a value that indicates the type of editor (TextInput, Slider or both) to edit the color value.
Declaration
public ColorInputOptions ColorChannelInputOptions { get; set; }
Property Value
Type | Description |
---|---|
ColorInputOptions | A value of enumeration. The default value in All. |
Remarks
When TextInput is set, value can be edited using a text editor. When Slider is set, value can be edited using a slider. When All is set, value can be edited using a slider and text editor.
ColorChannelOptions
Gets or sets one or more supported channel options (RGB, HSL, HSV, CMYK) to edit color, that can be toggle interactively.
Declaration
public ColorChannelOptions ColorChannelOptions { get; set; }
Property Value
Type | Description |
---|---|
ColorChannelOptions | A value of enumeration. The default is All. |
Remarks
A ComboBox will be shown when multiple types are set. Microsoft.UI.Xaml.Controls.ComboBox will be hidden, when there is only one option is set.
ColorEditorsVisibilityMode
Gets or sets a value to control the visibility of color channel editors.
Declaration
public ColorEditorsVisibilityMode ColorEditorsVisibilityMode { get; set; }
Property Value
Type | Description |
---|---|
ColorEditorsVisibilityMode | A value of enumeration. The default is Inline. |
Remarks
When value is Inline, editor is always visible. When value is Expandable, editor can be collapsed using an Expander. When value is Collapsed, editor will not be visible.
ColorInfo
Gets or sets a wrapper class for Microsoft.UI.Xaml.Media.SolidColorBrush used for color composition.
Declaration
public SolidColorInfo ColorInfo { get; set; }
Property Value
Type |
---|
SolidColorInfo |
IsHexInputVisible
Gets or sets a value indicating whether the text input box for a HEX color value is shown.
Declaration
public bool IsHexInputVisible { get; set; }
Property Value
Type |
---|
System.Boolean |
Remarks
true if the HEX color text input box is shown; otherwise, false. The default is true.
Methods
Dispose()
Release the unmanaged resources of SolidColorChannelEditor.
Declaration
public void Dispose()
Dispose(Boolean)
Release the unmanaged resources of SolidColorChannelEditor.
Declaration
protected virtual void Dispose(bool disposing)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | disposing | Used to indicate perform dispose or not. |
OnApplyTemplate()
Declaration
protected override void OnApplyTemplate()