Class IntegerTextBox

Inheritance
System.Object
EditorBase
IntegerTextBox
Implements
System.IDisposable
Inherited Members
Namespace: Syncfusion.Windows.Shared
Assembly: Syncfusion.Shared.WPF.dll
Syntax
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
public class IntegerTextBox : EditorBase, IDisposable

Constructors

IntegerTextBox()

Initializes a new instance of the IntegerTextBox class

Declaration
public IntegerTextBox()

Fields

GroupSeperatorEnabledProperty

Identifies the GroupSeperatorEnabled dependency property.

Declaration
public static readonly DependencyProperty GroupSeperatorEnabledProperty
Field Value
Type
System.Windows.DependencyProperty
Remarks

The identifier for the GroupSeperatorEnabled dependency property.

InvalidValueBehaviorProperty

Identifies the InvalidValueBehavior dependency property.

Declaration
public static readonly DependencyProperty InvalidValueBehaviorProperty
Field Value
Type
System.Windows.DependencyProperty
Remarks

The identifier for the InvalidValueBehavior dependency property.

MaxValueProperty

Identifies the MaxValue dependency property.

Declaration
public static readonly DependencyProperty MaxValueProperty
Field Value
Type
System.Windows.DependencyProperty
Remarks

The identifier for the MaxValue dependency property.

MinValueProperty

Identifies the MinValue dependency property.

Declaration
public static readonly DependencyProperty MinValueProperty
Field Value
Type
System.Windows.DependencyProperty
Remarks

The identifier for the MinValue dependency property.

NullValueProperty

Identifies the NullValue dependency property.

Declaration
public static readonly DependencyProperty NullValueProperty
Field Value
Type
System.Windows.DependencyProperty
Remarks

The identifier for the NullValue dependency property.

NumberGroupSeparatorProperty

Identifies the NumberGroupSeparator dependency property.

Declaration
public static readonly DependencyProperty NumberGroupSeparatorProperty
Field Value
Type
System.Windows.DependencyProperty
Remarks

The identifier for the NumberGroupSeparator dependency property.

NumberGroupSizesProperty

Identifies the NumberGroupSizes dependency property.

Declaration
public static readonly DependencyProperty NumberGroupSizesProperty
Field Value
Type
System.Windows.DependencyProperty
Remarks

The identifier for the NumberGroupSizes dependency property.

ScrollIntervalProperty

Identifies the ScrollInterval dependency property.

Declaration
public static readonly DependencyProperty ScrollIntervalProperty
Field Value
Type
System.Windows.DependencyProperty
Remarks

The identifier for the ScrollInterval dependency property.

ValidationCompletedProperty

Identifies the ValidationCompleted dependency property.

Declaration
public static readonly DependencyProperty ValidationCompletedProperty
Field Value
Type
System.Windows.DependencyProperty
Remarks

The identifier for the ValidationCompleted dependency property.

ValidationValueProperty

Identifies the ValidationValue dependency property.

Declaration
public static readonly DependencyProperty ValidationValueProperty
Field Value
Type
System.Windows.DependencyProperty
Remarks

The identifier for the ValidationValue dependency property.

ValueProperty

Identifies the Value dependency property.

Declaration
public static readonly DependencyProperty ValueProperty
Field Value
Type
System.Windows.DependencyProperty
Remarks

The identifier for the Value dependency property.

ValueValidationProperty

Identifies the ValidationValue dependency property.

Declaration
public static readonly DependencyProperty ValueValidationProperty
Field Value
Type
System.Windows.DependencyProperty
Remarks

The identifier for the ValidationValue dependency property.

Properties

copycommand

Gets the value that represents the Copy command.

Declaration
public ICommand copycommand { get; }
Property Value
Type
System.Windows.Input.ICommand

cutcommand

Gets the value that represents the Cut command.

Declaration
public ICommand cutcommand { get; }
Property Value
Type
System.Windows.Input.ICommand

GroupSeperatorEnabled

Declaration
public bool GroupSeperatorEnabled { get; set; }
Property Value
Type Description
System.Boolean

Returns boolean value. The default value is true.

InvalidValueBehavior

Gets or sets the way of IntegerTextBox reaction on wrong input data.

Declaration
public InvalidInputBehavior InvalidValueBehavior { get; set; }
Property Value
Type
InvalidInputBehavior

MaxValue

Gets or sets the maximum value of the IntegerTextBox.

Declaration
public long MaxValue { get; set; }
Property Value
Type Description
System.Int64

The integer value. The default value is MinValue.

MinValue

Gets or sets the minimum value of the IntegerTextBox.

Declaration
public long MinValue { get; set; }
Property Value
Type Description
System.Int64

The integer value. The default value is MinValue.

NullValue

Gets or sets the null value of IntegerTextBox.

Declaration
public Nullable<long> NullValue { get; set; }
Property Value
Type Description
System.Nullable<System.Int64>

The integer value. The default value is null.

NumberGroupSeparator

Gets or Sets the value that indicates the number group separator of IntegerTextBox value.

Declaration
public string NumberGroupSeparator { get; set; }
Property Value
Type Description
System.String

A string contains the Special characters of Value. The default is string.Empty.

NumberGroupSizes

Gets or sets the value indicating the number group size of the Value.

Declaration
public Int32Collection NumberGroupSizes { get; set; }
Property Value
Type
System.Windows.Media.Int32Collection

pastecommand

Gets the value that represents the Paste command.

Declaration
public ICommand pastecommand { get; }
Property Value
Type
System.Windows.Input.ICommand

ProgressFactor

Gets the value indicating the progress factor of the IntegerTextBox.

Declaration
public double ProgressFactor { get; }
Property Value
Type
System.Double

ScrollInterval

Gets or sets the scroll interval of IntegerTextBox.

Declaration
public int ScrollInterval { get; set; }
Property Value
Type Description
System.Int32

The integer value. The default value is 1.

ValidationCompleted

Declaration
public bool ValidationCompleted { get; set; }
Property Value
Type Description
System.Boolean

Returns boolean value. The default value is false.

ValidationValue

Gets or Sets the string that the formatted input string is being validated.

Declaration
public string ValidationValue { get; set; }
Property Value
Type Description
System.String

A string containing the text contents of the text box. The default is an String.Empty

Value

Gets or sets the value of IntegerTextBox.

Declaration
public Nullable<long> Value { get; set; }
Property Value
Type Description
System.Nullable<System.Int64>

The integer value. The default value is null.

ValueValidation

Gets or sets the value validation mode for IntegerTextBox.

Declaration
public StringValidation ValueValidation { get; set; }
Property Value
Type Description
StringValidation

The value validation mode. The Default value is StringValidation.OnLostFocus.

Methods

add_ValueValidationCompleted(StringValidationCompletedEventHandler)

Declaration
public void add_ValueValidationCompleted(StringValidationCompletedEventHandler value)
Parameters
Type Name Description
StringValidationCompletedEventHandler value

Dispose()

Dispose the IntegerTextBox.

Declaration
public void Dispose()

OnApplyTemplate()

Invoked before the UI element displays in an application.

Declaration
public override void OnApplyTemplate()

OnContextMenuOpening(ContextMenuEventArgs)

Invoked when System.Windows.FrameworkElement.ContextMenuOpening event occurs.

Declaration
protected override void OnContextMenuOpening(ContextMenuEventArgs e)
Parameters
Type Name Description
System.Windows.Controls.ContextMenuEventArgs e

The System.Windows.Controls.ContextMenuEventArgs that contains the event data.
Overrides

OnGotFocus(RoutedEventArgs)

Invoked before System.Windows.UIElement.GotFocus event occurs.

Declaration
protected override void OnGotFocus(RoutedEventArgs e)
Parameters
Type Name Description
System.Windows.RoutedEventArgs e

The System.Windows.RoutedEventArgs that contains the event data.
Overrides

OnInvalidValueBehaviorChanged(DependencyObject, DependencyPropertyChangedEventArgs)

Invoked when InvalidValueBehavior property changed.

Declaration
public static void OnInvalidValueBehaviorChanged(DependencyObject obj, DependencyPropertyChangedEventArgs args)
Parameters
Type Name Description
System.Windows.DependencyObject obj

The obj contains a IntegerTextBox.
System.Windows.DependencyPropertyChangedEventArgs args

The System.Windows.DependencyPropertyChangedEventArgs that contains the event data.

OnInvalidValueBehaviorChanged(DependencyPropertyChangedEventArgs)

Invoked when InvalidValueBehavior property changed.

Declaration
protected void OnInvalidValueBehaviorChanged(DependencyPropertyChangedEventArgs args)
Parameters
Type Name Description
System.Windows.DependencyPropertyChangedEventArgs args

The System.Windows.DependencyPropertyChangedEventArgs that contains the event data.

OnKeyDown(KeyEventArgs)

Invoked when System.Windows.UIElement.KeyDown event occurs.

Declaration
protected override void OnKeyDown(KeyEventArgs e)
Parameters
Type Name Description
System.Windows.Input.KeyEventArgs e

The System.Windows.Input.KeyEventArgs that contains the event data.

OnLostFocus(RoutedEventArgs)

Invoked before System.Windows.UIElement.LostFocus event occurs.

Declaration
protected override void OnLostFocus(RoutedEventArgs e)
Parameters
Type Name Description
System.Windows.RoutedEventArgs e

The System.Windows.RoutedEventArgs that contains the event data.
Overrides

OnMaxValueChanged(DependencyObject, DependencyPropertyChangedEventArgs)

Invoked when the MaxValue property changed.

Declaration
public static void OnMaxValueChanged(DependencyObject obj, DependencyPropertyChangedEventArgs args)
Parameters
Type Name Description
System.Windows.DependencyObject obj

The obj contains a IntegerTextBox.
System.Windows.DependencyPropertyChangedEventArgs args

The System.Windows.DependencyPropertyChangedEventArgs that contains the event data.

OnMaxValueChanged(DependencyPropertyChangedEventArgs)

Invoked when the MaxValue property changed.

Declaration
protected void OnMaxValueChanged(DependencyPropertyChangedEventArgs args)
Parameters
Type Name Description
System.Windows.DependencyPropertyChangedEventArgs args

The System.Windows.DependencyPropertyChangedEventArgs that contains the event data.

OnMinValueChanged(DependencyObject, DependencyPropertyChangedEventArgs)

Invoked when the MinValue property changed.

Declaration
public static void OnMinValueChanged(DependencyObject obj, DependencyPropertyChangedEventArgs args)
Parameters
Type Name Description
System.Windows.DependencyObject obj

The obj contains a IntegerTextBox.
System.Windows.DependencyPropertyChangedEventArgs args

The System.Windows.DependencyPropertyChangedEventArgs that contains the event data.

OnMinValueChanged(DependencyPropertyChangedEventArgs)

Invoked when the MaxValue property changed.

Declaration
protected void OnMinValueChanged(DependencyPropertyChangedEventArgs args)
Parameters
Type Name Description
System.Windows.DependencyPropertyChangedEventArgs args

The System.Windows.DependencyPropertyChangedEventArgs that contains the event data.

OnMouseWheel(MouseWheelEventArgs)

Invoked when the System.Windows.UIElement.MouseWheel event occurs.

Declaration
protected override void OnMouseWheel(MouseWheelEventArgs e)
Parameters
Type Name Description
System.Windows.Input.MouseWheelEventArgs e

The System.Windows.Input.MouseWheelEventArgs that contains the event data.

OnNullValueChanged(DependencyObject, DependencyPropertyChangedEventArgs)

Invoked when NullValue property changed.

Declaration
public static void OnNullValueChanged(DependencyObject obj, DependencyPropertyChangedEventArgs args)
Parameters
Type Name Description
System.Windows.DependencyObject obj

The obj contains a IntegerTextBox.
System.Windows.DependencyPropertyChangedEventArgs args

The System.Windows.DependencyPropertyChangedEventArgs that contains the event data.

OnNullValueChanged(DependencyPropertyChangedEventArgs)

Invoked when NullValue property changed.

Declaration
protected void OnNullValueChanged(DependencyPropertyChangedEventArgs args)
Parameters
Type Name Description
System.Windows.DependencyPropertyChangedEventArgs args

The args contains value of IntegerTextBox.

OnNumberGroupSeparatorChanged(DependencyPropertyChangedEventArgs)

Invoked when NumberGroupSeparator property changed.

Declaration
protected virtual void OnNumberGroupSeparatorChanged(DependencyPropertyChangedEventArgs e)
Parameters
Type Name Description
System.Windows.DependencyPropertyChangedEventArgs e

The System.Windows.DependencyPropertyChangedEventArgs that contains the event data.

OnNumberGroupSizesChanged(DependencyObject, DependencyPropertyChangedEventArgs)

Invoked when NumberGroupSizes property changed.

Declaration
public static void OnNumberGroupSizesChanged(DependencyObject obj, DependencyPropertyChangedEventArgs args)
Parameters
Type Name Description
System.Windows.DependencyObject obj

The obj contains a IntegerTextBox.
System.Windows.DependencyPropertyChangedEventArgs args

The System.Windows.DependencyPropertyChangedEventArgs that contains the event data.

OnNumberGroupSizesChanged(DependencyPropertyChangedEventArgs)

Invoked when NumberGroupSizes property changed.

Declaration
protected void OnNumberGroupSizesChanged(DependencyPropertyChangedEventArgs args)
Parameters
Type Name Description
System.Windows.DependencyPropertyChangedEventArgs args

The System.Windows.DependencyPropertyChangedEventArgs that contains the event data.

OnPreviewKeyDown(KeyEventArgs)

Invoked when the System.Windows.Input.Keyboard.PreviewKeyDownEvent attached routed event occurs.

Declaration
protected override void OnPreviewKeyDown(KeyEventArgs e)
Parameters
Type Name Description
System.Windows.Input.KeyEventArgs e

The System.Windows.Input.KeyEventArgs that contains the event data.
Overrides

OnPreviewLostKeyboardFocus(KeyboardFocusChangedEventArgs)

Invoked when the keyboard is not focused on this element

Declaration
protected override void OnPreviewLostKeyboardFocus(KeyboardFocusChangedEventArgs e)
Parameters
Type Name Description
System.Windows.Input.KeyboardFocusChangedEventArgs e

The System.Windows.Input.KeyboardFocusChangedEventArgs that contains the event data.

OnTextInput(TextCompositionEventArgs)

Invoked before the System.Windows.UIElement.TextInput event occurs.

Declaration
protected override void OnTextInput(TextCompositionEventArgs e)
Parameters
Type Name Description
System.Windows.Input.TextCompositionEventArgs e

The System.Windows.Input.TextCompositionEventArgs that contains the event data.

OnUseNullOptionChanged(DependencyPropertyChangedEventArgs)

Invoked when UseNullOption property changed.

Declaration
public override void OnUseNullOptionChanged(DependencyPropertyChangedEventArgs args)
Parameters
Type Name Description
System.Windows.DependencyPropertyChangedEventArgs args

The System.Windows.DependencyPropertyChangedEventArgs that contains the event data.
Overrides

OnValidationCompletedPropertyChanged(DependencyObject, DependencyPropertyChangedEventArgs)

Invoked when ValidationCompleted property changed.

Declaration
public static void OnValidationCompletedPropertyChanged(DependencyObject obj, DependencyPropertyChangedEventArgs args)
Parameters
Type Name Description
System.Windows.DependencyObject obj

The obj contains a IntegerTextBox.
System.Windows.DependencyPropertyChangedEventArgs args

The System.Windows.DependencyPropertyChangedEventArgs that contains the event data.

OnValidationCompletedPropertyChanged(DependencyPropertyChangedEventArgs)

Invoked when ValidationCompleted property changed.

Declaration
protected void OnValidationCompletedPropertyChanged(DependencyPropertyChangedEventArgs args)
Parameters
Type Name Description
System.Windows.DependencyPropertyChangedEventArgs args

The System.Windows.DependencyPropertyChangedEventArgs that contains the event data.

OnValidationValueChanged(DependencyObject, DependencyPropertyChangedEventArgs)

Invoked when ValidationValue property changed.

Declaration
public static void OnValidationValueChanged(DependencyObject obj, DependencyPropertyChangedEventArgs args)
Parameters
Type Name Description
System.Windows.DependencyObject obj

The obj contains a IntegerTextBox.
System.Windows.DependencyPropertyChangedEventArgs args

The System.Windows.DependencyPropertyChangedEventArgs that contains the event data.

OnValidationValueChanged(DependencyPropertyChangedEventArgs)

Invoked when NullValue property changed.

Declaration
protected void OnValidationValueChanged(DependencyPropertyChangedEventArgs args)
Parameters
Type Name Description
System.Windows.DependencyPropertyChangedEventArgs args

The System.Windows.DependencyPropertyChangedEventArgs that contains the event data.

OnValueChanged(DependencyObject, DependencyPropertyChangedEventArgs)

Invoked when the Value property changed.

Declaration
public static void OnValueChanged(DependencyObject obj, DependencyPropertyChangedEventArgs args)
Parameters
Type Name Description
System.Windows.DependencyObject obj

The obj contains a IntegerTextBox.
System.Windows.DependencyPropertyChangedEventArgs args

The System.Windows.DependencyPropertyChangedEventArgs that contains the event data.

OnValueChanged(DependencyPropertyChangedEventArgs)

Invoked when the Value property changed.

Declaration
protected void OnValueChanged(DependencyPropertyChangedEventArgs args)
Parameters
Type Name Description
System.Windows.DependencyPropertyChangedEventArgs args

The System.Windows.DependencyPropertyChangedEventArgs that contains the event data.

remove_ValueValidationCompleted(StringValidationCompletedEventHandler)

Declaration
public void remove_ValueValidationCompleted(StringValidationCompletedEventHandler value)
Parameters
Type Name Description
StringValidationCompletedEventHandler value

Events

InvalidValueBehaviorChanged

Occurs when the InvalidValueBehavior property is changed.

Declaration
public event PropertyChangedCallback InvalidValueBehaviorChanged
Event Type
Type
System.Windows.PropertyChangedCallback

MaxValueChanged

Occurs when the MaxValue property is changed.

Declaration
public event PropertyChangedCallback MaxValueChanged
Event Type
Type
System.Windows.PropertyChangedCallback

MinValueChanged

Occurs when the MinValue property is changed.

Declaration
public event PropertyChangedCallback MinValueChanged
Event Type
Type
System.Windows.PropertyChangedCallback

NumberGroupSeparatorChanged

Occurs when the NumberGroupSeparator property is changed.

Declaration
public event PropertyChangedCallback NumberGroupSeparatorChanged
Event Type
Type
System.Windows.PropertyChangedCallback

NumberGroupSizesChanged

Occurs when the NumberGroupSizes property is changed.

Declaration
public event PropertyChangedCallback NumberGroupSizesChanged
Event Type
Type
System.Windows.PropertyChangedCallback

Validated

Occurs after validating the Value.

Declaration
public event EventHandler Validated
Event Type
Type
System.EventHandler

Validating

Occurs when validating the Value.

Declaration
public event CancelEventHandler Validating
Event Type
Type
System.ComponentModel.CancelEventHandler

ValidationCompletedChanged

Occurs when the ValidationCompleted property is changed.

Declaration
public event PropertyChangedCallback ValidationCompletedChanged
Event Type
Type
System.Windows.PropertyChangedCallback

ValidationValueChanged

Occurs when the ValidationValue property is changed.

Declaration
public event PropertyChangedCallback ValidationValueChanged
Event Type
Type
System.Windows.PropertyChangedCallback

ValueChanged

Occurs when the Value property is changed.

Declaration
public event PropertyChangedCallback ValueChanged
Event Type
Type
System.Windows.PropertyChangedCallback

ValueValidationCompleted

Occurs when the Value validation completed.

Declaration
public event StringValidationCompletedEventHandler ValueValidationCompleted
Event Type
Type
StringValidationCompletedEventHandler

Implements

System.IDisposable