TextBoxExtensions

2024-11-07

Der Typ TextBoxExtensions stellt zusätzliche Features für das Steuerelement TextBox über Erweiterungsmethoden und angefügte Eigenschaften bereit.

Text regex

Die angefügte Eigenschaft Regex ermöglicht die Textüberprüfung mithilfe eines regulären Ausdrucks oder mithilfe integrierter Überprüfungstypen.

Der Entwickler fügt einen regulären Ausdruck hinzu, um den TextBox-Text anhand des regulären Ausdrucks "Regex"-Eigenschaft auszuwerten oder die ValidationType-Eigenschaft im TextBox-Objekt auszuwählt.

Die Überprüfung weist drei Modi auf (TextBoxExtensions.ValidationMode):

Normal (Standard): Dieser Modus legt die angefügte Eigenschaft IsValid auf false oder true fest, unabhängig davon, ob der Text TextBox im Vergleich zuRegex eine gültige Eigenschaft oder nicht ist.
Forced: Dieser Modus legt die EigenschaftIsValid fest und entfernt den TextTextBox, wenn er nicht gültig ist, weil der TextBox den Fokus verliert.
Dynamic: Dieser Modus erweitert Normal und wenn die neueste Eingabe der TextBox Zeichenfolge ungültig ist, wird das ungültige Zeichen gelöscht. Beachten Sie, dass die TextBoxExtensions.ValidationType Werte Email und PhoneNumber diesen Validierungsmodus nicht unterstützen. Wenn Sie den Überprüfungsmodus auf Dynamiceinstellen, wird stattdessenNormal automatisch ausgewählt.

<Page x:Class="ExtensionsExperiment.Samples.TextBoxExtensions.RegexSample"
      xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
      xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
      xmlns:converters="using:CommunityToolkit.Converters"
      xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
      xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
      xmlns:ui="using:CommunityToolkit.WinUI"
      mc:Ignorable="d">

    <Page.Resources>
        <Style x:Key="TextBoxRegexStyle"
               TargetType="TextBox">
            <Setter Property="VerticalAlignment" Value="Top" />
            <Setter Property="TextWrapping" Value="Wrap" />
        </Style>
        <DataTemplate x:Key="HeaderTemplate">
            <StackPanel>
                <TextBlock Text="{Binding}"
                           TextWrapping="WrapWholeWords" />
            </StackPanel>
        </DataTemplate>
    </Page.Resources>

    <Grid>
        <Grid RowSpacing="32">
            <Grid.RowDefinitions>
                <RowDefinition />
                <RowDefinition />
                <RowDefinition />
                <RowDefinition />
                <RowDefinition />
            </Grid.RowDefinitions>

            <StackPanel>
                <TextBox Name="PhoneNumberValidator"
                         ui:TextBoxExtensions.Regex="^\s*\+?\s*([0-9][\s-]*){9,}$"
                         Header="Text box with Regex extension for phone number, validation occurs on TextChanged"
                         HeaderTemplate="{StaticResource HeaderTemplate}"
                         Style="{StaticResource TextBoxRegexStyle}" />
                <TextBlock Foreground="{ThemeResource TextFillColorSecondaryBrush}">
                    <Run Text="Is valid: " />
                    <Run FontWeight="SemiBold"
                         Text="{Binding (ui:TextBoxExtensions.IsValid), ElementName=PhoneNumberValidator}" />
                </TextBlock>
            </StackPanel>

            <StackPanel Grid.Row="1">
                <TextBox Name="CharactValidator"
                         ui:TextBoxExtensions.ValidationMode="Dynamic"
                         ui:TextBoxExtensions.ValidationType="Characters"
                         Header="Text box with ValidationType=Characters, validation occurs at input with ValidationMode=Dynamic and clear only single character when value is invalid"
                         HeaderTemplate="{StaticResource HeaderTemplate}"
                         Style="{StaticResource TextBoxRegexStyle}"
                         Text="abcdef" />
                <TextBlock Foreground="{ThemeResource TextFillColorSecondaryBrush}">
                    <Run Text="Is valid: " />
                    <Run FontWeight="SemiBold"
                         Text="{Binding (ui:TextBoxExtensions.IsValid), ElementName=CharactValidator}" />
                </TextBlock>
            </StackPanel>

            <StackPanel Grid.Row="2">
                <TextBox Name="EmailValidator"
                         ui:TextBoxExtensions.ValidationType="Email"
                         Header="Text box with ValidationType=Email, validation occurs on TextChanged"
                         HeaderTemplate="{StaticResource HeaderTemplate}"
                         Style="{StaticResource TextBoxRegexStyle}" />
                <TextBlock Foreground="{ThemeResource TextFillColorSecondaryBrush}">
                    <Run Text="Is valid: " />
                    <Run FontWeight="SemiBold"
                         Text="{Binding (ui:TextBoxExtensions.IsValid), ElementName=EmailValidator}" />
                </TextBlock>
            </StackPanel>

            <StackPanel Grid.Row="3">
                <TextBox Name="DecimalValidatorForce"
                         ui:TextBoxExtensions.ValidationMode="Forced"
                         ui:TextBoxExtensions.ValidationType="Decimal"
                         Header="Text box with ValidationType=Decimal, validation occurs on TextChanged and force occurs on lose focus with ValidationMode=Force (333,111 or 333.111)"
                         HeaderTemplate="{StaticResource HeaderTemplate}"
                         Style="{StaticResource TextBoxRegexStyle}" />
                <TextBlock Foreground="{ThemeResource TextFillColorSecondaryBrush}">
                    <Run Text="Is valid: " />
                    <Run FontWeight="SemiBold"
                         Text="{Binding (ui:TextBoxExtensions.IsValid), ElementName=DecimalValidatorForce}" />
                </TextBlock>
            </StackPanel>

            <StackPanel Grid.Row="4">
                <TextBox Name="NumberValidatorDynamic"
                         ui:TextBoxExtensions.ValidationMode="Dynamic"
                         ui:TextBoxExtensions.ValidationType="Number"
                         Header="Text box with ValidationType=Number, validation occurs at input with ValidationMode=Dynamic and clear only single character when value is invalid"
                         HeaderTemplate="{StaticResource HeaderTemplate}"
                         Style="{StaticResource TextBoxRegexStyle}" />
                <TextBlock Foreground="{ThemeResource TextFillColorSecondaryBrush}">
                    <Run Text="Is valid: " />
                    <Run FontWeight="SemiBold"
                         Text="{Binding (ui:TextBoxExtensions.IsValid), ElementName=NumberValidatorDynamic}" />
                </TextBlock>
            </StackPanel>
        </Grid>
    </Grid>
</Page>

// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.

namespace ExtensionsExperiment.Samples.TextBoxExtensions;

[ToolkitSample(id: nameof(RegexSample), "Regex Extension", description: "A sample for showing how to use the Regex Extension.")]
public sealed partial class RegexSample : Page
{
    public RegexSample()
    {
        this.InitializeComponent();
    }
}

Textformat

Die angefügte Eigenschaft Mask ermöglicht es einem Benutzer, Text mit fester Breite einfacher in die Steuerung TextBox einzugeben, wo Sie möchten, dass sie Daten in einem bestimmten Format eingegeben werden sollen, z. B. Telefonnummer, Postleitzahl.

Der Entwickler fügt die Maskeneigenschaft hinzu, um zu verhindern, dass die Endbenutzer ein anderes Format als das erforderliche Format eingeben (z. B. eine Postleitzahl im Format "aaa-9999").

Die EigenschaftMask stellt drei integrierte Variablenzeichen bereit, die zum Definieren einer Maske verwendet werden können:

a das [a-Z] darstellt
9 das [0-9] darstellt
* das a oder 9darstellt

Im Postcodebeispiel darf der Benutzer den ersten 3 Zeichen nur von a bis Z eingeben, danach gibt es ein festes Zeichen -, das der Benutzer ändern oder entfernen kann, und den letzten Teil, den der Benutzer ändern kann, indem er von zu 9 jedem Zeichen eingibt 0 . Die Eigenschaft Mask verhindert, dass TextBox nicht die angegebenen Zeichen aufweist (z. B. wenn Sie1 oder 2 in eine Maske wie 9999 eingegeben haben).

Die Eigenschaft Mask unterstützt auch zwei Zeichentypen:

Variable: die der Benutzer ändern kann, z. B. a,9,*
Behoben: die der Benutzer nicht ändern kann, wobei es sich um irgendein nicht variables Zeichen handelt (z. B. das - im ersten Beispiel).

Variable Zeichen, die dem Endbenutzer in Form von Platzhaltern dargestellt werden, damit der Benutzer wissen kann, welche Zeichen er ändern kann und welche nicht, z.B. wird dem Benutzer die Maske aaa-9999 als ___-____angezeigt. Der Standardplatzhalter ist _, Sie können ihn jedoch mithilfe der EigenschaftMaskPlaceholder ändern.

Sie können die Variable verlassen, indem Sie \ verwenden (z. B. wird die Maske +\964 dem Benutzer als +964angezeigt). Auf diese Weise wird 9 in der Maske als festes Zeichen behandelt, nicht als Variable. Wenn Sie \ in der Maske benötigt haben, können Sie sie als \\ schreiben (z. B. wird 99\\99\\9999 dem Benutzer als __\__\__angezeigt).

Falls Sie ein benutzerdefiniertes Variablenzeichen hinzufügen möchten, können Sie die Eigenschaft CustomMask verwenden. Sie können ein Zeichen hinzufügen, das bestimmte regex als c:[a-c] darstellt, und sobald Sie den Buchstaben c in der Maske verwenden, schließt die Maske alle Zeichen aus, außer a bis c innerhalb von TextBox, wobei Sie auch mehrere variable Zeichen angeben, indem Sie nach jedem Zeichen und deren Darstellung das Komma , hinzufügen. Dieses Feature ist hilfreich, wenn Sie bestimmte Buchstaben zulassen möchten (z. B. nur TextBoxFranzösisch oder Arabisch ).

<Page x:Class="ExtensionsExperiment.Samples.TextBoxExtensions.TextBoxMaskSample"
      xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
      xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
      xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
      xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
      xmlns:ui="using:CommunityToolkit.WinUI"
      xmlns:win="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
      mc:Ignorable="d">


    <Page.Resources>
        <Style x:Key="MaskedTextBoxStyle"
               TargetType="TextBox">
            <Setter Property="VerticalAlignment" Value="Top" />
            <Setter Property="TextWrapping" Value="Wrap" />
        </Style>
        <DataTemplate x:Key="HeaderTemplate">
            <StackPanel>
                <TextBlock Text="{Binding}"
                           TextWrapping="WrapWholeWords" />
            </StackPanel>
        </DataTemplate>
    </Page.Resources>

    <Grid>
        <StackPanel Spacing="24">
            <TextBox ui:TextBoxExtensions.Mask="9a9a-a9a*"
                     Header="Text box with Mask 9a9a-a9a* (9 allows from 0 to 9, a allow from a to Z and * allows both a and 9)"
                     HeaderTemplate="{StaticResource HeaderTemplate}"
                     Style="{StaticResource MaskedTextBoxStyle}"
                     Text="TextBoxMask" />

            <TextBox ui:TextBoxExtensions.Mask="+1999-9999"
                     ui:TextBoxExtensions.MaskPlaceholder=" "
                     Header="Text box with Mask +1999-9999 and placeHolder as space (placeholder represents the characters the user can change on runtime)"
                     HeaderTemplate="{StaticResource HeaderTemplate}"
                     Style="{StaticResource MaskedTextBoxStyle}" />

            <TextBox ui:TextBoxExtensions.Mask="+\964 799 999 9999"
                     Header="Text box with Mask +964 799 999 9999 (Notice how we escape the first 9 with a backslash)"
                     HeaderTemplate="{StaticResource HeaderTemplate}"
                     Style="{StaticResource MaskedTextBoxStyle}" />

            <TextBox ui:TextBoxExtensions.Mask="99\\99\\9999"
                     Header="Text box with Mask 99\99\9999 (You can escape a backslash with another backslash)"
                     HeaderTemplate="{StaticResource HeaderTemplate}"
                     Style="{StaticResource MaskedTextBoxStyle}" />

            <TextBox ui:TextBoxExtensions.CustomMask="5:[1-5],c:[a-c]"
                     ui:TextBoxExtensions.Mask="a5c-5c*9"
                     Header="Text box with CustomMask in case you want to define your own variable character like a, 9 and *. Mask: a5c-5c*9, 5: [1-5], c: [a-c]"
                     HeaderTemplate="{StaticResource HeaderTemplate}"
                     Style="{StaticResource MaskedTextBoxStyle}" />

        </StackPanel>
    </Grid>
</Page>

// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.

namespace ExtensionsExperiment.Samples.TextBoxExtensions;

[ToolkitSample(id: nameof(TextBoxMaskSample), "TextBoxMask Extension", description: "A sample for showing how to use the TextBoxMask Extension.")]
public sealed partial class TextBoxMaskSample : Page
{
    public TextBoxMaskSample()
    {
        this.InitializeComponent();
    }
}

Surface Dial-Unterstützung

Die Eigenschaft SurfaceDialOptions fügt Features aus dem Surface Dial-Steuerelement zu einem numerischen TextBox hinzu. Auf diese Weise können Sie den Inhalt des TextBox ändern, wenn das Surface Dial gedreht wird (indem Sie den Wert vergrößern oder verkleinern) und optional zum nächsten Fokuselement wechseln, indem Sie auf die Surface Dial-Schaltfläche klicken. Die verschiedenen Optionen werden über den TypSurfaceDialOptions festgelegt, der in XAML angegeben und verwendet wird, um alle Werte festzulegen, die für einen bestimmten TextBox Ort verwendet werden sollen. Hier ist ein Beispiel für das visuelle Ergebnis beim Scrollen auf einem Surface Dial über ein TextBox:

<Page x:Class="ExtensionsExperiment.Samples.TextBoxExtensions.SurfaceDialOptionsSample"
      xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
      xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
      xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
      xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
      xmlns:ui="using:CommunityToolkit.WinUI"
      xmlns:win="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
      mc:Ignorable="d">


    <win:TextBox HorizontalAlignment="Left"
                 VerticalAlignment="Top"
                 Header="For this sample, you need a Surface Dial"
                 Text="0">
        <ui:TextBoxExtensions.SurfaceDialOptions>
            <ui:SurfaceDialOptions EnableHapticFeedback="True"
                                   EnableMinMaxValue="True"
                                   EnableTapToNextControl="False"
                                   Icon="Ruler"
                                   MaxValue="100"
                                   MinValue="0"
                                   RotationResolutionInDegrees="12"
                                   StepValue="1" />
        </ui:TextBoxExtensions.SurfaceDialOptions>
    </win:TextBox>
</Page>

// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.

namespace ExtensionsExperiment.Samples.TextBoxExtensions;

[ToolkitSample(id: nameof(SurfaceDialOptionsSample), "SurfaceDialOptions Extension", description: "A sample for showing how to use the SurfaceDialOptions Extension.")]
public sealed partial class SurfaceDialOptionsSample : Page
{
    public SurfaceDialOptionsSample()
    {
        this.InitializeComponent();
    }
}

Beispiele

Weitere Beispiele finden Sie in den Komponententests.

Freigeben über

TextBoxExtensions

Text regex

Textformat

Surface Dial-Unterstützung

Beispiele

Zusätzliche Ressourcen