C1TextBox Class

The main data bound control used for entering and editing information in a text form. Supports data formatting for all data types, including special features for date-time formats. Also supports edit mask, data validation and other features.

Inheritance

object

MarshalByRefObject

C1TextBox

Implements

ICustomTypeDescriptor

IEmbeddedEditor

Namespace: C1.Win.C1Input

Assembly: C1.Win.C1Input.4.8.dll

Syntax

[ToolboxBitmap(typeof(C1TextBox), "C1TextBox.png")]
[DefaultBindingProperty("Value")]
public class C1TextBox : TextBox, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, ISupportInitialize, ICustomTypeDescriptor, IEmbeddedEditor

<ToolboxBitmap(GetType(C1TextBox), "C1TextBox.png")>
<DefaultBindingProperty("Value")>
Public Class C1TextBox
    Inherits TextBox
    Implements IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, ISupportInitialize, ICustomTypeDescriptor, IEmbeddedEditor

Constructors

Name	Description
C1TextBox()	Initializes a new instance of the C1TextBox class.

Fields

Name	Description
m_c1embedEndOnSideArrows	This member is for internal use only.
m_c1embedded	This member is for internal use only.

Properties

Name	Description
AcceptsEscape	Indicates if the Escape key that cancels modified value is handled by the control without passing it to the owner form (AcceptsEscape=True), or it is then passed to the form and can close it if the form has CancelButton (AcceptsEscape=False).
AcceptsTab	Indicates if Tab and Shift+Tab keys are accepted by control and move the focus to the next (previous) group of input characters in edit mask and in DateTimeInput mode.
AutoChangePosition	Gets or sets a value indicating whether the position of the character is automatically changed
AutoSize	Gets or sets a value indicating whether the height of the control automatically adjusts when the font assigned to the control is changed.
BackColor
BaseText	This method is for internal use only.
BorderColor	Gets or sets the border color of the control.
BorderStyle
CalendarType	Calendar, used to format date.
CaseSensitive	True if string comparisons are case-sensitive; otherwise, False. Default: False
CausesValidation	Gets or sets a value indicating whether the control causes validation (i.e. calls Validated and Validating events)
CharCategory	Defines rules to filter keyboard input.
ContentHeight
Culture	The culture ID.
CultureInfo	The current CultureInfo object (available at runtime).
CultureName	The name selected for the Culture property in the Properties grid
CurrentTimeZone	If True, the control's stored Value is in current time zone; otherwise, the Value is adjusted to the time zone defined by the GMTOffset property
CustomFormat	Custom format specifier used if FormatType = FormatTypeEnum.CustomFormat.
DataField	The field of the data source object to which the control is bound.
DataSource	The data source object to which the control is bound.
DataType	Type of the Value property.
DateTimeInput	Whether or not a special edit mode is applied to DateTime values.
DaylightTimeAdjustment	The value specified in the GMTOffset property can be advanced or set back due to daylight-saving time changes. Default: NoAdjustments.
DefaultSize
DefaultThemeRootPath	Default path for the control in xml theme file.
DisableOnNoData	Gets or sets whether the text box should be disabled when it is bound to an empty data source, i.e. CurrencyManager.Count = 0.
DisabledForeColor	Gets or sets the foreground color of the disabled control.
DisplayFormat	Format used to display the value when the control is not in edit mode (does not have input focus or is read-only).
EditFormat	Format used to display the value when the control is in edit mode (has input focus and is not read-only).
EditMask	The edit mask string restricting user input.
EditMode	Returns True, if the control has input focus and TextDetached = False.
EmptyAsNull	If True, empty strings are interpreted as null values (DBNull).
Enabled	Gets or sets a value indicating whether the control can respond to user interaction.
ErrorInfo	Settings affecting error handling in the control.
ExitOnLastChar	Gets or sets whether the next control in the tab order receives the focus as soon as the control is filled at the last character.
ExitOnLeftRightKey	Gets or sets whether the focus automatically moves to the previous or next control in the tab order when pressing the left or right arrow keys.
FlatSystemBorder	Makes Fixed3D borders old-style looking (flat) for System VisualStyle. This property is only for compatibility with legacy applications only.
FloatingPlaceHolderEnabled	Gets or sets the value indicating whether the floating placeholder is enabled.
ForeColor
FormatType	Enumeration value determining the formatting method, including standard .NET format specifiers, custom and programmatic formatting.
GMTOffset	The time zone of the Value property used if CurrentTimeZone = False.
ImeCharComposition
InitialSelection	Determines the selection position when a control receives input focus. Default: InitialSelectionEnum.SelectAll.
Initialization	Gets a value indicating that the BeginInit() method was called and the EndInit() method was not called.
Label	Label control associated with this input field.
Lines	The lines of text in a multiline control.
LoopPosition	Gets or sets a value indicating whether the position of the caret is automatically moved to the first field when the last field is filled.
Margins	Gets or sets the spacing between the input control content and its edges, in pixels. Default: all margins are set to 0.
MarkEmpty	Draws a red dotted line if Value is empty.
MaskInfo	Edit mask settings.
MaxLength	Gets or sets the maximum number of characters the user can type or paste into the text box control.
MaxLengthUnit	Gets or sets whether the maximum number of characters that fit in the control are handled based on bytes, characters, or text elements.
MaxLineCount	Gets or sets the maximum number of lines.
MinShortYear	The minimum year that can be entered without leading zeros.
Modified	Gets or sets a value that indicates that the control has been modified by the user since the control received the input focus or its Value last set.
Multiline
NegativeForeColor	Gets or sets the foreground color of the control which contains negative value.
NullText	String representing a DBNull value.
NumericInput	Sets or gets a value indicating whether a special edit mode is used for numeric values.
NumericInputKeys	Enables/disables the special keys used when NumericInput = True. Default: NumericInputKeyFlags.Standard.
Padding
ParseInfo	Settings affecting parsing, that is, converting the string entered by the user to the data type.
Placeholder	Gets or sets the textual place holder, that is displayed by C1TextBox to prompt the user for information.
PostValidation	Validation rules applied after parsing, that is, after converting the string entered by the user to the DataType (typed validation).
PreValidation	Validation rules applied before parsing, that is, before converting the string entered by the user to the DataType (raw string validation).
PreferredHeight
SelectedText
ShowContextMenu	Specifies whether the context menu can be displayed for the control.
ShowFocusRectangle	Specifies whether a focus rectangle should be displayed around the client area when the control has the input focus.
Tag	Gets or sets the object that contains data about the control
Text
TextDetached	Specifies whether the Value and Text properties can be set independently.
TextLength	Gets the length of text in the control.
TrimEnd	If True, trailing spaces are removed.
TrimStart	If True, leading spaces are removed.
UseColumnStyles	Indicates whether to honor the ColumnStyle properties defined on the C1ViewColumn object that this control is bound to.
UserCultureOverride	If True, current user regional settings override the selected culture.
Value	Gets or sets the current DataType representation of the visual information contained in the control.
ValueChangedBehavior	Allows backward compatibility with the old behavior, when the ValueChanged event previously fired on any text change.
ValueIsDbNull	Gets or sets a value indicating whether the Value is DBNull.
VerticalAlign	Gets or sets the vertical alignment of the content in the control. The default is VerticalAlignEnum.Top.
VisualStyle	Gets or sets the visual style of the control.
WrapDateTimeFields	If this property is False the month will be automatically incremented when the user spins the date past the end of the month. The same about other parts of the date/time value.

Methods

Name	Description
BeginInit()
CalcSizeInternal()	This method is for internal use only.
ChangeType(object)
ChangeType(object, Type)
CheckValidationResult(ErrorReasonEnum, ref object, ErrorInfo)	Checks the result of the ParseContent method.
CreateHandle()
DecDateTimeInput()	Decrements the currently selected field in DateTimeInput mode.
Dispose(bool)	Releases the resources used by the C1TextBox.
DrawBorder(Graphics, bool)	This method is for internal use only.
DrawBorder(Graphics, IntPtr, bool)	This method is for internal use only.
DrawFocusRectangle()	This method is for internal use only.
EndInit()
GetDisabledBackColor()	Gets the disabled back color.
GoToField(DateTimeField, bool)	Moves the selection to the specified date-time field. Works only if the DataType property is set to DateTime and the date-time input is active.
IncDateTimeInput()	Increments the currently selected field in DateTimeInput mode.
IsInputKey(Keys)
OnBackColorChanged(EventArgs)
OnBindingFormatting(ConvertEventArgs)	This method is for internal use only.
OnBindingParsing(ConvertEventArgs)	This method is for internal use only.
OnBorderColorChanged(EventArgs)	Raises the BorderColorChanged event.
OnCreateControl()
OnCultureInfoSetup(CultureInfoSetupEventArgs)	This method is for internal use only.
OnDataTypeChanged(EventArgs)	This method is for internal use only.
OnEnabledChanged(EventArgs)
OnEnter(EventArgs)
OnFontChanged(EventArgs)
OnForeColorChanged(EventArgs)
OnFormatError(FormatErrorEventArgs)	This method is for internal use only.
OnFormatted(FormatEventArgs)	This method is for internal use only.
OnFormatting(FormatEventArgs)	This method is for internal use only.
OnGotFocus(EventArgs)
OnHandleCreated(EventArgs)
OnKeyDown(KeyEventArgs)
OnKeyPress(KeyPressEventArgs)
OnKeyUp(KeyEventArgs)
OnLeave(EventArgs)
OnLocationChanged(EventArgs)
OnLostFocus(EventArgs)
OnMarginsChanged(EventArgs)	This method is for internal use only.
OnModifiedChanged(EventArgs)	Raises the ModifiedChanged event.
OnMouseDown(MouseEventArgs)
OnMouseEnter(EventArgs)
OnMouseLeave(EventArgs)
OnMouseUp(MouseEventArgs)
OnMouseWheel(MouseEventArgs)
OnMultilineChanged(EventArgs)
OnPaddingChanged(EventArgs)
OnPaint(PaintEventArgs)
OnParentBackColorChanged(EventArgs)
OnParentChanged(EventArgs)	This method is for internal use only.
OnParsed(ParseEventArgs)	This method is for internal use only.
OnParsing(ParseEventArgs)	This method is for internal use only.
OnPostValidated(PostValidationEventArgs)	This method is for internal use only.
OnPostValidating(PostValidationEventArgs)	This method is for internal use only.
OnPreValidated(PreValidationEventArgs)	This method is for internal use only.
OnPreValidating(PreValidationEventArgs)	This method is for internal use only.
OnReadOnlyChanged(EventArgs)
OnRegionChanged(EventArgs)
OnResize(EventArgs)
OnSizeChanged(EventArgs)
OnTabIndexChanged(EventArgs)
OnTextChanged(EventArgs)
OnTextDetachedChanged()
OnValidated(EventArgs)
OnValidating(CancelEventArgs)
OnValidationError(ValidationErrorEventArgs)	This method is for internal use only.
OnValueChanged(EventArgs)	This method is for internal use only.
OnVerticalAlignChanged(EventArgs)	This method is for internal use only.
OnVisibleChanged(EventArgs)
OnVisualStyleChanged(EventArgs)	Invokes the VisualStyleChanged event.
ParseContent(out object, ErrorInfo)	Parses the Text string.
PreProcessMessage(ref Message)
ProcessKeyDown(KeyEventArgs)
ProcessKeyPress(KeyPressEventArgs)
ProcessKeyUp(KeyEventArgs)
ResetBackColor()
ResetForeColor()
ResetText()	Updates the control's Text with the current Value.
ResetVisualStyle()	Resets VisualStyle to the default value.
SafeRecreateHandle()	This method is for internal use only.
SetBoundsCore(int, int, int, int, BoundsSpecified)
SetCultureInfo(CultureInfo)	Sets culture.
SetCutureInfo(CultureInfo)	Sets culture.
SetProposedValue(object)	This method works exactly as setting the Value property, except that it does not change the internal variable storing the value before editing, so the user can press Esc and restore the previous value. This method works only in edit mode. If the control is not in edit mode, this methods does nothing.
ShouldDrawPlaceholder()	Indicates whether the placeholder should be drawn.
ShouldHandleEscape()
ShouldSerializeVisualStyle()	Tests whether VisualStyle should be serialized.
SuspendNumericInput(bool, bool)	This method temporarily disables numeric input mode
UpdateDataType(Type)	This method is for internal use only.
UpdateNC()	This method is for internal use only.
UpdateSelection()	Updates selection of the text according to the InitialSelection property.
UpdateValueWithCurrentText()	Triggers parsing of the Text property and updating the Value.
ValidateText()	Validates current Text property in the same manner as it usually validated after the control loses focus.
WmNCPaintSingleline(ref Message)	This method is for internal use only.
WndProc(ref Message)

Events

Name	Description
BindingFormatting	Occurs when Value is retrieved from the data source.
BindingParsing	Occurs when Value is stored in the data source.
BorderColorChanged	Occurs when the BorderColor property has changed.
CultureInfoSetup	CultureInfo can be set up (on startup) or has been changed.
DataTypeChanged	Occurs when the DataType property changes.
FormatError	Occurs when the control receives data that cannot be formatted according to the current format and edit mask settings.
Formatted	Occurs after the value has been formatted.
Formatting	Formatting the value programmatically.
InvalidInput	Occurs when invalid character is in input.
MarginsChanged	Occurs when the Margins property or one of the margins has changed.
Parsed	Occurs after the input string value has been converted to the DataType.
Parsing	Programmatic parsing of the input string.
PostValidated	Occurs after the typed value has been validated
PostValidating	Programmatic typed value validation.
PreValidated	Occurs after the input string value has been validated.
PreValidating	Programmatic input string validation.
ValidationError	Error occurred while parsing or validating the input string.
ValueChanged	Occurs when the Value changes.
VerticalAlignChanged	Occurs when the value of the VerticalAlign property has changed.
VisualStyleChanged	Occurs when the VisualStyle property has changed.