tsai
/
wpftoolkit
mirror of https://github.com/xceedsoftware/wpftoolkit.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Updated SingleUpDown (markdown)

master
DianeXceed 9 years ago
parent
ffdfeb717e
commit
190856ab2f
1 changed files with 60 additions and 60 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 120
      SingleUpDown.md

120
SingleUpDown.md

@ -1,82 +1,82 @@
# SingleUpDown
The SingleUpDown control provides a TextBox with button spinners that allow incrementing and decrementing Nullable<single> values by using the spinner buttons, keyboard up/down arrows, or mouse wheel.
* [Usage](#usage)
* [Applying Format Strings](#formatstring)
* [Supported Format Strings](#supportedformatstring)
* [Watermark](#watermarks)
* [Applying Format Strings](#applying-format-strings)
* [Supported Format Strings](#supported-format-strings)
* [Watermark](#watermark)
* [Properties](#properties)
* [Events](#events)
{anchor:usage}
## Usage
When using the SingleUpDown in data binding scenarios, bind your object's value to the **Value** property. You can specify how much to increment the value by setting the **Increment** property. You can control the minimum and maximum allowed values by setting the **Minimum** and the **Maximum** properties. Use IsReadOnly to determine whether the control is read only. If you would like to get the actual fromatted string representation of the value, you can use the **Text** property.
### Usage
When using the SingleUpDown in data binding scenarios, bind your object's value to the **Value** property. You can specify how much to increment the value by setting the **Increment** property. You can control the minimum and maximum allowed values by setting the **Minimum** and the **Maximum** properties. Use IsReadOnly to determine whether the control is read only. If you would like to get the actual formatted string representation of the value, you can use the **Text** property.
{anchor:formatstring}
## Applying FormatStrings
### Applying Format Strings
**Default:**
{{
<xctk:SingleUpDown Value="1564.674" />}}
```
<xctk:SingleUpDown Value="1564.674" />
```
**Floating Point:**
{{
```
<xctk:SingleUpDown FormatString="F3" Value="1564.674" Increment=".001" Maximum="200000.599" />
}}
```
**Currency:**
{{
```
<xctk:SingleUpDown FormatString="C2" Value="1564.674" Increment=".5" Maximum="5000.50" Minimum="50.01" />
}}
{anchor:supportedformatstring}
## Supported Format Strings
```
|| Format Specifier || Name
| C | Currency
| F | Fixed Point
| G | General
| N | Number
| P | Percent
### Supported Format Strings
| Format Specifier | Name |
| --- | --- |
| C | Currency |
| F | Fixed Point |
| G | General |
| N | Number |
| P | Percent |
{anchor:watermarks}
## Watermark
### Watermark
You can provide a **Watermark** to show text in place of a NULL **Value**.
{{
```
<xctk:SingleUpDown Watermark="Enter value" />
}}
{anchor:properties}
## Properties
|| Property || Description
| AllowSpin | Gets or sets the ability to perform increment/decrement operations via the keyboard, button spinners, or mouse wheel. (Inherited from UpDownBase)
| AllowTextInput | Determines if the editable part of the control can be edited. The editable part does not include buttons or spinners, it is typically the text part.
| AutoMoveFocus | Gets or sets if the focus can move from this control to other controls. (Inherited from NumericUpDown)
| AutoSelectBehavior | Gets or sets a value indicating how the content of the auto-select text box is selected (Never or OnFocus). By default, OnFocus. (Inherited from NumericUpDown)
| ButtonSpinnerLocation | Gets/Sets the location of the Up/Down buttons (either on the left or on the right) of numericUpDown controls.
| ClipValueToMinMax | Gets or sets if the value should be clipped when minimum/maximum is reached. (Inherited from UpDownBase)
| CultureInfo | Gets or sets the current CultureInfo. (Inherited from InputBase)
| DefaultValue | Gets or sets the value to use when the **Value** is null and an increment/decrement operation is performed. (Inherited from UpDownBase)
| DisplayDefaultValueOnEmptyText | Gets or sets if the defaultValue should be displayed when the Text is empty. (Inherited from UpDownBase)
| FormatString | Gets or sets the dispaly format of the **Value**.
| Increment | Gets or sets the amount in which to increment the value. (Inherited from NumericUpDown)
| IsReadOnly | Gets or sets if the control is read only. (Inherited from InputBase)
| Maximum | Gets or sets the maximum allowed value. (Inherited from UpDownBase)
| Minimum | Gets or sets the minimum allowed value. (Inherited from UpDownBase)
| MouseWheelActiveTrigger | Gets or sets when the MouseWheel is active (Focused, FocusedMouseOver, MouseOver, Disabled). By default, FocusedMouseOver. (Inherited from UpDownBase).
| ParsingNumberStyle | Gets or sets the parsing style (AllowLeadingWhite, Float, AllowHexSpecifier, ...). By default, Any. (Inherited from CommonNumericUpDown)
| ShowButtonSpinner | Gets or sets if the ButtonSpinners are visibles. (Inherited from UpDownBase)
| Text | Gets or sets the formated string representation of the value. (Inherited from InputBase)
| TextAlignment | Gets or sets the alignment of the **Text** (Left, Right, Center, Justify). By default, Left. (Inherited from InputBase)
| UpdateValueOnEnterKey | Gets or sets a value indicating whether the synchronization between "Value" and "Text" should be done only on the Enter key press (and lost focus). (Inherited from UpDownBase)
| Value | Gets or sets the numeric value. (Inherited from UpDownBase)
| Watermark | Gets or sets the object to use as a watermark if the **Value** is null. (Inherited from InputBase)
| WatermarkTemplate| Gets or sets the DatTemplate to use for the **Watermark**. (Inherited from InputBase)
{anchor:events}
## Events
|| Event || Description
| InputValidationError | Occurs when the Text cannot be converted to a valid Value. (Inherited from UpDownBase)
| ValueChanged | Raised when the Value changes. (Inherited from UpDownBase)
```
### Properties
| Property | Description |
| --- | --- |
| AllowSpin | Gets or sets the ability to perform increment/decrement operations via the keyboard, button spinners, or mouse wheel. (Inherited from UpDownBase) |
| AllowTextInput | Determines if the editable part of the control can be edited. The editable part does not include buttons or spinners, it is typically the text part. |
| AutoMoveFocus | Gets or sets if the focus can move from this control to other controls. (Inherited from NumericUpDown) |
| AutoSelectBehavior | Gets or sets a value indicating how the content of the auto-select text box is selected (Never or OnFocus). By default, OnFocus. (Inherited from NumericUpDown) |
| ButtonSpinnerLocation | Gets/Sets the location of the Up/Down buttons (either on the left or on the right) of numericUpDown controls. |
| ClipValueToMinMax | Gets or sets if the value should be clipped when minimum/maximum is reached. (Inherited from UpDownBase) |
| CultureInfo | Gets or sets the current CultureInfo. (Inherited from InputBase) |
| DefaultValue | Gets or sets the value to use when the **Value** is null and an increment/decrement operation is performed. (Inherited from UpDownBase) |
| DisplayDefaultValueOnEmptyText | Gets or sets if the defaultValue should be displayed when the Text is empty. (Inherited from UpDownBase) |
| FormatString | Gets or sets the display format of the **Value**. |
| Increment | Gets or sets the amount in which to increment the value. (Inherited from NumericUpDown) |
| IsReadOnly | Gets or sets if the control is read only. (Inherited from InputBase) |
| Maximum | Gets or sets the maximum allowed value. (Inherited from UpDownBase) |
| Minimum | Gets or sets the minimum allowed value. (Inherited from UpDownBase) |
| MouseWheelActiveTrigger | Gets or sets when the MouseWheel is active (Focused, FocusedMouseOver, MouseOver, Disabled). By default, FocusedMouseOver. (Inherited from UpDownBase). |
| ParsingNumberStyle | Gets or sets the parsing style (AllowLeadingWhite, Float, AllowHexSpecifier, ...). By default, Any. (Inherited from CommonNumericUpDown) |
| ShowButtonSpinner | Gets or sets if the ButtonSpinners are visible. (Inherited from UpDownBase) |
| Text | Gets or sets the formatted string representation of the value. (Inherited from InputBase) |
| TextAlignment | Gets or sets the alignment of the **Text** (Left, Right, Center, Justify). By default, Left. (Inherited from InputBase) |
| UpdateValueOnEnterKey | Gets or sets a value indicating whether the synchronization between "Value" and "Text" should be done only on the Enter key press (and lost focus). (Inherited from UpDownBase) |
| Value | Gets or sets the numeric value. (Inherited from UpDownBase) |
| Watermark | Gets or sets the object to use as a watermark if the **Value** is null. (Inherited from InputBase) |
| WatermarkTemplate| Gets or sets the DataTemplate to use for the **Watermark**. (Inherited from InputBase) |
### Events
| Event | Description |
| --- | --- |
| InputValidationError | Occurs when the Text cannot be converted to a valid Value. (Inherited from UpDownBase) |
| ValueChanged | Raised when the Value changes. (Inherited from UpDownBase) |
**Support this project, check out the [Plus Edition](http://wpftoolkit.com).**
---
---
**Support this project, check out the [Plus Edition](http://wpftoolkit.com).**
Write Preview
Loading…
Cancel
Save