Class RadPasswordBox

This class represents a control that is designed for entering passwords. It can show different content when empty and provides a button that displays the currently entered password.

Inheritance
System.Object
RadWatermarkTextBox
RadPasswordBox
Inherited Members
Namespace: Telerik.Windows.Controls
Assembly: Telerik.Windows.Controls.dll

Syntax

[TelerikToolboxCategory("Input")]
public class RadPasswordBox : RadWatermarkTextBox, IThemable

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 IsPasswordVisibleProperty
Field Value
System.Windows.DependencyProperty

PasswordChangedEvent

Identifies the PasswordChanged routed event.

Declaration
public static readonly RoutedEvent PasswordChangedEvent
Field Value
System.Windows.RoutedEvent

PasswordCharProperty

Identifies the PasswordChar dependency property.

Declaration
public static readonly DependencyProperty PasswordCharProperty
Field Value
System.Windows.DependencyProperty

ShowPasswordButtonContentProperty

Identifies the ShowPasswordButtonContent dependency property.

Declaration
public static readonly DependencyProperty ShowPasswordButtonContentProperty
Field Value
System.Windows.DependencyProperty

ShowPasswordButtonContentTemplateProperty

Identifies the ShowPasswordButtonContentTemplate dependency property.

Declaration
public static readonly DependencyProperty ShowPasswordButtonContentTemplateProperty
Field Value
System.Windows.DependencyProperty

ShowPasswordButtonVisibilityProperty

Identifies the ShowPasswordButtonVisibility dependency property.

Declaration
public static readonly DependencyProperty ShowPasswordButtonVisibilityProperty
Field Value
System.Windows.DependencyProperty

Properties

IsPasswordVisible

Gets value indicating whether the actual password is currently displayed.

Declaration
public bool IsPasswordVisible { get; }
Property Value
System.Boolean

Password

Gets or sets the current password as a string representation.

Declaration
public string Password { get; set; }
Property Value
System.String

PasswordChar

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

Declaration
public char PasswordChar { get; set; }
Property Value
System.Char

SecurePassword

Gets the current password as a System.Security.SecureString.

Declaration
public SecureString SecurePassword { get; }
Property Value
System.Security.SecureString

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
System.Object

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
System.Windows.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
ShowPasswordButtonVisibilityMode

Methods

Clear()

Clears the current Password.

Declaration
public void Clear()

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
System.Windows.Input.Key key

The key that has been pressed.
Returns
System.Boolean

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
System.Windows.Size constraint

A maximum System.Windows.Size to not exceed.
Returns
System.Windows.Size

OnApplyTemplate()

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

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
System.Windows.Automation.Peers.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
System.Windows.DragEventArgs e

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
System.Windows.Input.KeyEventArgs e

OnPreviewTextInput(TextCompositionEventArgs)

Virtual method reporting text composition.

Declaration
protected override void OnPreviewTextInput(TextCompositionEventArgs e)
Parameters
System.Windows.Input.TextCompositionEventArgs e

Events

PasswordChanged

Occurs when the value of the Password property changes.

Declaration
[SRCategory("Behavior")]
public event RoutedEventHandler PasswordChanged
Event Type
System.Windows.RoutedEventHandler

Extension Methods