ClassRadPasswordBox
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:
[TelerikToolboxCategory("Input")]
[SuppressMessage("Microsoft.Design", "CA1001:TypesThatOwnDisposableFieldsShouldBeDisposable")]
public class RadPasswordBox : RadWatermarkTextBoxInheritance: objectRadWatermarkTextBoxRadPasswordBox
Inherited Members
Constructors
RadPasswordBox()
Initializes a new instance of the RadPasswordBox class.
Declaration
public RadPasswordBox()Fields
IsPasswordVisibleProperty
Identifies the IsPasswordVisible dependency property.
Declaration
public static readonly DependencyProperty IsPasswordVisiblePropertyField Value
DependencyProperty
PasswordChangedEvent
Identifies the PasswordChanged routed event.
Declaration
public static readonly RoutedEvent PasswordChangedEventField Value
RoutedEvent
PasswordCharProperty
Identifies the PasswordChar dependency property.
Declaration
public static readonly DependencyProperty PasswordCharPropertyField Value
DependencyProperty
ShowPasswordButtonContentProperty
Identifies the ShowPasswordButtonContent dependency property.
Declaration
public static readonly DependencyProperty ShowPasswordButtonContentPropertyField Value
DependencyProperty
ShowPasswordButtonContentTemplateProperty
Identifies the ShowPasswordButtonContentTemplate dependency property.
Declaration
public static readonly DependencyProperty ShowPasswordButtonContentTemplatePropertyField Value
DependencyProperty
ShowPasswordButtonVisibilityProperty
Identifies the ShowPasswordButtonVisibility dependency property.
Declaration
public static readonly DependencyProperty ShowPasswordButtonVisibilityPropertyField Value
DependencyProperty
Properties
IsPasswordVisible
Gets value indicating whether the actual password is currently displayed.
Password
Gets or sets the current password as a string representation.
PasswordChar
Gets or sets the masking character for RadPasswordBox. The default value is a bullet character (●).
SecurePassword
Gets the current password as a SecureString.
Declaration
public SecureString SecurePassword { get; }Property Value
ShowPasswordButtonContent
Gets or sets the content to be shown in the button used to display the password at runtime.
Declaration
public object ShowPasswordButtonContent { get; set; }Property Value
ShowPasswordButtonContentTemplate
Gets or sets the template for presenting the content in the button used to display the password at runtime.
Declaration
public DataTemplate ShowPasswordButtonContentTemplate { get; set; }Property Value
DataTemplate
ShowPasswordButtonVisibility
Gets or sets value indicating whether the button used to display the password should be visible. The default value is Auto.
Declaration
public ShowPasswordButtonVisibilityMode ShowPasswordButtonVisibility { get; set; }Property Value
Methods
HandleClear()
Called when the Clear command is invoked.
Declaration
protected override void HandleClear()Overrides
HandleKeyDown(Key)
Contains the logic for handling the preview key down event of RadPasswordBox.
Declaration
protected virtual bool HandleKeyDown(Key key)Parameters
key
Key
The key that has been pressed.
Returns
True if the KeyDown event should be handled, otherwise false.
MeasureOverride(Size)
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.
Declaration
protected override Size MeasureOverride(Size constraint)Parameters
constraint
Size
A maximum Size to not exceed.
Returns
Size
OnApplyTemplate()
When overridden in a derived class, is invoked whenever application code or internal processes call .
Declaration
public override void OnApplyTemplate()Overrides
OnCreateAutomationPeer()
Returns class-specific System.Windows.Automation.Peers.AutomationPeer implementations for the Windows Presentation Foundation (WPF) infrastructure.
Declaration
protected override AutomationPeer OnCreateAutomationPeer()Returns
AutomationPeer
Overrides
OnDrop(DragEventArgs)
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.
Declaration
protected override void OnDrop(DragEventArgs e)Parameters
e
DragEventArgs
The System.Windows.DragEventArgs that contains the event data.
OnPasswordChanged()
Called when the Password changes and raises the PasswordChanged event.
Declaration
protected virtual void OnPasswordChanged()OnPreviewKeyDown(KeyEventArgs)
Virtual method reporting a key was pressed.
Declaration
protected override void OnPreviewKeyDown(KeyEventArgs e)Parameters
e
KeyEventArgs
OnPreviewTextInput(TextCompositionEventArgs)
Virtual method reporting text composition.
Declaration
protected override void OnPreviewTextInput(TextCompositionEventArgs e)Parameters
e
TextCompositionEventArgs
Events
PasswordChanged
Occurs when the value of the Password property changes.
Declaration
[SRCategory("Behavior")]
public event RoutedEventHandler PasswordChangedEvent Value
RoutedEventHandler