PasswordBoxEdit Class

Represents a control allowing you to enter and manage passwords.

Assembly: DevExpress.Xpf.Core.v19.1.dll

Declaration

C#
VB.NET

public class PasswordBoxEdit :
    TextEditBase

Public Class PasswordBoxEdit
    Inherits TextEditBase

Remarks

PasswordBox_NullText

The PasswordBoxEdit control allows you to hide the characters and optionally limit the password’s length.

Tip

The PasswordBoxEdit class inherits its features from the TextEditBase class.

Refer to the TextEditBase class description for information on derived features and API.

Create a PasswordBoxEdit

XAML

<Window ...
    xmlns:dxe="http://schemas.devexpress.com/winfx/2008/xaml/editors">

<dxe:PasswordBoxEdit 
    ShowCapsLockWarningToolTip="True"
    NullValue="" 
    NullText="Please enter your password..." />

Use the Password property to get a password entered by an end user.

To respond to changing the editor’s value, handle the BaseEdit.EditValueChanged event. To check the new value’s validity, handle the BaseEdit.Validate event.

Password Char

Use the PasswordChar property to specify any character which is echoed in the password box.

PasswordBoxEdit PasswordChar

CapsLock Warning

If the Caps Lock is turned on and the mouse pointer rests over the password box editor, the editor can display a warning tooltip. Set the ShowCapsLockWarningToolTip property to true to display the CapsLock warning tooltip.

capslock warning tooltip

To provide custom content for the warning tooltip, use the CapsLockWarningToolTipTemplate property.

Password Strength and Requirements

You can restrict the password length typed by an end user via the TextEditBase.MaxLength property.

The password strength is automatically estimated and returned by the PasswordStrength property. To manually estimate password strength, handle the CustomPasswordStrength event. The event parameter allows you to obtain the text currently entered by an end user (PasswordStrengthEventArgs.Password) and specify the password strength (PasswordStrengthEventArgs.PasswordStrength).

Xaml

<dx:ThemedWindow ...
        xmlns:dxe="http://schemas.devexpress.com/winfx/2008/xaml/editors"
        xmlns:dx="http://schemas.devexpress.com/winfx/2008/xaml/core"
        dx:ThemeManager.Theme="Office2019Colorful">
    <Grid>
        <StackPanel Orientation="Horizontal" VerticalAlignment="Top">
            <dxe:PasswordBoxEdit x:Name="pwd" />
            <!-- Label content is bound to the PasswordBoxEdit's PasswordStrength property -->
            <Label Content="{DXBinding @e(pwd).PasswordStrength.ToString()}" Margin="10,0,0,0" />
        </StackPanel>
    </Grid>
</dx:ThemedWindow>

display password strength

The following code snippets (auto-collected from DevExpress Examples) contain references to the PasswordBoxEdit class.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

how-to-change-the-appearance-of-editors-when-validation-error-occurs-e3097/CS/WPFCustomValidationErrorPresenter/MainWindow.xaml#L27

<TextBlock Text="PasswordBoxEdit:" Margin="5,10,0,0" />
<dxe:PasswordBoxEdit Name="passwordBoxEdit1" Validate="textEdit_Validate" InvalidValueBehavior="AllowLeaveEditor" HorizontalAlignment="Left" Width="200"/>

dxrichedit-document-encryption/CS/DXRichEdit_Encryption/MainWindow.xaml#L21

       VerticalContentAlignment="Center"/>
<dxe:PasswordBoxEdit x:Name="passwordEdit"
                     EditValueChanged="passwordChanged"

how-to-show-a-border-around-a-focused-editor-e3047/VB/WPFEditorsFocusBorder/MainWindow.xaml#L39

<TextBlock Text="PasswordBoxEdit:" Margin="5,10,0,0" />
<dxe:PasswordBoxEdit Name="passwordBoxEdit1" Width="150" />
<TextBlock Text="SpinEdit:" Margin="5,10,0,0" />