In This Article

ColorEditBox Class

Represents a Color edit box.

public class ColorEditBox : PartEditBoxBase<Color?>
Inheritance:
object Visual UIElement FrameworkElement Control PartEditBoxBase<Color?> object

Constructors

ColorEditBox()

Initializes an instance of the ColorEditBox class.

public ColorEditBox()

Properties

DefaultValue

Gets or sets the value to set when incrementing/decrementing from a null value.

public Color DefaultValue { get; set; }

Property Value

Color:

The value to set when incrementing/decrementing from a null value. The default value is Red.

HasPopupButtonWhenReadOnly

Gets whether the control should display the popup button when the control is read-only.

protected override bool HasPopupButtonWhenReadOnly { get; }

Property Value

bool:

true if the control should display the popup button when the control is read-only; otherwise, false.

HasSwatch

Gets or sets whether the edit box should display a swatch that previews the Value.

public bool HasSwatch { get; set; }

Property Value

bool:

true if the edit box should display a swatch that previews the Value; otherwise, false. The default value is true.

HasText

Gets or sets whether the edit box should display a text representation of the Value.

public bool HasText { get; set; }

Property Value

bool:

true if the edit box should display a text representation of the Value; otherwise, false. The default value is true.

IsAlphaEnabled

Gets or sets whether the alpha channel (transparency) of the color value is enabled.

public bool IsAlphaEnabled { get; set; }

Property Value

bool:

true if the alpha channel (transparency) of the color value is enabled; otherwise, false. The default value is true.

Remarks

When disabled, no transparency is supported.

IsInitialValueComparedOnPopup

Gets or sets a value indicating whether the initial color value is compared to the current value in the popup color picker.

public bool IsInitialValueComparedOnPopup { get; set; }

Property Value

bool:

true if the initial color value is compared to the current value in the popup color picker; otherwise false. The default value is true.

SwatchBrush

Gets the Brush that renders a sample swatch.

public Brush SwatchBrush { get; }

Property Value

Brush:

The Brush that renders a sample swatch.

SwatchMargin

Gets or sets the Thickness of the margin around the sample swatch.

public Thickness SwatchMargin { get; set; }

Property Value

Thickness:

The Thickness of the margin around the sample swatch.

Methods

ConvertToString(Color?)

Converts the specified value to a string representation.

protected override string ConvertToString(Color? valueToConvert)
Parameter Type Description
valueToConvert Color?

The value.

Returns

string:

The string representation of the specified value.

CreateIncrementalChangeRequest(IncrementalChangeRequestKind)

Creates an incremental change (spin) request.

protected override IncrementalChangeRequest<Color?> CreateIncrementalChangeRequest(IncrementalChangeRequestKind kind)
Parameter Type Description
kind IncrementalChangeRequestKind

The kind of request.

Returns

IncrementalChangeRequest<Color?>:

The incremental change (spin) request that was created.

GenerateParts()

Generates the parts for the edit box.

protected override IList<IPart> GenerateParts()

Returns

IList<IPart>:

The parts that were generated.

IsValidValue(Color?)

Returns whether the specified value is valid.

protected override bool IsValidValue(Color? value)
Parameter Type Description
value Color?

The value to examine.

Returns

bool:

true if the value is valid; otherwise, false.

OnApplyTemplate()

Invoked whenever application code or internal processes call ApplyTemplate.

public override void OnApplyTemplate()

OnIntermediateValueChanged(Color?, Color?)

Invoked when the value of the IntermediateValue property changes.

protected override void OnIntermediateValueChanged(Color? oldValue, Color? newValue)
Parameter Type Description
oldValue Color?

The old value of the property.

newValue Color?

The new value of the property.

OnPopupOpened()

Occurs when the popup is opened.

protected override void OnPopupOpened()

RaiseValueChangedEvent()

Raises the ValueChanged event.

protected override void RaiseValueChangedEvent()

ResetValue()

Resets the value to a default value.

protected override void ResetValue()

TryConvertFromString(string, bool, out Color?)

Tries to convert the specified text to a value.

protected override bool TryConvertFromString(string textToConvert, bool canCoerce, out Color? value)
Parameter Type Description
textToConvert string

The text.

canCoerce bool

Whether the returned value should be coerced to fall within the allowed value range.

value Color?

Returns the value for the specified text.

Returns

bool:

true if the text was converted to a value successfully; otherwise, false.

Events

ValueChanged

Occurs after the Value property value changes.

public event EventHandler ValueChanged

Event Type

EventHandler

Fields

DefaultValueProperty

Identifies the DefaultValue dependency property. This field is read-only.

public static readonly DependencyProperty DefaultValueProperty

HasSwatchProperty

Identifies the HasSwatch dependency property. This field is read-only.

public static readonly DependencyProperty HasSwatchProperty

HasTextProperty

Identifies the HasText dependency property. This field is read-only.

public static readonly DependencyProperty HasTextProperty

IsAlphaEnabledProperty

Identifies the IsAlphaEnabled dependency property. This field is read-only.

public static readonly DependencyProperty IsAlphaEnabledProperty

IsInitialValueComparedOnPopupProperty

Identifies the IsInitialValueComparedOnPopup dependency property. This field is read-only.

public static readonly DependencyProperty IsInitialValueComparedOnPopupProperty

SwatchBrushProperty

Identifies the SwatchBrush dependency property. This field is read-only.

public static readonly DependencyProperty SwatchBrushProperty

SwatchMarginProperty

Identifies the SwatchMargin dependency property. This field is read-only.

public static readonly DependencyProperty SwatchMarginProperty

Inherited Members