Class XpUserEntry
Inheritance
System.Object
XpUserEntry
Implements
System.ComponentModel.ISupportInitialize
Assembly: Syncfusion.Shared.Base.dll
Syntax
public class XpUserEntry : ContainerControl, ISupportInitialize
Constructors
XpUserEntry()
Constructor this component.
Declaration
Fields
ImageIndexEditor
Declaration
public const string ImageIndexEditor = "System.Windows.Forms.Design.ImageIndexEditor, System.Design, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a"
Field Value
| Type |
Description |
| System.String |
|
m_textBox
TextBox for password enter.
Declaration
protected TextBox m_textBox
Field Value
| Type |
Description |
| System.Windows.Forms.TextBox |
|
m_textStringFormat
String format outputing text.
Declaration
protected StringFormat m_textStringFormat
Field Value
| Type |
Description |
| System.Drawing.StringFormat |
|
Properties
AutoHideTextBox
Get or set auto hide text box as control lost focus.
Declaration
public bool AutoHideTextBox { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
AutoResetPassword
Get or set auto reset password as text box show.
Declaration
public bool AutoResetPassword { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
ButtonEnterIcon
Get or set user icon as select mode.
Declaration
public Image ButtonEnterIcon { get; set; }
Property Value
| Type |
Description |
| System.Drawing.Image |
|
Buttons
Declaration
public XPUserEntryButtonsCollection Buttons { get; set; }
Property Value
DefaultIcon
Get or set default user icon.
Declaration
public Image DefaultIcon { get; set; }
Property Value
| Type |
Description |
| System.Drawing.Image |
|
DefaultImageIndex
Get or set user icon index from image list.
Declaration
public int DefaultImageIndex { get; set; }
Property Value
| Type |
Description |
| System.Int32 |
|
HelpString
Declaration
public string HelpString { get; set; }
Property Value
| Type |
Description |
| System.String |
|
ImageList
Get or set image list user icons.
Declaration
public ImageList ImageList { get; set; }
Property Value
| Type |
Description |
| System.Windows.Forms.ImageList |
|
IsActive
Get active mode as mouse overhead component.
Declaration
protected bool IsActive { get; }
Property Value
| Type |
Description |
| System.Boolean |
|
IsSelected
Declaration
protected bool IsSelected { get; }
Property Value
| Type |
Description |
| System.Boolean |
|
QuietMode
True - do not raise any events, otherwise False.
Declaration
protected bool QuietMode { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
SelectedImageIndex
Get or set user icon index from image list.
Declaration
public int SelectedImageIndex { get; set; }
Property Value
| Type |
Description |
| System.Int32 |
|
SelectIcon
Get or set select user icon.
Declaration
public Image SelectIcon { get; set; }
Property Value
| Type |
Description |
| System.Drawing.Image |
|
Style
Get or set component style.
Declaration
public XpUserStyle Style { get; set; }
Property Value
Text
Declaration
public override string Text { get; set; }
Property Value
| Type |
Description |
| System.String |
|
TextBox
Declaration
public TextBox TextBox { get; }
Property Value
| Type |
Description |
| System.Windows.Forms.TextBox |
|
TextRenderingHint
Get or set Text Rendering Hint.
Declaration
public TextRenderingHint TextRenderingHint { get; set; }
Property Value
| Type |
Description |
| System.Drawing.Text.TextRenderingHint |
|
ThumbnailSize
Get or set user icon size.
Declaration
public Size ThumbnailSize { get; set; }
Property Value
| Type |
Description |
| System.Drawing.Size |
|
UserName
Declaration
public string UserName { get; set; }
Property Value
| Type |
Description |
| System.String |
|
Methods
BeginInit()
Declaration
public virtual void BeginInit()
CloseInputArea()
Declaration
public void CloseInputArea()
Dispose(Boolean)
Declaration
protected override void Dispose(bool disposing)
Parameters
| Type |
Name |
Description |
| System.Boolean |
disposing |
|
EndInit()
Declaration
public virtual void EndInit()
Finalize()
Declaration
protected override void Finalize()
HitTest(Point)
Retrieves object at the specified screen coordinates.
Declaration
public HitAreas HitTest(Point pt)
Parameters
| Type |
Name |
Description |
| System.Drawing.Point |
pt |
Screen coordinate
|
Returns
| Type |
Description |
| HitAreas |
Retrieves object at the specified screen coordinates.
|
HitTest(Int32, Int32)
Retrieves object at the specified screen coordinates.
Declaration
public HitAreas HitTest(int x, int y)
Parameters
| Type |
Name |
Description |
| System.Int32 |
x |
The horizontal screen coordinate.
|
| System.Int32 |
y |
The vertical screen coordinate.
|
Returns
| Type |
Description |
| HitAreas |
Retrieves the child object at the specified screen coordinates.
|
OnAutoHideTextBoxChanged(ValueChangedEventArgs)
Occurs when auto hide text box changed.
Declaration
protected virtual void OnAutoHideTextBoxChanged(ValueChangedEventArgs args)
Parameters
OnAutoResetPasswordChanged(ValueChangedEventArgs)
Occurs when auto reset password changed.
Declaration
protected virtual void OnAutoResetPasswordChanged(ValueChangedEventArgs args)
Parameters
OnButtonEnterIconChanged(ValueChangedEventArgs)
Occurs when button enter icon changed.
Declaration
protected virtual void OnButtonEnterIconChanged(ValueChangedEventArgs args)
Parameters
OnClick(EventArgs)
Declaration
protected override void OnClick(EventArgs e)
Parameters
| Type |
Name |
Description |
| System.EventArgs |
e |
|
OnDefaultIconChanged(ValueChangedEventArgs)
Occurs when default icon changed.
Declaration
protected virtual void OnDefaultIconChanged(ValueChangedEventArgs args)
Parameters
OnDefaultImageIndexChanged(ValueChangedEventArgs)
Occurs when default image index changed.
Declaration
protected virtual void OnDefaultImageIndexChanged(ValueChangedEventArgs args)
Parameters
OnGotFocus(EventArgs)
Declaration
protected override void OnGotFocus(EventArgs e)
Parameters
| Type |
Name |
Description |
| System.EventArgs |
e |
|
OnHelpStringChanged(ValueChangedEventArgs)
Occurs when help string changed.
Declaration
protected virtual void OnHelpStringChanged(ValueChangedEventArgs args)
Parameters
OnImageListChanged(ValueChangedEventArgs)
Occurs when image list changed.
Declaration
protected virtual void OnImageListChanged(ValueChangedEventArgs args)
Parameters
OnLostFocus(EventArgs)
Declaration
protected override void OnLostFocus(EventArgs e)
Parameters
| Type |
Name |
Description |
| System.EventArgs |
e |
|
OnMouseDown(MouseEventArgs)
Declaration
protected override void OnMouseDown(MouseEventArgs e)
Parameters
| Type |
Name |
Description |
| System.Windows.Forms.MouseEventArgs |
e |
|
OnMouseEnter(EventArgs)
Declaration
protected override void OnMouseEnter(EventArgs e)
Parameters
| Type |
Name |
Description |
| System.EventArgs |
e |
|
OnMouseLeave(EventArgs)
Declaration
protected override void OnMouseLeave(EventArgs e)
Parameters
| Type |
Name |
Description |
| System.EventArgs |
e |
|
OnMouseMove(MouseEventArgs)
Declaration
protected override void OnMouseMove(MouseEventArgs e)
Parameters
| Type |
Name |
Description |
| System.Windows.Forms.MouseEventArgs |
e |
|
OnMouseUp(MouseEventArgs)
Declaration
protected override void OnMouseUp(MouseEventArgs e)
Parameters
| Type |
Name |
Description |
| System.Windows.Forms.MouseEventArgs |
e |
|
OnPaint(PaintEventArgs)
Declaration
protected override void OnPaint(PaintEventArgs e)
Parameters
| Type |
Name |
Description |
| System.Windows.Forms.PaintEventArgs |
e |
|
OnPasswordBoxChanged(ValueChangedEventArgs)
Occurs when password box changed.
Declaration
protected virtual void OnPasswordBoxChanged(ValueChangedEventArgs args)
Parameters
OnPasswordEnter(PasswordEnterEventArgs)
Occurs when user enter password.
Declaration
protected virtual void OnPasswordEnter(PasswordEnterEventArgs e)
Parameters
OnPasswordKeyPress(Object, KeyPressEventArgs)
Declaration
protected void OnPasswordKeyPress(object sender, KeyPressEventArgs e)
Parameters
| Type |
Name |
Description |
| System.Object |
sender |
|
| System.Windows.Forms.KeyPressEventArgs |
e |
|
OnPaswordBoxLeave(Object, EventArgs)
Declaration
protected void OnPaswordBoxLeave(object sender, EventArgs e)
Parameters
| Type |
Name |
Description |
| System.Object |
sender |
|
| System.EventArgs |
e |
|
OnQuietModeChanged()
Occurs when quiet mode changed.
Declaration
protected virtual void OnQuietModeChanged()
OnResize(EventArgs)
Declaration
protected override void OnResize(EventArgs e)
Parameters
| Type |
Name |
Description |
| System.EventArgs |
e |
|
OnRightToLeftChanged(EventArgs)
Declaration
protected override void OnRightToLeftChanged(EventArgs e)
Parameters
| Type |
Name |
Description |
| System.EventArgs |
e |
|
OnSelectIconChanged(ValueChangedEventArgs)
Occurs when select icon changed.
Declaration
protected virtual void OnSelectIconChanged(ValueChangedEventArgs args)
Parameters
OnTextBoxCreate()
Occurs when text box create.
Declaration
protected virtual void OnTextBoxCreate()
OnTextBoxInitialize()
Occurs when text box initialize.
Declaration
protected virtual void OnTextBoxInitialize()
OnTextRenderingHintChanged(ValueChangedEventArgs)
Occurs when text rendering hint changed.
Declaration
protected virtual void OnTextRenderingHintChanged(ValueChangedEventArgs args)
Parameters
OnThumbnailSizeChanged(ValueChangedEventArgs)
Occurs when thumbnail size changed.
Declaration
protected virtual void OnThumbnailSizeChanged(ValueChangedEventArgs args)
Parameters
OnUserNameChanged(ValueChangedEventArgs)
Occurs when user name changed.
Declaration
protected virtual void OnUserNameChanged(ValueChangedEventArgs args)
Parameters
RaiseAutoHideTextBoxChanged(ValueChangedEventArgs)
Declaration
protected void RaiseAutoHideTextBoxChanged(ValueChangedEventArgs args)
Parameters
RaiseAutoResetPasswordChanged(ValueChangedEventArgs)
Declaration
protected void RaiseAutoResetPasswordChanged(ValueChangedEventArgs args)
Parameters
RaiseButtonEnterIconChanged(ValueChangedEventArgs)
Declaration
protected void RaiseButtonEnterIconChanged(ValueChangedEventArgs args)
Parameters
RaiseDefaultIconChanged(ValueChangedEventArgs)
Declaration
protected void RaiseDefaultIconChanged(ValueChangedEventArgs args)
Parameters
RaiseDefaultImageIndex(ValueChangedEventArgs)
Declaration
protected void RaiseDefaultImageIndex(ValueChangedEventArgs args)
Parameters
RaiseHelpStringChanged(ValueChangedEventArgs)
Declaration
protected void RaiseHelpStringChanged(ValueChangedEventArgs args)
Parameters
RaiseImageListChanged(ValueChangedEventArgs)
Declaration
protected void RaiseImageListChanged(ValueChangedEventArgs args)
Parameters
RaisePasswordBoxChanged(ValueChangedEventArgs)
Declaration
protected void RaisePasswordBoxChanged(ValueChangedEventArgs args)
Parameters
RaiseQuietModeChangedEvent()
Declaration
protected void RaiseQuietModeChangedEvent()
RaiseSelectIconChanged(ValueChangedEventArgs)
Declaration
protected void RaiseSelectIconChanged(ValueChangedEventArgs args)
Parameters
RaiseTextRenderingHintChanged(ValueChangedEventArgs)
Declaration
protected void RaiseTextRenderingHintChanged(ValueChangedEventArgs args)
Parameters
RaiseThumbnailSizeChanged(ValueChangedEventArgs)
Declaration
protected void RaiseThumbnailSizeChanged(ValueChangedEventArgs args)
Parameters
RaiseUserNameChanged(ValueChangedEventArgs)
Declaration
protected void RaiseUserNameChanged(ValueChangedEventArgs args)
Parameters
ShouldSerializeThumbnailSize()
Declaration
protected bool ShouldSerializeThumbnailSize()
Returns
| Type |
Description |
| System.Boolean |
|
Events
AutoHideTextBoxChanged
Occurs when auto hide text box changed.
Declaration
public event ValueChangedEventHandler AutoHideTextBoxChanged
Event Type
AutoResetPasswordChanged
Occurs when auto reset password changed.
Declaration
public event ValueChangedEventHandler AutoResetPasswordChanged
Event Type
ButtonEnterIconChanged
Occurs when button enter icon changed.
Declaration
public event ValueChangedEventHandler ButtonEnterIconChanged
Event Type
DefaultIconChanged
Occurs when default icon changed.
Declaration
public event ValueChangedEventHandler DefaultIconChanged
Event Type
DefaultImageIndexChanged
Occurs when default image index changed.
Declaration
public event ValueChangedEventHandler DefaultImageIndexChanged
Event Type
HelpStringChanged
Occurs when help string changed.
Declaration
public event ValueChangedEventHandler HelpStringChanged
Event Type
ImageListChanged
Occurs when image list changed.
Declaration
public event ValueChangedEventHandler ImageListChanged
Event Type
PasswordBoxChanged
Occurs when password box changed.
Declaration
public event ValueChangedEventHandler PasswordBoxChanged
Event Type
PasswordEnter
Occurs when when user enter password.
Declaration
public event PasswordEnterEventHandler PasswordEnter
Event Type
QuietModeChanged
Occurs when quiet mode changed.
Declaration
public event EventHandler QuietModeChanged
Event Type
| Type |
Description |
| System.EventHandler |
|
SelectIconChanged
Occurs when select icon changed.
Declaration
public event ValueChangedEventHandler SelectIconChanged
Event Type
TextRenderingHintChanged
Occurs when text rendering hint changed.
Declaration
public event ValueChangedEventHandler TextRenderingHintChanged
Event Type
ThumbnailSizeChanged
Occurs when thumbnail size changed.
Declaration
public event ValueChangedEventHandler ThumbnailSizeChanged
Event Type
UserNameChanged
Occurs when user name changed.
Declaration
public event ValueChangedEventHandler UserNameChanged
Event Type
Implements
System.ComponentModel.ISupportInitialize
