In This Article

DoubleEditBox Class

Represents a Double edit box.

public class DoubleEditBox : PartEditBoxBase<double?>
Inheritance:
object Visual UIElement FrameworkElement Control PartEditBoxBase<double?> object

Constructors

DoubleEditBox()

Initializes an instance of the DoubleEditBox class.

public DoubleEditBox()

Properties

CalculatorPopupPickerStyle

Gets or sets the popup picker Style that uses a Calculator control.

public Style CalculatorPopupPickerStyle { get; set; }

Property Value

Style:

The Style that uses a Calculator control.

CanSnapToChangePrecision

Gets or sets whether the value should be snapped to the precision of the incremental change value prior to applying the increment.

public bool CanSnapToChangePrecision { get; set; }

Property Value

bool:

true if the value should be snapped to the precision of the incremental change value prior to applying the increment; otherwise, false. The default value is true.

Remarks

When true, a value of 1.24 with change value 0.1 would result in 1.3. When false, a value of 1.24 with change value 0.1 would result in 1.34.

DefaultValue

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

public double DefaultValue { get; set; }

Property Value

double:

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

Format

Gets or sets the number format string.

public string Format { get; set; }

Property Value

string:

The number format string. The default value is "G".

IsNaNAllowed

Gets or sets whether NaN is accepted as a value.

public bool IsNaNAllowed { get; set; }

Property Value

bool:

true if NaN is accepted as a value; otherwise, false. The default value is false.

IsNegativeInfinityAllowed

Gets or sets whether NegativeInfinity is accepted as a value.

public bool IsNegativeInfinityAllowed { get; set; }

Property Value

bool:

true if NegativeInfinity is accepted as a value; otherwise, false. The default value is false.

IsPositiveInfinityAllowed

Gets or sets whether PositiveInfinity is accepted as a value.

public bool IsPositiveInfinityAllowed { get; set; }

Property Value

bool:

true if PositiveInfinity is accepted as a value; otherwise, false. The default value is false.

LargeChange

Gets or sets the large change value.

public double LargeChange { get; set; }

Property Value

double:

The large change value. The default value is 5.0.

Maximum

Gets or sets the highest possible value.

public double Maximum { get; set; }

Property Value

double:

The highest possible value.

Minimum

Gets or sets the lowest possible value.

public double Minimum { get; set; }

Property Value

double:

The lowest possible value.

PickerKind

Gets or sets a DoubleEditBoxPickerKind indicating the pre-defined Style to apply to the picker used within the popup.

public DoubleEditBoxPickerKind PickerKind { get; set; }

Property Value

DoubleEditBoxPickerKind:

A DoubleEditBoxPickerKind indicating the pre-defined Style to apply to the picker used within the popup. The default value is Calculator in WPF and Default in UWP.

ResolvedFormat

Gets the resolved number format string.

public string ResolvedFormat { get; }

Property Value

string:

The resolved number format string.

RoundingDecimalPlace

Gets or sets the rounding decimal place.

public int? RoundingDecimalPlace { get; set; }

Property Value

int?:

The rounding decimal place, which is a value between 0 and 15. Pass a null value to disable rounding. The default value is 8.

SmallChange

Gets or sets the small change value.

public double SmallChange { get; set; }

Property Value

double:

The small change value. The default value is 1.0.

Methods

CoerceValidValue(double?)

Coerces the value to be within range.

protected override double? CoerceValidValue(double? value)
Parameter Type Description
value double?

The value to coerce.

Returns

double?:

The coerced value.

ConvertToString(double?)

Converts the specified value to a string representation.

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

The value.

Returns

string:

The string representation of the specified value.

CreateIncrementalChangeRequest(IncrementalChangeRequestKind)

Creates an incremental change (spin) request.

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

The kind of request.

Returns

IncrementalChangeRequest<double?>:

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(double?)

Returns whether the specified value is valid.

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

The value to examine.

Returns

bool:

true if the value is valid; otherwise, false.

ProcessTextInput(string)

Processes typed text.

protected override bool ProcessTextInput(string text)
Parameter Type Description
text string

The typed text.

Returns

bool:

true if the typed text was handled and should not be allowed to be entered; otherwise, false.

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 double?)

Tries to convert the specified text to a value.

protected override bool TryConvertFromString(string textToConvert, bool canCoerce, out double? 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 double?

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

CalculatorPopupPickerStyleProperty

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

public static readonly DependencyProperty CalculatorPopupPickerStyleProperty

CanSnapToChangePrecisionProperty

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

public static readonly DependencyProperty CanSnapToChangePrecisionProperty

DefaultValueProperty

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

public static readonly DependencyProperty DefaultValueProperty

FormatProperty

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

public static readonly DependencyProperty FormatProperty

IsNaNAllowedProperty

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

public static readonly DependencyProperty IsNaNAllowedProperty

IsNegativeInfinityAllowedProperty

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

public static readonly DependencyProperty IsNegativeInfinityAllowedProperty

IsPositiveInfinityAllowedProperty

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

public static readonly DependencyProperty IsPositiveInfinityAllowedProperty

LargeChangeProperty

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

public static readonly DependencyProperty LargeChangeProperty

MaximumProperty

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

public static readonly DependencyProperty MaximumProperty

MinimumProperty

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

public static readonly DependencyProperty MinimumProperty

PickerKindProperty

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

public static readonly DependencyProperty PickerKindProperty

ResolvedFormatProperty

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

public static readonly DependencyProperty ResolvedFormatProperty

RoundingDecimalPlaceProperty

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

public static readonly DependencyProperty RoundingDecimalPlaceProperty

SmallChangeProperty

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

public static readonly DependencyProperty SmallChangeProperty

Inherited Members