BrushEditBox Class

public class BrushEditBox : PartEditBoxBase<Brush>

public BrushEditBox()

public bool CanReuseBrush { get; set; }

Property Value

bool:

true if the Brush value can simply have components like gradient stops updated instead of requiring a new brush to be created on any update; otherwise, false. The default value is true.

Remarks

Set this to false in scenarios where ValueChanged events need to fire on any update, or when binding to Value using value converters.

public bool CanSwatchStretch { get; set; }

Property Value

bool:

true if the swatch can stretch when HasText is false; otherwise, false. The default value is true.

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.

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.

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.

public bool IsAlphaEnabled { get; set; }

Property Value

bool:

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

Remarks

When disabled, no transparency is supported.

public bool IsGradientAllowed { get; set; }

Property Value

bool:

true if gradient brush values can be entered; otherwise, false. The default value is true.

public Brush? SwatchBrush { get; }

Property Value

Brush

public Thickness SwatchMargin { get; set; }

Property Value

Thickness

protected override string? ConvertToString(Brush? valueToConvert)

Parameter	Type	Description
valueToConvert	Brush	The value.

Returns

string:

The string representation of the specified value.

protected override IncrementalChangeRequest<Brush>? CreateIncrementalChangeRequest(IncrementalChangeRequestKind kind)

Parameter	Type	Description
kind	IncrementalChangeRequestKind	The kind of request.

Returns

IncrementalChangeRequest<Brush>:

The incremental change (spin) request that was created.

protected override IList<IPart> GenerateParts()

Returns

IList<IPart>:

The parts that were generated.

protected override bool IsTextInputAllowed(string text)

Parameter	Type	Description
text	string	The text to examine.

Returns

bool:

true if the text input is allowed; otherwise, false.

See Also

• IsInputFilteringEnabled

protected override bool IsValidValue(Brush? value)

Parameter	Type	Description
value	Brush	The value to examine.

Returns

bool:

true if the value is valid; otherwise, false.

public override void OnApplyTemplate()

protected override void OnIntermediateValueChanged(Brush? oldValue, Brush? newValue)

Parameter	Type	Description
oldValue	Brush	The old value of the property.
newValue	Brush	The new value of the property.

protected override void ResetValue()

protected override bool TryConvertFromString(string? textToConvert, bool canCoerce, out Brush? 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	Brush	Returns the value for the specified text.

Returns

bool:

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

public static readonly DependencyProperty CanReuseBrushProperty

public static readonly DependencyProperty CanSwatchStretchProperty

public static readonly DependencyProperty HasSwatchProperty

public static readonly DependencyProperty HasTextProperty

public static readonly DependencyProperty IsAlphaEnabledProperty

public static readonly DependencyProperty IsGradientAllowedProperty

public static readonly DependencyProperty SwatchBrushProperty

public static readonly DependencyProperty SwatchMarginProperty