SingleEditBox Class
Represents a Single
edit box.
public class SingleEditBox : PartEditBoxBase<float?>, DUCE.IResource, IAnimatable, IFrameworkInputElement, IInputElement, ISupportInitialize, IHaveResources, IQueryAmbient
- Inheritance:
- System.Object System.Windows.Threading.DispatcherObject System.Windows.DependencyObject System.Windows.Media.Visual System.Windows.UIElement System.Windows.FrameworkElement System.Windows.Controls.Control PartEditBoxBase<System.Nullable<Single>> Object
Constructors
SingleEditBox()
Initializes an instance of the SingleEditBox
class.
public SingleEditBox()
Properties
CalculatorPopupPickerStyle
Gets or sets the popup picker System.Windows.Style that uses a Calculator control.
public Style CalculatorPopupPickerStyle { get; set; }
Property Value
- System.Windows.Style:
The System.Windows.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
- System.Boolean:
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 istrue
.
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 float DefaultValue { get; set; }
Property Value
- Single:
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
- System.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
- System.Boolean:
true
if NaN is accepted as a value; otherwise,false
. The default value isfalse
.
IsNegativeInfinityAllowed
Gets or sets whether NegativeInfinity is accepted as a value.
public bool IsNegativeInfinityAllowed { get; set; }
Property Value
- System.Boolean:
true
if NegativeInfinity is accepted as a value; otherwise,false
. The default value isfalse
.
IsPositiveInfinityAllowed
Gets or sets whether PositiveInfinity is accepted as a value.
public bool IsPositiveInfinityAllowed { get; set; }
Property Value
- System.Boolean:
true
if PositiveInfinity is accepted as a value; otherwise,false
. The default value isfalse
.
LargeChange
Gets or sets the large change value.
public float LargeChange { get; set; }
Property Value
- Single:
The large change value. The default value is
5.0
.
Maximum
Gets or sets the highest possible value.
Minimum
Gets or sets the lowest possible value.
PickerKind
Gets or sets a SingleEditBoxPickerKind indicating the pre-defined Style
to apply to the picker used within the popup.
public SingleEditBoxPickerKind PickerKind { get; set; }
Property Value
- SingleEditBoxPickerKind:
A SingleEditBoxPickerKind indicating the pre-defined
Style
to apply to the picker used within the popup. The default value isCalculator
in WPF andDefault
in UWP.
ResolvedFormat
Gets the resolved number format string.
public string ResolvedFormat { get; }
Property Value
- System.String:
The resolved number format string.
RoundingDecimalPlace
Gets or sets the rounding decimal place.
public int? RoundingDecimalPlace { get; set; }
Property Value
- System.Nullable<System.Int32>:
The rounding decimal place, which is a value between
0
and7
. Pass a null value to disable rounding. The default value is7
.
SmallChange
Gets or sets the small change value.
public float SmallChange { get; set; }
Property Value
- Single:
The small change value. The default value is
1.0
.
Methods
CoerceValidValue(Nullable<Single>)
Coerces the value to be within range.
protected override float? CoerceValidValue(float? value)
Parameter | Type | Description |
---|---|---|
value | System.Nullable<Single> | The value to coerce. |
Returns
- System.Nullable<Single>:
The coerced value.
ConvertToString(Nullable<Single>)
Converts the specified value to a string representation.
protected override string ConvertToString(float? valueToConvert)
Parameter | Type | Description |
---|---|---|
valueToConvert | System.Nullable<Single> | The value. |
Returns
- System.String:
The string representation of the specified value.
CreateIncrementalChangeRequest(IncrementalChangeRequestKind)
Creates an incremental change (spin) request.
protected override IncrementalChangeRequest<float?> CreateIncrementalChangeRequest(IncrementalChangeRequestKind kind)
Parameter | Type | Description |
---|---|---|
kind | IncrementalChangeRequestKind | The kind of request. |
Returns
- IncrementalChangeRequest<System.Nullable<Single>>:
The incremental change (spin) request that was created.
GenerateParts()
Generates the parts for the edit box.
protected override IList<IPart> GenerateParts()
Returns
- System.Collections.Generic.IList<IPart>:
The parts that were generated.
IsValidValue(Nullable<Single>)
Returns whether the specified value is valid.
protected override bool IsValidValue(float? value)
Parameter | Type | Description |
---|---|---|
value | System.Nullable<Single> | The value to examine. |
Returns
- System.Boolean:
true
if the value is valid; otherwise,false
.
ProcessTextInput(String)
Processes typed text.
protected override bool ProcessTextInput(string text)
Parameter | Type | Description |
---|---|---|
text | System.String | The typed text. |
Returns
- System.Boolean:
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, Boolean, out Nullable<Single>)
Tries to convert the specified text to a value.
protected override bool TryConvertFromString(string textToConvert, bool canCoerce, out float? value)
Parameter | Type | Description |
---|---|---|
textToConvert | System.String | The text. |
canCoerce | System.Boolean | Whether the returned value should be coerced to fall within the allowed value range. |
value | System.Nullable<Single> | Returns the value for the specified text. |
Returns
- System.Boolean:
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
- System.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
- PartEditBoxBase<Nullable<Single>>.ActivePartIndexProperty
- PartEditBoxBase<Nullable<Single>>.CommitTriggersProperty
- PartEditBoxBase<Nullable<Single>>.HasPopupProperty
- PartEditBoxBase<Nullable<Single>>.InlinesProperty
- PartEditBoxBase<Nullable<Single>>.InputScopeNameValueProperty
- PartEditBoxBase<Nullable<Single>>.IntermediateValueProperty
- PartEditBoxBase<Nullable<Single>>.IsArrowKeyPartNavigationEnabledProperty
- PartEditBoxBase<Nullable<Single>>.IsEditableProperty
- PartEditBoxBase<Nullable<Single>>.IsNullAllowedProperty
- PartEditBoxBase<Nullable<Single>>.IsPopupButtonVisibleProperty
- PartEditBoxBase<Nullable<Single>>.IsPopupOpenProperty
- PartEditBoxBase<Nullable<Single>>.IsReadOnlyProperty
- PartEditBoxBase<Nullable<Single>>.IsSpinnerVisibleProperty
- PartEditBoxBase<Nullable<Single>>.IsUndoEnabledProperty
- PartEditBoxBase<Nullable<Single>>.PlaceholderTextProperty
- PartEditBoxBase<Nullable<Single>>.PopupBackgroundProperty
- PartEditBoxBase<Nullable<Single>>.PopupBorderBrushProperty
- PartEditBoxBase<Nullable<Single>>.PopupPickerStyleProperty
- PartEditBoxBase<Nullable<Single>>.SpinWrappingProperty
- PartEditBoxBase<Nullable<Single>>.TextAlignmentProperty
- PartEditBoxBase<Nullable<Single>>.ValueProperty
- PartEditBoxBase<Nullable<Single>>.IsNonDefaultUsageContextProperty
- PartEditBoxBase<Nullable<Single>>.SpinnerVisibilityProperty
- PartEditBoxBase<Nullable<Single>>.UsageContextProperty
- PartEditBoxBase<Nullable<Single>>.Commit()
- PartEditBoxBase<Nullable<Single>>.Commit(Boolean)
- PartEditBoxBase<Nullable<Single>>.InvalidateParts()
- PartEditBoxBase<Nullable<Single>>.OnApplyTemplate()
- PartEditBoxBase<Nullable<Single>>.OnCreateAutomationPeer()
- PartEditBoxBase<Nullable<Single>>.OnGotFocus(RoutedEventArgs)
- PartEditBoxBase<Nullable<Single>>.OnIntermediateValueChanged(Nullable<Single>, Nullable<Single>)
- PartEditBoxBase<Nullable<Single>>.OnIsNullAllowedChanged(Boolean, Boolean)
- PartEditBoxBase<Nullable<Single>>.OnKeyDown(KeyEventArgs)
- PartEditBoxBase<Nullable<Single>>.OnLostFocus(RoutedEventArgs)
- PartEditBoxBase<Nullable<Single>>.OnPopupOpened()
- PartEditBoxBase<Nullable<Single>>.OnValueChanged(Nullable<Single>, Nullable<Single>)
- PartEditBoxBase<Nullable<Single>>.SelectAll()
- PartEditBoxBase<Nullable<Single>>.UpdateIntermediateValueAndTextFromValue()
- PartEditBoxBase<Nullable<Single>>.OnIsKeyboardFocusWithinChanged(DependencyPropertyChangedEventArgs)
- PartEditBoxBase<Nullable<Single>>.OnLostMouseCapture(MouseEventArgs)
- PartEditBoxBase<Nullable<Single>>.OnMouseLeftButtonDown(MouseButtonEventArgs)
- PartEditBoxBase<Nullable<Single>>.OnPreviewMouseUp(MouseButtonEventArgs)
- PartEditBoxBase<Nullable<Single>>.OnPreviewTextInput(TextCompositionEventArgs)
- PartEditBoxBase<Nullable<Single>>.ActivePartIndex
- PartEditBoxBase<Nullable<Single>>.CommitTriggers
- PartEditBoxBase<Nullable<Single>>.CurrentSelectionLength
- PartEditBoxBase<Nullable<Single>>.CurrentSelectionStartOffset
- PartEditBoxBase<Nullable<Single>>.CurrentText
- PartEditBoxBase<Nullable<Single>>.HasPopupButtonWhenReadOnly
- PartEditBoxBase<Nullable<Single>>.HasPopup
- PartEditBoxBase<Nullable<Single>>.Inlines
- PartEditBoxBase<Nullable<Single>>.InputScopeNameValue
- PartEditBoxBase<Nullable<Single>>.IntermediateValue
- PartEditBoxBase<Nullable<Single>>.IsArrowKeyPartNavigationEnabled
- PartEditBoxBase<Nullable<Single>>.IsEditable
- PartEditBoxBase<Nullable<Single>>.IsNullAllowed
- PartEditBoxBase<Nullable<Single>>.IsPopupButtonVisible
- PartEditBoxBase<Nullable<Single>>.IsPopupOpen
- PartEditBoxBase<Nullable<Single>>.IsReadOnly
- PartEditBoxBase<Nullable<Single>>.IsSpinnerVisible
- PartEditBoxBase<Nullable<Single>>.IsUndoEnabled
- PartEditBoxBase<Nullable<Single>>.Parts
- PartEditBoxBase<Nullable<Single>>.PlaceholderText
- PartEditBoxBase<Nullable<Single>>.PopupBackground
- PartEditBoxBase<Nullable<Single>>.PopupBorderBrush
- PartEditBoxBase<Nullable<Single>>.PopupPickerStyle
- PartEditBoxBase<Nullable<Single>>.ResetValueCommand
- PartEditBoxBase<Nullable<Single>>.SmallDecrementValueCommand
- PartEditBoxBase<Nullable<Single>>.SmallIncrementValueCommand
- PartEditBoxBase<Nullable<Single>>.SpinWrapping
- PartEditBoxBase<Nullable<Single>>.TextAlignment
- PartEditBoxBase<Nullable<Single>>.Value
- PartEditBoxBase<Nullable<Single>>.IsNonDefaultUsageContext
- PartEditBoxBase<Nullable<Single>>.SpinnerVisibility
- PartEditBoxBase<Nullable<Single>>.UsageContext
- Object.ToString()
- Object.Equals(Object)
- Object.Equals(Object, Object)
- Object.ReferenceEquals(Object, Object)
- Object.GetHashCode()
- Object.GetType()
- Object.MemberwiseClone()
Extension Methods
- FrameworkElementExtensions.AnimateDoubleProperty(String, Double, Double, Double, Nullable<Double>, Nullable<Double>)
- FrameworkElementExtensions.BindToProperty(DependencyProperty, Object, String, BindingMode, IValueConverter, Object)
- FrameworkElementExtensions.BindToProperty(DependencyProperty, Object, DependencyProperty, BindingMode, IValueConverter, Object)
- FrameworkElementExtensions.GetCurrentSize()