Code:
/ 4.0 / 4.0 / DEVDIV_TFS / Dev10 / Releases / RTMRel / ndp / fx / src / WinForms / Managed / System / WinForms / TextBox.cs / 1305376 / TextBox.cs
//------------------------------------------------------------------------------
//
// Copyright (c) Microsoft Corporation. All rights reserved.
//
//-----------------------------------------------------------------------------
/*
*/
namespace System.Windows.Forms {
using System.Runtime.Remoting;
using System.ComponentModel;
using System.Diagnostics;
using System;
using System.Security.Permissions;
using System.Windows.Forms;
using System.ComponentModel.Design;
using System.Drawing;
using Microsoft.Win32;
using System.Reflection;
using System.Text;
using System.Runtime.InteropServices;
using System.Collections.Specialized;
using System.Drawing.Design;
using System.Security;
using System.Windows.Forms.VisualStyles;
///
///
/// Represents a Windows text box control.
///
///
[
ClassInterface(ClassInterfaceType.AutoDispatch),
ComVisible(true),
Designer("System.Windows.Forms.Design.TextBoxDesigner, " + AssemblyRef.SystemDesign),
SRDescription(SR.DescriptionTextBox)
]
public class TextBox : TextBoxBase {
private static readonly object EVENT_TEXTALIGNCHANGED = new object();
///
/// Controls whether or not the edit box consumes/respects ENTER key
/// presses. While this is typically desired by multiline edits, this
/// can interfere with normal key processing in a dialog.
///
private bool acceptsReturn = false;
///
/// Indicates what the current special password character is. This is
/// displayed instead of any other text the user might enter.
///
private char passwordChar = (char)0;
private bool useSystemPasswordChar;
///
/// Controls whether or not the case of characters entered into the edit
/// box is forced to a specific case.
///
private CharacterCasing characterCasing = System.Windows.Forms.CharacterCasing.Normal;
///
/// Controls which scrollbars appear by default.
///
private ScrollBars scrollBars = System.Windows.Forms.ScrollBars.None;
///
/// Controls text alignment in the edit box.
///
private HorizontalAlignment textAlign = HorizontalAlignment.Left;
///
/// True if the selection has been set by the user. If the selection has
/// never been set and we get focus, we focus all the text in the control
/// so we mimic the Windows dialog manager.
///
private bool selectionSet = false;
///
/// This stores the value for the autocomplete mode which can be either
/// None, AutoSuggest, AutoAppend or AutoSuggestAppend.
///
private AutoCompleteMode autoCompleteMode = AutoCompleteMode.None;
///
/// This stores the value for the autoCompleteSource mode which can be one of the values
/// from AutoCompleteSource enum.
///
private AutoCompleteSource autoCompleteSource = AutoCompleteSource.None;
///
/// This stores the custom StringCollection required for the autoCompleteSource when its set to CustomSource.
///
private AutoCompleteStringCollection autoCompleteCustomSource;
private bool fromHandleCreate = false;
private StringSource stringSource = null;
///
///
/// Gets or sets a value indicating whether pressing ENTER
/// in a multiline
///
[
SRCategory(SR.CatBehavior),
DefaultValue(false),
SRDescription(SR.TextBoxAcceptsReturnDescr)
]
public bool AcceptsReturn {
get {
return acceptsReturn;
}
set {
acceptsReturn = value;
}
}
///
/// This is the AutoCompleteMode which can be either
/// None, AutoSuggest, AutoAppend or AutoSuggestAppend.
/// This property in conjunction with AutoCompleteSource enables the AutoComplete feature for TextBox.
///
[
DefaultValue(AutoCompleteMode.None),
SRDescription(SR.TextBoxAutoCompleteModeDescr),
Browsable(true), EditorBrowsable(EditorBrowsableState.Always)
]
public AutoCompleteMode AutoCompleteMode {
get {
return autoCompleteMode;
}
set {
if (!ClientUtils.IsEnumValid(value, (int)value, (int)AutoCompleteMode.None, (int)AutoCompleteMode.SuggestAppend)){
throw new InvalidEnumArgumentException("value", (int)value, typeof(AutoCompleteMode));
}
bool resetAutoComplete = false;
if (autoCompleteMode != AutoCompleteMode.None && value == AutoCompleteMode.None) {
resetAutoComplete = true;
}
autoCompleteMode = value;
SetAutoComplete(resetAutoComplete);
}
}
///
/// This is the AutoCompleteSource which can be one of the
/// values from AutoCompleteSource enumeration.
/// This property in conjunction with AutoCompleteMode enables the AutoComplete feature for TextBox.
///
[
DefaultValue(AutoCompleteSource.None),
SRDescription(SR.TextBoxAutoCompleteSourceDescr),
TypeConverterAttribute(typeof(TextBoxAutoCompleteSourceConverter)),
Browsable(true), EditorBrowsable(EditorBrowsableState.Always)
]
public AutoCompleteSource AutoCompleteSource {
get {
return autoCompleteSource;
}
set {
// FxCop: Avoid usage of Enum.IsDefined - this looks like an enum that could grow
if (!ClientUtils.IsEnumValid_NotSequential(value,
(int)value,
(int)AutoCompleteSource.None,
(int)AutoCompleteSource.AllSystemSources,
(int)AutoCompleteSource.AllUrl,
(int)AutoCompleteSource.CustomSource,
(int)AutoCompleteSource.FileSystem,
(int)AutoCompleteSource.FileSystemDirectories,
(int)AutoCompleteSource.HistoryList,
(int)AutoCompleteSource.ListItems,
(int)AutoCompleteSource.RecentlyUsedList)){
throw new InvalidEnumArgumentException("value", (int)value, typeof(AutoCompleteSource));
}
if (value == AutoCompleteSource.ListItems) {
throw new NotSupportedException(SR.GetString(SR.TextBoxAutoCompleteSourceNoItems));
}
// VSWhidbey 466300
if (value != AutoCompleteSource.None && value != AutoCompleteSource.CustomSource)
{
FileIOPermission fiop = new FileIOPermission(PermissionState.Unrestricted);
fiop.AllFiles = FileIOPermissionAccess.PathDiscovery;
fiop.Demand();
}
autoCompleteSource = value;
SetAutoComplete(false);
}
}
///
/// This is the AutoCompleteCustomSource which is custom StringCollection used when the
/// AutoCompleteSource is CustomSource.
///
[
DesignerSerializationVisibility(DesignerSerializationVisibility.Content),
Localizable(true),
SRDescription(SR.TextBoxAutoCompleteCustomSourceDescr),
Editor("System.Windows.Forms.Design.ListControlStringCollectionEditor, " + AssemblyRef.SystemDesign, typeof(UITypeEditor)),
Browsable(true), EditorBrowsable(EditorBrowsableState.Always)
]
public AutoCompleteStringCollection AutoCompleteCustomSource {
get {
if (autoCompleteCustomSource == null) {
autoCompleteCustomSource = new AutoCompleteStringCollection();
autoCompleteCustomSource.CollectionChanged += new CollectionChangeEventHandler(this.OnAutoCompleteCustomSourceChanged);
}
return autoCompleteCustomSource;
}
set {
if (autoCompleteCustomSource != value) {
if (autoCompleteCustomSource != null) {
autoCompleteCustomSource.CollectionChanged -= new CollectionChangeEventHandler(this.OnAutoCompleteCustomSourceChanged);
}
autoCompleteCustomSource = value;
if (value != null) {
autoCompleteCustomSource.CollectionChanged += new CollectionChangeEventHandler(this.OnAutoCompleteCustomSourceChanged);
}
SetAutoComplete(false);
}
}
}
///
///
/// Gets or sets whether the TextBox control
/// modifies the case of characters as they are typed.
///
///
[
SRCategory(SR.CatBehavior),
DefaultValue(CharacterCasing.Normal),
SRDescription(SR.TextBoxCharacterCasingDescr)
]
public CharacterCasing CharacterCasing {
get {
return characterCasing;
}
set {
if (characterCasing != value) {
//verify that 'value' is a valid enum type...
//valid values are 0x0 to 0x2
if (!ClientUtils.IsEnumValid(value, (int)value, (int)CharacterCasing.Normal, (int)CharacterCasing.Lower)){
throw new InvalidEnumArgumentException("value", (int)value, typeof(CharacterCasing));
}
characterCasing = value;
RecreateHandle();
}
}
}
///
/// [To be supplied.]
///
public override bool Multiline {
get {
return base.Multiline;
}
set {
if (Multiline != value)
{
base.Multiline = value;
if (value && AutoCompleteMode != AutoCompleteMode.None)
{
RecreateHandle();
}
}
}
}
///
/// Determines if the control is in password protect mode.
///
internal override bool PasswordProtect {
get {
return this.PasswordChar != '\0';
}
}
///
///
/// Returns the parameters needed to create the handle. Inheriting classes
/// can override this to provide extra functionality. They should not,
/// however, forget to call base.getCreateParams() first to get the struct
/// filled up with the basic info.
///
///
protected override CreateParams CreateParams {
[SecurityPermission(SecurityAction.LinkDemand, Flags=SecurityPermissionFlag.UnmanagedCode)]
get {
CreateParams cp = base.CreateParams;
switch (characterCasing) {
case CharacterCasing.Lower:
cp.Style |= NativeMethods.ES_LOWERCASE;
break;
case CharacterCasing.Upper:
cp.Style |= NativeMethods.ES_UPPERCASE;
break;
}
// Translate for Rtl if necessary
//
HorizontalAlignment align = RtlTranslateHorizontal(textAlign);
cp.ExStyle &= ~NativeMethods.WS_EX_RIGHT; // WS_EX_RIGHT overrides the ES_XXXX alignment styles
switch (align) {
case HorizontalAlignment.Left:
cp.Style |= NativeMethods.ES_LEFT;
break;
case HorizontalAlignment.Center:
cp.Style |= NativeMethods.ES_CENTER;
break;
case HorizontalAlignment.Right:
cp.Style |= NativeMethods.ES_RIGHT;
break;
}
if (Multiline) {
// vs 59731: Don't show horizontal scroll bars which won't do anything
if ((scrollBars & ScrollBars.Horizontal) == ScrollBars.Horizontal
&& textAlign == HorizontalAlignment.Left
&& !WordWrap) {
cp.Style |= NativeMethods.WS_HSCROLL;
}
if ((scrollBars & ScrollBars.Vertical) == ScrollBars.Vertical) {
cp.Style |= NativeMethods.WS_VSCROLL;
}
}
if (useSystemPasswordChar) {
cp.Style |= NativeMethods.ES_PASSWORD;
}
return cp;
}
}
///
///
/// Gets or sets the character used to mask characters in a single-line text box
/// control used to enter passwords.
///
///
[
SRCategory(SR.CatBehavior),
DefaultValue((char)0),
Localizable(true),
SRDescription(SR.TextBoxPasswordCharDescr),
RefreshProperties(RefreshProperties.Repaint)
]
public char PasswordChar {
get {
if (!IsHandleCreated) {
CreateHandle();
}
return (char)SendMessage(NativeMethods.EM_GETPASSWORDCHAR, 0, 0);
}
set {
passwordChar = value;
if (!useSystemPasswordChar) {
if (IsHandleCreated) {
if (PasswordChar != value) {
// Set the password mode.
SendMessage(NativeMethods.EM_SETPASSWORDCHAR, value, 0);
// Disable IME if setting the control to password mode.
VerifyImeRestrictedModeChanged();
ResetAutoComplete(false);
Invalidate();
}
}
}
}
}
///
///
/// Gets or sets which scroll bars should
/// appear in a multiline
///
[
SRCategory(SR.CatAppearance),
Localizable(true),
DefaultValue(ScrollBars.None),
SRDescription(SR.TextBoxScrollBarsDescr)
]
public ScrollBars ScrollBars {
get {
return scrollBars;
}
set {
if (scrollBars != value) {
//valid values are 0x0 to 0x3
if (!ClientUtils.IsEnumValid(value, (int)value, (int)ScrollBars.None, (int)ScrollBars.Both)){
throw new InvalidEnumArgumentException("value", (int)value, typeof(ScrollBars));
}
scrollBars = value;
RecreateHandle();
}
}
}
internal override Size GetPreferredSizeCore(Size proposedConstraints) {
Size scrollBarPadding = Size.Empty;
if(Multiline && !WordWrap && (ScrollBars & ScrollBars.Horizontal) != 0) {
scrollBarPadding.Height += SystemInformation.HorizontalScrollBarHeight;
}
if(Multiline && (ScrollBars & ScrollBars.Vertical) != 0) {
scrollBarPadding.Width += SystemInformation.VerticalScrollBarWidth;
}
// Subtract the scroll bar padding before measuring
proposedConstraints -= scrollBarPadding;
Size prefSize = base.GetPreferredSizeCore(proposedConstraints);
return prefSize + scrollBarPadding;
}
///
///
/// Gets or sets
/// the current text in the text box.
///
///
public override string Text {
get {
return base.Text;
}
set {
base.Text = value;
selectionSet = false;
}
}
///
///
/// Gets or sets how text is
/// aligned in a
///
[
Localizable(true),
SRCategory(SR.CatAppearance),
DefaultValue(HorizontalAlignment.Left),
SRDescription(SR.TextBoxTextAlignDescr)
]
public HorizontalAlignment TextAlign {
get {
return textAlign;
}
set {
if (textAlign != value) {
//verify that 'value' is a valid enum type...
//valid values are 0x0 to 0x2
if (!ClientUtils.IsEnumValid(value, (int)value, (int)HorizontalAlignment.Left, (int)HorizontalAlignment.Center)){
throw new InvalidEnumArgumentException("value", (int)value, typeof(HorizontalAlignment));
}
textAlign = value;
RecreateHandle();
OnTextAlignChanged(EventArgs.Empty);
}
}
}
///
///
/// Indicates if the text in the edit control should appear as
/// the default password character. This property has precedence
/// over the PasswordChar property. Whenever the UseSystemPasswordChar
/// is set to true, the default system password character is used,
/// any character set into PasswordChar is ignored.
///
///
[
SRCategory(SR.CatBehavior),
DefaultValue(false),
SRDescription(SR.TextBoxUseSystemPasswordCharDescr),
RefreshProperties(RefreshProperties.Repaint)
]
public bool UseSystemPasswordChar {
get {
return useSystemPasswordChar;
}
set {
if (value != useSystemPasswordChar) {
useSystemPasswordChar = value;
// RecreateHandle will update IME restricted mode.
RecreateHandle();
if (value) {
ResetAutoComplete(false);
}
}
}
}
///
/// [To be supplied.]
///
[SRCategory(SR.CatPropertyChanged), SRDescription(SR.RadioButtonOnTextAlignChangedDescr)]
public event EventHandler TextAlignChanged {
add {
Events.AddHandler(EVENT_TEXTALIGNCHANGED, value);
}
remove {
Events.RemoveHandler(EVENT_TEXTALIGNCHANGED, value);
}
}
///
///
/// Overridden to handle RETURN key.
///
///
protected override bool IsInputKey(Keys keyData) {
if (Multiline && (keyData & Keys.Alt) == 0) {
switch (keyData & Keys.KeyCode) {
case Keys.Return:
return acceptsReturn;
}
}
return base.IsInputKey(keyData);
}
private void OnAutoCompleteCustomSourceChanged(object sender, CollectionChangeEventArgs e) {
if (AutoCompleteSource == AutoCompleteSource.CustomSource)
{
SetAutoComplete(true);
}
}
///
/// [To be supplied.]
///
protected override void OnFontChanged(EventArgs e) {
base.OnFontChanged(e);
if (this.AutoCompleteMode != AutoCompleteMode.None) {
//we always will recreate the handle when autocomplete mode is on
RecreateHandle();
}
}
///
/// Overrideen to focus the text on first focus.
///
protected override void OnGotFocus(EventArgs e) {
base.OnGotFocus(e);
if (!selectionSet) {
// We get one shot at selecting when we first get focus. If we don't
// do it, we still want to act like the selection was set.
selectionSet = true;
// If the user didn't provide a selection, force one in.
if (SelectionLength == 0 && Control.MouseButtons == MouseButtons.None) {
SelectAll();
}
}
}
///
/// Overridden to update the newly created handle with the settings of the
/// PasswordChar properties.
///
protected override void OnHandleCreated(EventArgs e) {
base.OnHandleCreated(e);
base.SetSelectionOnHandle();
if (passwordChar != 0) {
if (!useSystemPasswordChar) {
SendMessage(NativeMethods.EM_SETPASSWORDCHAR, passwordChar, 0);
}
}
VerifyImeRestrictedModeChanged();
if (AutoCompleteMode != AutoCompleteMode.None) {
try
{
fromHandleCreate = true;
SetAutoComplete(false);
}
finally
{
fromHandleCreate = false;
}
}
}
protected override void OnHandleDestroyed(EventArgs e)
{
if (stringSource != null)
{
stringSource.ReleaseAutoComplete();
stringSource = null;
}
base.OnHandleDestroyed(e);
}
///
/// [To be supplied.]
///
protected virtual void OnTextAlignChanged(EventArgs e) {
EventHandler eh = Events[EVENT_TEXTALIGNCHANGED] as EventHandler;
if (eh != null) {
eh(this, e);
}
}
///
/// Replaces the portion of the text specified by startPos and length with the one passed in,
/// without resetting the undo buffer (if any).
/// This method is provided as an alternative to SelectedText which clears the undo buffer.
/// Observe that this method does not honor the MaxLength property as the parameter-less base's
/// Paste does, see VSW#487664 for more info.
///
public void Paste(string text){
base.SetSelectedTextInternal(text, false);
}
///
/// Performs the actual select without doing arg checking.
///
internal override void SelectInternal(int start, int length, int textLen) {
// If user set selection into text box, mark it so we don't
// clobber it when we get focus.
selectionSet = true;
base.SelectInternal( start, length, textLen );
}
private string[] GetStringsForAutoComplete()
{
string[] strings = new string[AutoCompleteCustomSource.Count];
for (int i = 0; i < AutoCompleteCustomSource.Count; i++) {
strings[i] = AutoCompleteCustomSource[i];
}
return strings;
}
///
/// Sets the AutoComplete mode in TextBox.
///
internal void SetAutoComplete(bool reset)
{
//Autocomplete Not Enabled for Password enabled and MultiLine Textboxes.
if (Multiline || passwordChar != 0 || useSystemPasswordChar || AutoCompleteSource == AutoCompleteSource.None) {
return;
}
if (AutoCompleteMode != AutoCompleteMode.None) {
if (!fromHandleCreate)
{
//RecreateHandle to avoid Leak.
// notice the use of member variable to avoid re-entrancy
AutoCompleteMode backUpMode = this.AutoCompleteMode;
autoCompleteMode = AutoCompleteMode.None;
RecreateHandle();
autoCompleteMode = backUpMode;
}
if (AutoCompleteSource == AutoCompleteSource.CustomSource) {
if (IsHandleCreated && AutoCompleteCustomSource != null) {
if (AutoCompleteCustomSource.Count == 0) {
ResetAutoComplete(true);
}
else {
if (stringSource == null)
{
stringSource = new StringSource(GetStringsForAutoComplete());
if (!stringSource.Bind(new HandleRef(this, Handle), (int)AutoCompleteMode))
{
throw new ArgumentException(SR.GetString(SR.AutoCompleteFailure));
}
}
else
{
stringSource.RefreshList(GetStringsForAutoComplete());
}
}
}
}
else {
try {
if (IsHandleCreated) {
int mode = 0;
if (AutoCompleteMode == AutoCompleteMode.Suggest) {
mode |= NativeMethods.AUTOSUGGEST | NativeMethods.AUTOAPPEND_OFF;
}
if (AutoCompleteMode == AutoCompleteMode.Append) {
mode |= NativeMethods.AUTOAPPEND | NativeMethods.AUTOSUGGEST_OFF;
}
if (AutoCompleteMode == AutoCompleteMode.SuggestAppend) {
mode |= NativeMethods.AUTOSUGGEST;
mode |= NativeMethods.AUTOAPPEND;
}
int ret = SafeNativeMethods.SHAutoComplete(new HandleRef(this, Handle) , (int)AutoCompleteSource | mode);
}
}
catch (SecurityException) {
// If we don't have full trust, degrade gracefully. Allow the control to
// function without auto-complete. Allow the app to continue running.
}
}
}
else if (reset) {
ResetAutoComplete(true);
}
}
//
/// Resets the AutoComplete mode in TextBox.
///
private void ResetAutoComplete(bool force) {
if ((AutoCompleteMode != AutoCompleteMode.None || force) && IsHandleCreated) {
int mode = (int)AutoCompleteSource.AllSystemSources | NativeMethods.AUTOSUGGEST_OFF | NativeMethods.AUTOAPPEND_OFF;
SafeNativeMethods.SHAutoComplete(new HandleRef(this, Handle) , mode);
}
}
private void ResetAutoCompleteCustomSource() {
AutoCompleteCustomSource = null;
}
private void WmPrint(ref Message m) {
base.WndProc(ref m);
if ((NativeMethods.PRF_NONCLIENT & (int)m.LParam) != 0 && Application.RenderWithVisualStyles && this.BorderStyle == BorderStyle.Fixed3D) {
IntSecurity.UnmanagedCode.Assert();
try {
using (Graphics g = Graphics.FromHdc(m.WParam)) {
Rectangle rect = new Rectangle(0, 0, this.Size.Width - 1, this.Size.Height - 1);
using (Pen pen = new Pen(VisualStyleInformation.TextControlBorder)) {
g.DrawRectangle(pen, rect);
}
rect.Inflate(-1, -1);
g.DrawRectangle(SystemPens.Window, rect);
}
}
finally {
CodeAccessPermission.RevertAssert();
}
}
}
//-------------------------------------------------------------------------------------------------
///
/// The edits window procedure. Inheritng classes can override this
/// to add extra functionality, but should not forget to call
/// base.wndProc(m); to ensure the combo continues to function properly.
///
[SecurityPermission(SecurityAction.LinkDemand, Flags=SecurityPermissionFlag.UnmanagedCode)]
protected override void WndProc(ref Message m) {
switch (m.Msg) {
// Work around a very obscure Windows issue. See ASURT 45255.
case NativeMethods.WM_LBUTTONDOWN:
MouseButtons realState = MouseButtons;
bool wasValidationCancelled = ValidationCancelled;
FocusInternal();
if (realState == MouseButtons &&
(!ValidationCancelled || wasValidationCancelled)) {
base.WndProc(ref m);
}
break;
//for readability ... so that we know whats happening ...
// case WM_LBUTTONUP is included here eventhough it just calls the base.
case NativeMethods.WM_LBUTTONUP:
base.WndProc(ref m);
break;
case NativeMethods.WM_PRINT:
WmPrint(ref m);
break;
default:
base.WndProc(ref m);
break;
}
}
}
}
// File provided for Reference Use Only by Microsoft Corporation (c) 2007.
//------------------------------------------------------------------------------
//
// Copyright (c) Microsoft Corporation. All rights reserved.
//
//-----------------------------------------------------------------------------
/*
*/
namespace System.Windows.Forms {
using System.Runtime.Remoting;
using System.ComponentModel;
using System.Diagnostics;
using System;
using System.Security.Permissions;
using System.Windows.Forms;
using System.ComponentModel.Design;
using System.Drawing;
using Microsoft.Win32;
using System.Reflection;
using System.Text;
using System.Runtime.InteropServices;
using System.Collections.Specialized;
using System.Drawing.Design;
using System.Security;
using System.Windows.Forms.VisualStyles;
///
///
/// Represents a Windows text box control.
///
///
[
ClassInterface(ClassInterfaceType.AutoDispatch),
ComVisible(true),
Designer("System.Windows.Forms.Design.TextBoxDesigner, " + AssemblyRef.SystemDesign),
SRDescription(SR.DescriptionTextBox)
]
public class TextBox : TextBoxBase {
private static readonly object EVENT_TEXTALIGNCHANGED = new object();
///
/// Controls whether or not the edit box consumes/respects ENTER key
/// presses. While this is typically desired by multiline edits, this
/// can interfere with normal key processing in a dialog.
///
private bool acceptsReturn = false;
///
/// Indicates what the current special password character is. This is
/// displayed instead of any other text the user might enter.
///
private char passwordChar = (char)0;
private bool useSystemPasswordChar;
///
/// Controls whether or not the case of characters entered into the edit
/// box is forced to a specific case.
///
private CharacterCasing characterCasing = System.Windows.Forms.CharacterCasing.Normal;
///
/// Controls which scrollbars appear by default.
///
private ScrollBars scrollBars = System.Windows.Forms.ScrollBars.None;
///
/// Controls text alignment in the edit box.
///
private HorizontalAlignment textAlign = HorizontalAlignment.Left;
///
/// True if the selection has been set by the user. If the selection has
/// never been set and we get focus, we focus all the text in the control
/// so we mimic the Windows dialog manager.
///
private bool selectionSet = false;
///
/// This stores the value for the autocomplete mode which can be either
/// None, AutoSuggest, AutoAppend or AutoSuggestAppend.
///
private AutoCompleteMode autoCompleteMode = AutoCompleteMode.None;
///
/// This stores the value for the autoCompleteSource mode which can be one of the values
/// from AutoCompleteSource enum.
///
private AutoCompleteSource autoCompleteSource = AutoCompleteSource.None;
///
/// This stores the custom StringCollection required for the autoCompleteSource when its set to CustomSource.
///
private AutoCompleteStringCollection autoCompleteCustomSource;
private bool fromHandleCreate = false;
private StringSource stringSource = null;
///
///
/// Gets or sets a value indicating whether pressing ENTER
/// in a multiline
///
[
SRCategory(SR.CatBehavior),
DefaultValue(false),
SRDescription(SR.TextBoxAcceptsReturnDescr)
]
public bool AcceptsReturn {
get {
return acceptsReturn;
}
set {
acceptsReturn = value;
}
}
///
/// This is the AutoCompleteMode which can be either
/// None, AutoSuggest, AutoAppend or AutoSuggestAppend.
/// This property in conjunction with AutoCompleteSource enables the AutoComplete feature for TextBox.
///
[
DefaultValue(AutoCompleteMode.None),
SRDescription(SR.TextBoxAutoCompleteModeDescr),
Browsable(true), EditorBrowsable(EditorBrowsableState.Always)
]
public AutoCompleteMode AutoCompleteMode {
get {
return autoCompleteMode;
}
set {
if (!ClientUtils.IsEnumValid(value, (int)value, (int)AutoCompleteMode.None, (int)AutoCompleteMode.SuggestAppend)){
throw new InvalidEnumArgumentException("value", (int)value, typeof(AutoCompleteMode));
}
bool resetAutoComplete = false;
if (autoCompleteMode != AutoCompleteMode.None && value == AutoCompleteMode.None) {
resetAutoComplete = true;
}
autoCompleteMode = value;
SetAutoComplete(resetAutoComplete);
}
}
///
/// This is the AutoCompleteSource which can be one of the
/// values from AutoCompleteSource enumeration.
/// This property in conjunction with AutoCompleteMode enables the AutoComplete feature for TextBox.
///
[
DefaultValue(AutoCompleteSource.None),
SRDescription(SR.TextBoxAutoCompleteSourceDescr),
TypeConverterAttribute(typeof(TextBoxAutoCompleteSourceConverter)),
Browsable(true), EditorBrowsable(EditorBrowsableState.Always)
]
public AutoCompleteSource AutoCompleteSource {
get {
return autoCompleteSource;
}
set {
// FxCop: Avoid usage of Enum.IsDefined - this looks like an enum that could grow
if (!ClientUtils.IsEnumValid_NotSequential(value,
(int)value,
(int)AutoCompleteSource.None,
(int)AutoCompleteSource.AllSystemSources,
(int)AutoCompleteSource.AllUrl,
(int)AutoCompleteSource.CustomSource,
(int)AutoCompleteSource.FileSystem,
(int)AutoCompleteSource.FileSystemDirectories,
(int)AutoCompleteSource.HistoryList,
(int)AutoCompleteSource.ListItems,
(int)AutoCompleteSource.RecentlyUsedList)){
throw new InvalidEnumArgumentException("value", (int)value, typeof(AutoCompleteSource));
}
if (value == AutoCompleteSource.ListItems) {
throw new NotSupportedException(SR.GetString(SR.TextBoxAutoCompleteSourceNoItems));
}
// VSWhidbey 466300
if (value != AutoCompleteSource.None && value != AutoCompleteSource.CustomSource)
{
FileIOPermission fiop = new FileIOPermission(PermissionState.Unrestricted);
fiop.AllFiles = FileIOPermissionAccess.PathDiscovery;
fiop.Demand();
}
autoCompleteSource = value;
SetAutoComplete(false);
}
}
///
/// This is the AutoCompleteCustomSource which is custom StringCollection used when the
/// AutoCompleteSource is CustomSource.
///
[
DesignerSerializationVisibility(DesignerSerializationVisibility.Content),
Localizable(true),
SRDescription(SR.TextBoxAutoCompleteCustomSourceDescr),
Editor("System.Windows.Forms.Design.ListControlStringCollectionEditor, " + AssemblyRef.SystemDesign, typeof(UITypeEditor)),
Browsable(true), EditorBrowsable(EditorBrowsableState.Always)
]
public AutoCompleteStringCollection AutoCompleteCustomSource {
get {
if (autoCompleteCustomSource == null) {
autoCompleteCustomSource = new AutoCompleteStringCollection();
autoCompleteCustomSource.CollectionChanged += new CollectionChangeEventHandler(this.OnAutoCompleteCustomSourceChanged);
}
return autoCompleteCustomSource;
}
set {
if (autoCompleteCustomSource != value) {
if (autoCompleteCustomSource != null) {
autoCompleteCustomSource.CollectionChanged -= new CollectionChangeEventHandler(this.OnAutoCompleteCustomSourceChanged);
}
autoCompleteCustomSource = value;
if (value != null) {
autoCompleteCustomSource.CollectionChanged += new CollectionChangeEventHandler(this.OnAutoCompleteCustomSourceChanged);
}
SetAutoComplete(false);
}
}
}
///
///
/// Gets or sets whether the TextBox control
/// modifies the case of characters as they are typed.
///
///
[
SRCategory(SR.CatBehavior),
DefaultValue(CharacterCasing.Normal),
SRDescription(SR.TextBoxCharacterCasingDescr)
]
public CharacterCasing CharacterCasing {
get {
return characterCasing;
}
set {
if (characterCasing != value) {
//verify that 'value' is a valid enum type...
//valid values are 0x0 to 0x2
if (!ClientUtils.IsEnumValid(value, (int)value, (int)CharacterCasing.Normal, (int)CharacterCasing.Lower)){
throw new InvalidEnumArgumentException("value", (int)value, typeof(CharacterCasing));
}
characterCasing = value;
RecreateHandle();
}
}
}
///
/// [To be supplied.]
///
public override bool Multiline {
get {
return base.Multiline;
}
set {
if (Multiline != value)
{
base.Multiline = value;
if (value && AutoCompleteMode != AutoCompleteMode.None)
{
RecreateHandle();
}
}
}
}
///
/// Determines if the control is in password protect mode.
///
internal override bool PasswordProtect {
get {
return this.PasswordChar != '\0';
}
}
///
///
/// Returns the parameters needed to create the handle. Inheriting classes
/// can override this to provide extra functionality. They should not,
/// however, forget to call base.getCreateParams() first to get the struct
/// filled up with the basic info.
///
///
protected override CreateParams CreateParams {
[SecurityPermission(SecurityAction.LinkDemand, Flags=SecurityPermissionFlag.UnmanagedCode)]
get {
CreateParams cp = base.CreateParams;
switch (characterCasing) {
case CharacterCasing.Lower:
cp.Style |= NativeMethods.ES_LOWERCASE;
break;
case CharacterCasing.Upper:
cp.Style |= NativeMethods.ES_UPPERCASE;
break;
}
// Translate for Rtl if necessary
//
HorizontalAlignment align = RtlTranslateHorizontal(textAlign);
cp.ExStyle &= ~NativeMethods.WS_EX_RIGHT; // WS_EX_RIGHT overrides the ES_XXXX alignment styles
switch (align) {
case HorizontalAlignment.Left:
cp.Style |= NativeMethods.ES_LEFT;
break;
case HorizontalAlignment.Center:
cp.Style |= NativeMethods.ES_CENTER;
break;
case HorizontalAlignment.Right:
cp.Style |= NativeMethods.ES_RIGHT;
break;
}
if (Multiline) {
// vs 59731: Don't show horizontal scroll bars which won't do anything
if ((scrollBars & ScrollBars.Horizontal) == ScrollBars.Horizontal
&& textAlign == HorizontalAlignment.Left
&& !WordWrap) {
cp.Style |= NativeMethods.WS_HSCROLL;
}
if ((scrollBars & ScrollBars.Vertical) == ScrollBars.Vertical) {
cp.Style |= NativeMethods.WS_VSCROLL;
}
}
if (useSystemPasswordChar) {
cp.Style |= NativeMethods.ES_PASSWORD;
}
return cp;
}
}
///
///
/// Gets or sets the character used to mask characters in a single-line text box
/// control used to enter passwords.
///
///
[
SRCategory(SR.CatBehavior),
DefaultValue((char)0),
Localizable(true),
SRDescription(SR.TextBoxPasswordCharDescr),
RefreshProperties(RefreshProperties.Repaint)
]
public char PasswordChar {
get {
if (!IsHandleCreated) {
CreateHandle();
}
return (char)SendMessage(NativeMethods.EM_GETPASSWORDCHAR, 0, 0);
}
set {
passwordChar = value;
if (!useSystemPasswordChar) {
if (IsHandleCreated) {
if (PasswordChar != value) {
// Set the password mode.
SendMessage(NativeMethods.EM_SETPASSWORDCHAR, value, 0);
// Disable IME if setting the control to password mode.
VerifyImeRestrictedModeChanged();
ResetAutoComplete(false);
Invalidate();
}
}
}
}
}
///
///
/// Gets or sets which scroll bars should
/// appear in a multiline
///
[
SRCategory(SR.CatAppearance),
Localizable(true),
DefaultValue(ScrollBars.None),
SRDescription(SR.TextBoxScrollBarsDescr)
]
public ScrollBars ScrollBars {
get {
return scrollBars;
}
set {
if (scrollBars != value) {
//valid values are 0x0 to 0x3
if (!ClientUtils.IsEnumValid(value, (int)value, (int)ScrollBars.None, (int)ScrollBars.Both)){
throw new InvalidEnumArgumentException("value", (int)value, typeof(ScrollBars));
}
scrollBars = value;
RecreateHandle();
}
}
}
internal override Size GetPreferredSizeCore(Size proposedConstraints) {
Size scrollBarPadding = Size.Empty;
if(Multiline && !WordWrap && (ScrollBars & ScrollBars.Horizontal) != 0) {
scrollBarPadding.Height += SystemInformation.HorizontalScrollBarHeight;
}
if(Multiline && (ScrollBars & ScrollBars.Vertical) != 0) {
scrollBarPadding.Width += SystemInformation.VerticalScrollBarWidth;
}
// Subtract the scroll bar padding before measuring
proposedConstraints -= scrollBarPadding;
Size prefSize = base.GetPreferredSizeCore(proposedConstraints);
return prefSize + scrollBarPadding;
}
///
///
/// Gets or sets
/// the current text in the text box.
///
///
public override string Text {
get {
return base.Text;
}
set {
base.Text = value;
selectionSet = false;
}
}
///
///
/// Gets or sets how text is
/// aligned in a
///
[
Localizable(true),
SRCategory(SR.CatAppearance),
DefaultValue(HorizontalAlignment.Left),
SRDescription(SR.TextBoxTextAlignDescr)
]
public HorizontalAlignment TextAlign {
get {
return textAlign;
}
set {
if (textAlign != value) {
//verify that 'value' is a valid enum type...
//valid values are 0x0 to 0x2
if (!ClientUtils.IsEnumValid(value, (int)value, (int)HorizontalAlignment.Left, (int)HorizontalAlignment.Center)){
throw new InvalidEnumArgumentException("value", (int)value, typeof(HorizontalAlignment));
}
textAlign = value;
RecreateHandle();
OnTextAlignChanged(EventArgs.Empty);
}
}
}
///
///
/// Indicates if the text in the edit control should appear as
/// the default password character. This property has precedence
/// over the PasswordChar property. Whenever the UseSystemPasswordChar
/// is set to true, the default system password character is used,
/// any character set into PasswordChar is ignored.
///
///
[
SRCategory(SR.CatBehavior),
DefaultValue(false),
SRDescription(SR.TextBoxUseSystemPasswordCharDescr),
RefreshProperties(RefreshProperties.Repaint)
]
public bool UseSystemPasswordChar {
get {
return useSystemPasswordChar;
}
set {
if (value != useSystemPasswordChar) {
useSystemPasswordChar = value;
// RecreateHandle will update IME restricted mode.
RecreateHandle();
if (value) {
ResetAutoComplete(false);
}
}
}
}
///
/// [To be supplied.]
///
[SRCategory(SR.CatPropertyChanged), SRDescription(SR.RadioButtonOnTextAlignChangedDescr)]
public event EventHandler TextAlignChanged {
add {
Events.AddHandler(EVENT_TEXTALIGNCHANGED, value);
}
remove {
Events.RemoveHandler(EVENT_TEXTALIGNCHANGED, value);
}
}
///
///
/// Overridden to handle RETURN key.
///
///
protected override bool IsInputKey(Keys keyData) {
if (Multiline && (keyData & Keys.Alt) == 0) {
switch (keyData & Keys.KeyCode) {
case Keys.Return:
return acceptsReturn;
}
}
return base.IsInputKey(keyData);
}
private void OnAutoCompleteCustomSourceChanged(object sender, CollectionChangeEventArgs e) {
if (AutoCompleteSource == AutoCompleteSource.CustomSource)
{
SetAutoComplete(true);
}
}
///
/// [To be supplied.]
///
protected override void OnFontChanged(EventArgs e) {
base.OnFontChanged(e);
if (this.AutoCompleteMode != AutoCompleteMode.None) {
//we always will recreate the handle when autocomplete mode is on
RecreateHandle();
}
}
///
/// Overrideen to focus the text on first focus.
///
protected override void OnGotFocus(EventArgs e) {
base.OnGotFocus(e);
if (!selectionSet) {
// We get one shot at selecting when we first get focus. If we don't
// do it, we still want to act like the selection was set.
selectionSet = true;
// If the user didn't provide a selection, force one in.
if (SelectionLength == 0 && Control.MouseButtons == MouseButtons.None) {
SelectAll();
}
}
}
///
/// Overridden to update the newly created handle with the settings of the
/// PasswordChar properties.
///
protected override void OnHandleCreated(EventArgs e) {
base.OnHandleCreated(e);
base.SetSelectionOnHandle();
if (passwordChar != 0) {
if (!useSystemPasswordChar) {
SendMessage(NativeMethods.EM_SETPASSWORDCHAR, passwordChar, 0);
}
}
VerifyImeRestrictedModeChanged();
if (AutoCompleteMode != AutoCompleteMode.None) {
try
{
fromHandleCreate = true;
SetAutoComplete(false);
}
finally
{
fromHandleCreate = false;
}
}
}
protected override void OnHandleDestroyed(EventArgs e)
{
if (stringSource != null)
{
stringSource.ReleaseAutoComplete();
stringSource = null;
}
base.OnHandleDestroyed(e);
}
///
/// [To be supplied.]
///
protected virtual void OnTextAlignChanged(EventArgs e) {
EventHandler eh = Events[EVENT_TEXTALIGNCHANGED] as EventHandler;
if (eh != null) {
eh(this, e);
}
}
///
/// Replaces the portion of the text specified by startPos and length with the one passed in,
/// without resetting the undo buffer (if any).
/// This method is provided as an alternative to SelectedText which clears the undo buffer.
/// Observe that this method does not honor the MaxLength property as the parameter-less base's
/// Paste does, see VSW#487664 for more info.
///
public void Paste(string text){
base.SetSelectedTextInternal(text, false);
}
///
/// Performs the actual select without doing arg checking.
///
internal override void SelectInternal(int start, int length, int textLen) {
// If user set selection into text box, mark it so we don't
// clobber it when we get focus.
selectionSet = true;
base.SelectInternal( start, length, textLen );
}
private string[] GetStringsForAutoComplete()
{
string[] strings = new string[AutoCompleteCustomSource.Count];
for (int i = 0; i < AutoCompleteCustomSource.Count; i++) {
strings[i] = AutoCompleteCustomSource[i];
}
return strings;
}
///
/// Sets the AutoComplete mode in TextBox.
///
internal void SetAutoComplete(bool reset)
{
//Autocomplete Not Enabled for Password enabled and MultiLine Textboxes.
if (Multiline || passwordChar != 0 || useSystemPasswordChar || AutoCompleteSource == AutoCompleteSource.None) {
return;
}
if (AutoCompleteMode != AutoCompleteMode.None) {
if (!fromHandleCreate)
{
//RecreateHandle to avoid Leak.
// notice the use of member variable to avoid re-entrancy
AutoCompleteMode backUpMode = this.AutoCompleteMode;
autoCompleteMode = AutoCompleteMode.None;
RecreateHandle();
autoCompleteMode = backUpMode;
}
if (AutoCompleteSource == AutoCompleteSource.CustomSource) {
if (IsHandleCreated && AutoCompleteCustomSource != null) {
if (AutoCompleteCustomSource.Count == 0) {
ResetAutoComplete(true);
}
else {
if (stringSource == null)
{
stringSource = new StringSource(GetStringsForAutoComplete());
if (!stringSource.Bind(new HandleRef(this, Handle), (int)AutoCompleteMode))
{
throw new ArgumentException(SR.GetString(SR.AutoCompleteFailure));
}
}
else
{
stringSource.RefreshList(GetStringsForAutoComplete());
}
}
}
}
else {
try {
if (IsHandleCreated) {
int mode = 0;
if (AutoCompleteMode == AutoCompleteMode.Suggest) {
mode |= NativeMethods.AUTOSUGGEST | NativeMethods.AUTOAPPEND_OFF;
}
if (AutoCompleteMode == AutoCompleteMode.Append) {
mode |= NativeMethods.AUTOAPPEND | NativeMethods.AUTOSUGGEST_OFF;
}
if (AutoCompleteMode == AutoCompleteMode.SuggestAppend) {
mode |= NativeMethods.AUTOSUGGEST;
mode |= NativeMethods.AUTOAPPEND;
}
int ret = SafeNativeMethods.SHAutoComplete(new HandleRef(this, Handle) , (int)AutoCompleteSource | mode);
}
}
catch (SecurityException) {
// If we don't have full trust, degrade gracefully. Allow the control to
// function without auto-complete. Allow the app to continue running.
}
}
}
else if (reset) {
ResetAutoComplete(true);
}
}
//
/// Resets the AutoComplete mode in TextBox.
///
private void ResetAutoComplete(bool force) {
if ((AutoCompleteMode != AutoCompleteMode.None || force) && IsHandleCreated) {
int mode = (int)AutoCompleteSource.AllSystemSources | NativeMethods.AUTOSUGGEST_OFF | NativeMethods.AUTOAPPEND_OFF;
SafeNativeMethods.SHAutoComplete(new HandleRef(this, Handle) , mode);
}
}
private void ResetAutoCompleteCustomSource() {
AutoCompleteCustomSource = null;
}
private void WmPrint(ref Message m) {
base.WndProc(ref m);
if ((NativeMethods.PRF_NONCLIENT & (int)m.LParam) != 0 && Application.RenderWithVisualStyles && this.BorderStyle == BorderStyle.Fixed3D) {
IntSecurity.UnmanagedCode.Assert();
try {
using (Graphics g = Graphics.FromHdc(m.WParam)) {
Rectangle rect = new Rectangle(0, 0, this.Size.Width - 1, this.Size.Height - 1);
using (Pen pen = new Pen(VisualStyleInformation.TextControlBorder)) {
g.DrawRectangle(pen, rect);
}
rect.Inflate(-1, -1);
g.DrawRectangle(SystemPens.Window, rect);
}
}
finally {
CodeAccessPermission.RevertAssert();
}
}
}
//-------------------------------------------------------------------------------------------------
///
/// The edits window procedure. Inheritng classes can override this
/// to add extra functionality, but should not forget to call
/// base.wndProc(m); to ensure the combo continues to function properly.
///
[SecurityPermission(SecurityAction.LinkDemand, Flags=SecurityPermissionFlag.UnmanagedCode)]
protected override void WndProc(ref Message m) {
switch (m.Msg) {
// Work around a very obscure Windows issue. See ASURT 45255.
case NativeMethods.WM_LBUTTONDOWN:
MouseButtons realState = MouseButtons;
bool wasValidationCancelled = ValidationCancelled;
FocusInternal();
if (realState == MouseButtons &&
(!ValidationCancelled || wasValidationCancelled)) {
base.WndProc(ref m);
}
break;
//for readability ... so that we know whats happening ...
// case WM_LBUTTONUP is included here eventhough it just calls the base.
case NativeMethods.WM_LBUTTONUP:
base.WndProc(ref m);
break;
case NativeMethods.WM_PRINT:
WmPrint(ref m);
break;
default:
base.WndProc(ref m);
break;
}
}
}
}
// File provided for Reference Use Only by Microsoft Corporation (c) 2007.
Link Menu
This book is available now!
Buy at Amazon US or
Buy at Amazon UK
- DataGridTableCollection.cs
- AdjustableArrowCap.cs
- TextAdaptor.cs
- FileChangesMonitor.cs
- Gdiplus.cs
- Version.cs
- Visitors.cs
- ComboBoxDesigner.cs
- Comparer.cs
- ErrorFormatter.cs
- GridViewRowPresenter.cs
- TraceFilter.cs
- Char.cs
- ReadOnlyHierarchicalDataSource.cs
- JournalEntryListConverter.cs
- StickyNoteAnnotations.cs
- WebRequestModuleElementCollection.cs
- StreamReader.cs
- EntityContainer.cs
- SystemUdpStatistics.cs
- ExecutionContext.cs
- HuffModule.cs
- SmtpDateTime.cs
- TrackingServices.cs
- ItemCollection.cs
- CacheMemory.cs
- ConfigXmlText.cs
- MouseButton.cs
- WebPartPersonalization.cs
- LayoutDump.cs
- SqlProvider.cs
- PathGradientBrush.cs
- DbConnectionPool.cs
- TearOffProxy.cs
- HostedTcpTransportManager.cs
- RuleCache.cs
- PassportPrincipal.cs
- FillBehavior.cs
- X509CertificateRecipientClientCredential.cs
- PrintDialogException.cs
- WorkItem.cs
- WorkflowInspectionServices.cs
- ValueTypeFieldReference.cs
- OutputCacheProfile.cs
- IDReferencePropertyAttribute.cs
- ExpressionReplacer.cs
- AutomationPeer.cs
- CreateUserWizard.cs
- Clock.cs
- SelectManyQueryOperator.cs
- SqlClientWrapperSmiStreamChars.cs
- PrimitiveXmlSerializers.cs
- DataGridViewCellLinkedList.cs
- CheckBoxStandardAdapter.cs
- OpenTypeCommon.cs
- TreeIterator.cs
- XamlSerializationHelper.cs
- Clipboard.cs
- DispatcherProcessingDisabled.cs
- AsyncSerializedWorker.cs
- XmlMapping.cs
- ProfileBuildProvider.cs
- SwitchExpression.cs
- DmlSqlGenerator.cs
- TreeBuilderBamlTranslator.cs
- PostBackOptions.cs
- SrgsItemList.cs
- BaseParagraph.cs
- FileDetails.cs
- XPathNodeInfoAtom.cs
- AssociatedControlConverter.cs
- AttachInfo.cs
- MultipartContentParser.cs
- OracleInternalConnection.cs
- TabItemWrapperAutomationPeer.cs
- precedingquery.cs
- XmlQueryOutput.cs
- Storyboard.cs
- TextMetrics.cs
- StorageRoot.cs
- ToolStripContentPanel.cs
- EntityDataSourceSelectingEventArgs.cs
- SafeBitVector32.cs
- ExpandoObject.cs
- ExecutionContext.cs
- SafeRegistryHandle.cs
- FormViewPagerRow.cs
- XmlSerializerVersionAttribute.cs
- ContainerParagraph.cs
- SequentialWorkflowHeaderFooter.cs
- RegexMatchCollection.cs
- AttributeCallbackBuilder.cs
- DatatypeImplementation.cs
- LicenseException.cs
- SessionIDManager.cs
- DataGridViewRowStateChangedEventArgs.cs
- XmlNodeChangedEventArgs.cs
- LockCookie.cs
- ProtocolsConfiguration.cs
- WindowsGraphicsCacheManager.cs