Culture and Formatting in WPF Integer TextBox

18 Nov 20184 minutes to read

Value of WPF Integer TextBox can be formatted in following ways:

• Culture
• NumberFormatInfo
• Dedicated properties (NumberGroupSeparator, NumberGroupSizes)

Culture based formatting

The WPF Integer TextBox provides support for globalization by using the Culture property. The Culture property is used to format the number group size and group separator of the WPF Integer TextBox value based on the respective culture.

XAML

<syncfusion:IntegerTextBox x:Name="integerTextBox" Height="25" Width="150" Culture="bs-Latn" Value="1234567"/>

C#

using Syncfusion.Windows.Shared;
using System.Globalization;

IntegerTextBox integerTextBox = new IntegerTextBox();
integerTextBox.Width = 150;
integerTextBox.Height = 25;
integerTextBox.Value = 1234567;

//Setting Latin culture for integer textbox.
integerTextBox.Culture = new CultureInfo("bs-Latn");

By default the US culture uses “,” as the NumberGroupSeparator, whereas the Latin culture uses “.” as the NumberGroupSeparator.

Default Culture

Latin Culture

NumberFormatInfo based formatting

The number formatting of WPF Integer TextBox can be customized by setting the NumberFormat property.

XAML

<Window xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        xmlns:syncfusion="http://schemas.syncfusion.com/wpf"
        xmlns:numberformat="clr-namespace:System.Globalization;assembly=mscorlib"
        x:Class="IntegerTextBoxSample.MainWindow"
        Title="IntegerTextBox Sample" Height="350" Width="525">
    <Grid>
        <syncfusion:IntegerTextBox x:Name="integerTextBox" Height="25" Width="150" Culture="en-US"
                                   Value="123456789012345" GroupSeperatorEnabled="True" >
            <syncfusion:IntegerTextBox.NumberFormat>
                <numberformat:NumberFormatInfo NumberGroupSeparator="/"/>
            </syncfusion:IntegerTextBox.NumberFormat>
        </syncfusion:IntegerTextBox>
    </Grid>
</Window>

C#

using Syncfusion.Windows.Shared;
using System.Globalization;

IntegerTextBox integerTextBox = new IntegerTextBox();
integerTextBox.Width = 150;
integerTextBox.Height = 25;
integerTextBox.GroupSeperatorEnabled = true;
integerTextBox.Value = 123456789012345;
integerTextBox.Culture = new CultureInfo("en-US");
integerTextBox.NumberFormat = new NumberFormatInfo()
{
    NumberGroupSeparator = "/"
};

The following code illustrates how to set NumberGroupSizes by using the NumberFormat property.

C#

using Syncfusion.Windows.Shared;
using System.Globalization;

IntegerTextBox integerTextBox = new IntegerTextBox();
integerTextBox.Width = 150;
integerTextBox.Height = 25;
integerTextBox.Value = 123456789012345;
integerTextBox.GroupSeperatorEnabled = true;
integerTextBox.NumberFormat = new NumberFormatInfo()
{
    NumberGroupSeparator = "/",
    NumberGroupSizes = new int[] { 2, 3, 4 }
};

Formatting with dedicated properties

The number formatting of IntegerTextBox can also be customized by setting the NumberGroupSeparator and NumberGroupSizes properties. You can show the group separator by enabling the GroupSeperatorEnabled property to true. The default value of GroupSeperatorEnabled is false.

The following code illustrates how to format using the NumberGroupSeparator and NumberGroupSizes properties of the WPF Integer TextBox. Use a standard int[] for the NumberGroupSizes property.

C#

using Syncfusion.Windows.Shared;

IntegerTextBox integerTextBox = new IntegerTextBox();
integerTextBox.Width = 150;
integerTextBox.Height = 25;
integerTextBox.Value = 123456789012345;
integerTextBox.NumberGroupSeparator = "/";
integerTextBox.GroupSeperatorEnabled = true;
integerTextBox.NumberGroupSizes = new int[] { 2, 3, 0 };

NOTE

When you use both the NumberFormat and the dedicated properties (NumberGroupSeparator and NumberGroupSizes) to format the value of WPF Integer TextBox, the dedicated properties take priority over NumberFormat.

NOTE

When you use both NumberFormat and Culture, the NumberFormat will have a higher priority.