How can I make a TextBox be a "password box" and display stars when using MVVM?


C# Problem Overview

How can I do this in XAML:


<TextBox Text="{Binding Password}" Type="Password"/>

so that the user sees stars or dots when he is typing in the password.

I've tried various examples which suggest PasswordChar and PasswordBox but can't get these to work.

e.g. I can do this as shown here:

<PasswordBox Grid.Column="1" Grid.Row="1"

but I of course want to bind the Text property to my ViewModel so I can send the value the bound TextBox when the button is clicked (not working with code behind), I want to do this:

<TextBox Grid.Column="1" Grid.Row="0" 
    Text="{Binding Login}" 
    Style="{StaticResource FormTextBox}"/>
<PasswordBox Grid.Column="1" Grid.Row="1"
    Text="{Binding Password}" 
    Style="{StaticResource FormTextBox}"/>

But PasswordBox doesn't have a Text property.

C# Solutions

Solution 1 - C#

To get or set the Password in a PasswordBox, use the Password property. Such as

string password = PasswordBox.Password;

This doesn't support Databinding as far as I know, so you'd have to set the value in the codebehind, and update it accordingly.

Solution 2 - C#

As Tasnim Fabiha mentioned, it is possible to change font for TextBox in order to show only dots/asterisks. But I wasn't able to find his I give you my working example:

<TextBox Text="{Binding Password}" 
     FontFamily="pack://application:,,,/Resources/#password" />

Just copy-paste won't work. Firstly you have to download mentioned font "password.ttf" link: Then copy that to your project Resources folder (Project->Properties->Resources->Add resource->Add existing file). Then set it's Build Action to: Resource.

After this you will see just dots, but you can still copy text from that, so it is needed to disable CTRL+C shortcut like this:

<TextBox Text="{Binding Password}" 
     FontFamily="pack://application:,,,/Resources/#password" > 
		<!--Disable CTRL+C (COPY) -->
		<KeyBinding Command="ApplicationCommands.NotACommand"
			Modifiers="Control" />
        <!--Disable CTRL+X (CUT) -->
		<KeyBinding Command="ApplicationCommands.NotACommand"
			Modifiers="Control" />
        <!--Hide context menu where you could copy/cut as well -->
        <ContextMenu Visibility="Collapsed" />

EDIT: Added Ctrl+X and Context menu disabling based on @CodingNinja comment, thank you.

Solution 3 - C#

Send the passwordbox control as a parameter to your login command.

<Button Command="{Binding LoginCommand}" CommandParameter="{Binding ElementName=PasswordBox}"...>

Then you can call CType(parameter, PasswordBox).Password in your viewmodel.

Solution 4 - C#

There's a way to bind on a PasswordBox here: PasswordBox Databinding

Solution 5 - C#

Thanks Cody, that was very helpful. I've just added an example for guys using the Delegate Command in C#

<PasswordBox x:Name="PasswordBox"
             Grid.Row="1" Grid.Column="1"
             Width="300" Height="25"
             Margin="6,7,0,7" />
<Button Content="Login"
        Grid.Row="4" Grid.Column="1"
        Style="{StaticResource StandardButton}"
        Command="{Binding LoginCommand}"
        CommandParameter="{Binding ElementName=PasswordBox}"
        Height="31" Width="92"
        Margin="5,9,0,0" />


public ICommand LoginCommand
	    return new DelegateCommand<object>((args) =>
		    // Get Password as Binding not supported for control-type PasswordBox
		    LoginPassword = ((PasswordBox) args).Password;
		    // Rest of code here

Solution 6 - C#

You can make your TextBox as customed PasswordBox by simply adding the following value to FontFamily property of your TextBox control.

    Text="{Binding Password}"

In my case this works perfectly. This will show dot in place of the actual text (not star(*) though).

Solution 7 - C#

The problem with using the PasswordBox is that it is not very MVVM friendly due to the fact that it works with SecureString and therefore requires a shim to bind it to a String. You also cannot use the clipboard. While all these things are there for a reason, you may not require that level of security. Here is an alternative approach that works with the clipboard, nothing fancy. You make the TextBox text and background transparent and bind the text to a TextBlock underneath it. This textblock converts characters to * using the converter specified.

    <local:TextToPasswordCharConverter x:Key="TextToPasswordCharConverter" />

<Grid Width="200">
    <TextBlock Margin="5,0,0,0" Text="{Binding Text, Converter={StaticResource TextToPasswordCharConverter}, UpdateSourceTrigger=PropertyChanged, Mode=OneWay}" FontFamily="Consolas" VerticalAlignment="Center" />
    <TextBox Foreground="Transparent" Text="{Binding Text, UpdateSourceTrigger=PropertyChanged}" FontFamily="Consolas" Background="Transparent" />

And here is the Value Converter:

class TextToPasswordCharConverter : IValueConverter
    public object Convert(object value, Type targetType, object parameter, CultureInfo culture)
        return new String('*', value?.ToString().Length ?? 0);

    public object ConvertBack(object value, Type targetType, object parameter, CultureInfo culture)
        throw new NotImplementedException();

Make sure your Text property on your viewmodel implements INotifyPropertyChanged

Solution 8 - C#

I did the below from the Views codebehind to set my property within the view model. Not sure if it really " breaks" the MVVM pattern but its the best and least complexe solution found.

  var data = this.DataContext as DBSelectionViewModel;

        data.PassKey = txtPassKey.Password;

Solution 9 - C#

A simple resolution that worked for me was to bind the text box to the LocalPassword which displays a converted value of repeating *'s. Any entry is stored in the _localPassword variable.

<TextBox Text="{Binding LocalPassword}" />

private string _localPassword = null;
private string _localPasswordDisplayed { get => new string('*', _localPassword.Length); }
public string LocalPassword { get => _localPasswordDisplayed; set { _localPassword = value; OnPropertyChanged(); } }


All content for this solution is sourced from the original question on Stackoverflow.

The content on this page is licensed under the Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.

Content TypeOriginal AuthorOriginal Content on Stackoverflow
QuestionEdward TanguayView Question on Stackoverflow
Solution 1 - C#BrandonView Answer on Stackoverflow
Solution 2 - C#ssamkoView Answer on Stackoverflow
Solution 3 - C#Cody CView Answer on Stackoverflow
Solution 4 - C#gimpyView Answer on Stackoverflow
Solution 5 - C#KwexView Answer on Stackoverflow
Solution 6 - C#Tasnim FabihaView Answer on Stackoverflow
Solution 7 - C#DavidView Answer on Stackoverflow
Solution 8 - C#Daniel_UnsView Answer on Stackoverflow
Solution 9 - C#GalacticView Answer on Stackoverflow