New to Telerik UI for WPFStart a free 30-day trial

Represents a password input control that allows users to enter passwords securely. This control masks the input with a specified character (default is a bullet character '●'), and provides options to show the password through a button that toggles visibility. It also supports password-related events, including notifying when the password changes. The secure password is stored using SecureString to protect sensitive data against memory inspection. Additional features include customizable button content, and visibility controls for the password display button.

Definition

Namespace:Telerik.Windows.Controls

Assembly:Telerik.Windows.Controls.dll

Syntax:

C#
[TelerikToolboxCategory("Input")]
public class RadPasswordBox : RadWatermarkTextBox

Inheritance: objectRadWatermarkTextBoxRadPasswordBox

Inherited Members RadWatermarkTextBox.LabelPropertyRadWatermarkTextBox.LabelStylePropertyRadWatermarkTextBox.KeepLabelFloatedPropertyRadWatermarkTextBox.HasLabelPropertyRadWatermarkTextBox.IsLabelFloatedPropertyRadWatermarkTextBox.WatermarkTemplatePropertyRadWatermarkTextBox.WatermarkContentPropertyRadWatermarkTextBox.CurrentTextPropertyRadWatermarkTextBox.SelectionOnFocusPropertyRadWatermarkTextBox.WatermarkBehaviorPropertyRadWatermarkTextBox.ReadOnlyBackgroundPropertyRadWatermarkTextBox.DisabledBackgroundPropertyRadWatermarkTextBox.AdditionalContentPropertyRadWatermarkTextBox.AdditionalContentTemplatePropertyRadWatermarkTextBox.IsWatermarkVisiblePropertyRadWatermarkTextBox.OnPropertyChanged(DependencyPropertyChangedEventArgs)RadWatermarkTextBox.OnInitialized(EventArgs)RadWatermarkTextBox.EndInit()RadWatermarkTextBox.LabelRadWatermarkTextBox.LabelStyleRadWatermarkTextBox.KeepLabelFloatedRadWatermarkTextBox.HasLabelRadWatermarkTextBox.IsLabelFloatedRadWatermarkTextBox.WatermarkContentRadWatermarkTextBox.WatermarkTemplateRadWatermarkTextBox.CurrentTextRadWatermarkTextBox.IsWatermarkVisibleRadWatermarkTextBox.WatermarkBehaviorRadWatermarkTextBox.ReadOnlyBackgroundRadWatermarkTextBox.DisabledBackgroundRadWatermarkTextBox.SelectionOnFocusRadWatermarkTextBox.AdditionalContentRadWatermarkTextBox.AdditionalContentTemplate...

Constructors

Initializes a new instance of the RadPasswordBox class.

C#
public RadPasswordBox()

Fields

IsPasswordVisibleProperty

DependencyProperty

Identifies the IsPasswordVisible dependency property.

C#
public static readonly DependencyProperty IsPasswordVisibleProperty

Identifies the PasswordChanged routed event.

C#
public static readonly RoutedEvent PasswordChangedEvent

PasswordCharProperty

DependencyProperty

Identifies the PasswordChar dependency property.

C#
public static readonly DependencyProperty PasswordCharProperty

Identifies the ShowPasswordButtonContent dependency property.

C#
public static readonly DependencyProperty ShowPasswordButtonContentProperty

Identifies the ShowPasswordButtonContentTemplate dependency property.

C#
public static readonly DependencyProperty ShowPasswordButtonContentTemplateProperty

Identifies the ShowPasswordButtonVisibility dependency property.

C#
public static readonly DependencyProperty ShowPasswordButtonVisibilityProperty

Properties

Gets value indicating whether the actual password is currently displayed.

C#
public bool IsPasswordVisible { get; }

Gets or sets the current password as a string representation.

C#
public string Password { get; set; }

Gets or sets the masking character for RadPasswordBox. The default value is a bullet character (●).

C#
public char PasswordChar { get; set; }

Gets the current password as a SecureString.

C#
public SecureString SecurePassword { get; }

Gets or sets the content to be shown in the button used to display the password at runtime.

C#
public object ShowPasswordButtonContent { get; set; }

Gets or sets the template for presenting the content in the button used to display the password at runtime.

C#
public DataTemplate ShowPasswordButtonContentTemplate { get; set; }

Gets or sets value indicating whether the button used to display the password should be visible. The default value is Auto.

C#
public ShowPasswordButtonVisibilityMode ShowPasswordButtonVisibility { get; set; }

Methods

Clears the current Password.

C#
public void Clear()

Called when the Clear command is invoked.

C#
protected override void HandleClear()

Overrides: RadWatermarkTextBox.HandleClear()

Contains the logic for handling the preview key down event of RadPasswordBox.

C#
protected virtual bool HandleKeyDown(Key key)
Parameters:keyKey

The key that has been pressed.

Returns:

bool

True if the KeyDown event should be handled, otherwise false.

When overridden in a derived class, measures the size in layout required for child elements and determines a size for the System.Windows.FrameworkElement-derived class.

C#
protected override Size MeasureOverride(Size constraint)
Parameters:constraintSize

A maximum Size to not exceed.

Returns:

Size

When overridden in a derived class, is invoked whenever application code or internal processes call .

C#
public override void OnApplyTemplate()

Overrides: RadWatermarkTextBox.OnApplyTemplate()

Returns class-specific System.Windows.Automation.Peers.AutomationPeer implementations for the Windows Presentation Foundation (WPF) infrastructure.

C#
protected override AutomationPeer OnCreateAutomationPeer()
Returns:

AutomationPeer

Overrides: RadWatermarkTextBox.OnCreateAutomationPeer()

Invoked when an unhandled System.Windows.DragDrop.DragEnter attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

C#
protected override void OnDrop(DragEventArgs e)
Parameters:eDragEventArgs

The System.Windows.DragEventArgs that contains the event data.

Called when the Password changes and raises the PasswordChanged event.

C#
protected virtual void OnPasswordChanged()

Virtual method reporting a key was pressed.

C#
protected override void OnPreviewKeyDown(KeyEventArgs e)
Parameters:eKeyEventArgs

Virtual method reporting text composition.

C#
protected override void OnPreviewTextInput(TextCompositionEventArgs e)
Parameters:eTextCompositionEventArgs

Events

PasswordChanged

RoutedEventHandler

Occurs when the value of the Password property changes.

C#
[SRCategory("Behavior")]
public event RoutedEventHandler PasswordChanged