- dotnet-framework-api
-
dotnet-api
-
C1.Win.Input.8 Assembly
- C1.Framework
- C1.Framework.Drawing.Gdi
- C1.Framework.Drawing.Gdi.DeviceContexts
- C1.Framework.Forms
- C1.Framework.Mathematics
- C1.Framework.Text.Lexicons
- C1.Win.Input
- C1.Win.Input.Base
- C1.Win.Input.Base.Editors
- C1.Win.Input.Base.Views
- C1.Win.Input.Formating
- C1.Win.Input.GrapeCity.Editors
- C1.Win.Input.GrapeCity.Editors.Fields
- C1.Win.Input.GrapeCity.Framework.Input
- C1.Win.Input.Localization
- C1.Win.Input.Styles
- C1.Win.Input.Utils
- C1.Win.Input.Validation
- C1.Win.Input.MultiSelect.8 Assembly
-
C1.Win.Input.8 Assembly
C1.Win.Input.Base.C1TextBoxBase
C1TextBoxBase Class
Implements the basic functionality of the textbox control.
Namespace: C1.Win.Input.Base
Assembly: C1.Win.Input.8.dll
Syntax
public abstract class C1TextBoxBase : C1InputHost, ISupportInitialize, ITextBoxBaseConstructors
| Name | Description |
|---|---|
| C1TextBoxBase(BaseThemeProvider) | Initializes a new instance of the C1TextBoxBase class. |
Properties
| Name | Description |
|---|---|
| AcceptsEscape | Gets or sets a value 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). |
| AcceptsReturn | Gets or sets a value indicating whether pressing ENTER in a multiline C1TextBox control creates a new line of text in the control or activates the default button for the form. |
| AcceptsTab | Gets or sets a value indicating whether pressing the TAB key in a multiline text box control types a TAB character in the control instead of moving the focus to the next control in the tab order. |
| AutoCompleteCustomSource | Gets or sets a custom StringCollection to use when the AutoCompleteSource property is set to CustomSource. |
| AutoCompleteMode | Gets or sets an option that controls how automatic completion works for the C1TextBox. |
| AutoCompleteSource | Gets or sets a value specifying the source of complete strings used for automatic completion. |
| AutoSize | |
| BackColor | |
| BorderStyle | Gets or sets the border type of the text box control. |
| ButtonsSettings | Gets the properties of buttons. |
| CanUndo | Gets a value indicating whether the user can undo the previous operation in a text box control. |
| CaseSensitive | Gets or sets a value indicating whether string comparisons are case-sensitive. |
| CharCategories | Gets or sets the rules to filter keyboard input. |
| CharacterCasing | Gets or sets whether the C1TextBox control modifies the case of characters as they are typed. |
| CultureInfo | Gets or sets the current CultureInfo object. |
| CustomFormat | Gets or sets custom format specified used if FormatType property is CustomFormat. |
| DataMember | Gets or sets the member of the data source object to which the control is bound. |
| DataSource | Gets or sets the data source object to which the control is bound. |
| DataType | Gets or sets the type of the Value property. |
| DefaultIconSize | Gets or sets the default icon size of control. |
| 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. |
| DisplayFormat | Gets the format used to display the value when the control is in display mode. |
| EditFormat | Gets the format used to display the value when the control is in edit mode (has input focus and is not read-only). |
| EmptyAsNull | Gets or sets a value indicating whether empty strings are interpreted as null values (DBNull). |
| ErrorInfo | Gets a settings affecting error handling in the control. |
| 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. |
| ExtraIcons | Gets a collection with additional input editor icons. |
| FloatingPlaceholderEnabled | Gets or sets the value indicating whether the floating placeholder is enabled. |
| ForeColor | |
| FormatType | Gets or sets enumeration value determining the formatting method, including standard .NET format specifies, custom and programmatic formatting. |
| HideSelection | Gets or sets a value indicating whether the selected text in the text box control remains highlighted when the control loses focus. |
| Icon | Gets or sets the C1.Framework.C1Icon that is displayed on a C1TextBox control. |
| Image | Gets or sets the image that is displayed on a C1TextBox control. |
| ImageAlign | Gets or sets the alignment of the image. |
| ImageIndex | Gets or sets the image list index value of the image displayed on the C1TextBox control. |
| ImageKey | Gets or sets the key accessor for the image in the ImageList. |
| ImageList | Gets or sets the ImageList that contains the Image displayed on a C1TextBox control. |
| InitialSelection | Gets or sets a value determines the selection position when a control receives input focus. |
| Lines | Gets or sets the lines of text in a text box control. |
| MarkEmpty | Gets or sets a value that indicates need draws a red dotted line if Value is empty or not. |
| 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. |
| Modified | Gets or sets a value that indicates that the text box control has been modified by the user since the control was created or its contents were last set. |
| Multiline | Gets or sets a value indicating whether this is a multiline C1TextBox control. |
| NullText | Gets or sets string representing a DBNull value. |
| ParseInfo | Gets a settings affecting parsing, that is, converting the string entered by the user to the data type. |
| PasswordChar | Gets or sets the character used to mask characters of a password in a single-line C1TextBox control. |
| Placeholder | Gets or sets the textual place holder, that is displayed by C1TextBox to prompt the user for information. |
| PostValidation | Gets a validation rules applied after parsing, that is, after converting the string entered by the user to the DataType (typed validation). |
| PreValidation | Gets the validation rules applied before parsing, that is, before converting the string entered by the user to the DataType (raw string validation). |
| PreferredHeight | Gets the preferred height for a text box. |
| ReadOnly | Gets or sets a value indicating whether text in the text box is read-only. |
| ScrollBars | Gets or sets which scroll bars should appear in a C1TextBox control. |
| SelectedText | Gets or sets a value indicating the currently selected text in the control. |
| SelectionLength | Gets or sets the number of characters selected in the text box. |
| SelectionStart | Gets or sets the starting point of text selected in the text box. |
| ShortcutsEnabled | Gets or sets a value indicating whether the defined shortcuts are enabled. |
| Text | Gets or sets the text associated with this control. |
| TextAlign | Gets or sets how text is aligned in a C1TextBox control. |
| TextLength | Gets the length of text in the control. |
| TrimEnd | Gets or sets a value indicating whether trailing spaces are removed. |
| TrimStart | Gets or sets a value indicating whether leading spaces are removed. |
| UseSystemPasswordChar | Gets or sets a value indicating whether the text in the C1TextBox control should appear as the default password character. |
| Value | Gets or sets the current DataType representation of the visual information contained in the control. |
| VerticalAlign | Gets or sets the vertical alignment of the content in the control. |
| WordWrap | Gets or sets a value indicating whether a multiline text box control automatically wraps words to the beginning of the next line when necessary. |
Methods
| Name | Description |
|---|---|
| AppendText(string) | Appends text to the current text of a text box. |
| ApplyStyle() | Applies the style to control view. |
| BeginInit() | Signals the object that initialization is starting. |
| CheckValidationResult(ErrorReason, ref object, ErrorInfo) | Checks the result of the ParseContent method. |
| Clear() | Clears all text from the text box control. |
| ClearUndo() | Clears information about the most recent operation from the undo buffer of the text box. |
| Copy() | Copies the current selection in the text box to the Clipboard. |
| CreateUiaItem(UiaItem) | |
| Cut() | Moves the current selection in the text box to the Clipboard. |
| DeselectAll() | Specifies that the value of the SelectionLength property is zero so that no characters are selected in the control. |
| Dispose(bool) | Releases the unmanaged resources used by the C1TextBox control. |
| DisposeHostedControl() | Releases the HostedControl and unsubscribe from event handlers. |
| EndInit() | Signals the object that initialization is complete. |
| GetCharFromPosition(Point) | Retrieves the character that is closest to the specified location within the control. |
| GetCharIndexFromPosition(Point) | Retrieves the index of the character nearest to the specified location. |
| GetFirstCharIndexFromLine(int) | Retrieves the index of the first character of a given line. |
| GetFirstCharIndexOfCurrentLine() | Retrieves the index of the first character of the current line. |
| GetLineFromCharIndex(int) | Retrieves the line number from the specified character position within the text of the control. |
| GetPositionFromCharIndex(int) | Retrieves the location within the control at the specified character index. |
| InternalWndProc(ref Message) | The edits window procedure of internal text editor. Inheriting classes can override this to add extra functionality. |
| OnAcceptsTabChanged(EventArgs) | Raises the AcceptsTabChanged event. |
| OnCustomButtonClick(EventArgs) | Raises the CustomButtonClick event. |
| OnDataTypeChanged(EventArgs) | Raises the DataTypeChanged event. |
| OnDropDownButtonClick(EventArgs) | Raises the DropDownButtonClick event. |
| OnFormatError(FormatErrorEventArgs) | Raises the FormatError event. |
| OnFormatting(FormatEventArgs) | Raises the Formatting event. |
| OnHideSelectionChanged(EventArgs) | Raises the HideSelectionChanged event. |
| OnModalButtonClick(EventArgs) | Raises the ModalButtonClick event. |
| OnModifiedChanged(EventArgs) | Raises the ModifiedChanged event. |
| OnMultilineChanged(EventArgs) | Raises the MultilineChanged event. |
| OnParsed(ParseEventArgs) | Raises the Parsed event. |
| OnParsing(ParseEventArgs) | Raises the Parsing event. |
| OnPostValidated(PostValidationEventArgs) | Raises the PostValidated event. |
| OnPostValidating(PostValidationEventArgs) | Raises the PostValidating event. |
| OnPreValidated(PreValidationEventArgs) | Raises the PreValidated event. |
| OnPreValidating(PreValidationEventArgs) | Raises the PreValidating event. |
| OnReadOnlyChanged(EventArgs) | Raises the ReadOnlyChanged event. |
| OnTabIndexChanged(EventArgs) | |
| OnTextAlignChanged(EventArgs) | Raises the TextAlignChanged event. |
| OnUpDownButtonClick(UpDownButtonClickEventArgs) | Raises the UpDownButtonClick event. |
| OnValidationError(ValidationErrorEventArgs) | Raises the ValidationError event. |
| OnValueChanged(EventArgs) | Raises the ValueChanged event. |
| OnVerticalAlignChanged(EventArgs) | Raises the VerticalAlignChanged event. |
| OnVisibleChanged(EventArgs) | |
| ParseContent(out object, ErrorInfo) | Parses the Text string. |
| Paste() | Replaces the current selection in the text box with the contents of the Clipboard. |
| Paste(string) | Sets the selected text to the specified text without clearing the undo buffer. |
| ResetAutoCompleteCustomSource() | Restores the default value of the AutoCompleteCustomSource property. |
| ResetButtonsSettings() | Restores the default value of the ButtonsSettings property. |
| ResetDisplayFormat() | Restores the default value of the DisplayFormat property. |
| ResetEditFormat() | Restores the default value of the EditFormat property. |
| ResetErrorInfo() | Restores the default value of the ErrorInfo property. |
| ResetInitialSelection() | Restores the default value of the InitialSelection property. |
| ResetParseInfo() | Restores the default value of the ParseInfo property. |
| ResetPostValidation() | Restores the default value of the PostValidation property. |
| ResetPreValidation() | Restores the default value of the PreValidation property. |
| ResetValue() | Restores the default value of the Value property. |
| ScrollToCaret() | Scrolls the contents of the control to the current caret position. |
| Select(int, int) | Selects a range of text in the text box. |
| SelectAll() | Selects all text in the text box. |
| SetHostedControl(Control) | Sets the HostedControl and subscribe to event handlers. |
| ShouldSerializeAutoCompleteCustomSource() | Specifies whether to save the value of the AutoCompleteCustomSource property. |
| ShouldSerializeButtonsSettings() | Specifies whether to save the value of the ButtonsSettings property. |
| ShouldSerializeDisplayFormat() | Specifies whether to save the value of the DisplayFormat property. |
| ShouldSerializeEditFormat() | Specifies whether to save the value of the EditFormat property. |
| ShouldSerializeErrorInfo() | Specifies whether to save the value of the ErrorInfo property. |
| ShouldSerializeInitialSelection() | Specifies whether to save the value of the InitialSelection property. |
| ShouldSerializeParseInfo() | Specifies whether to save the value of the ParseInfo property. |
| ShouldSerializePostValidation() | Specifies whether to save the value of the PostValidation property. |
| ShouldSerializePreValidation() | Specifies whether to save the value of the PreValidation property. |
| ShouldSerializeValue() | Specifies whether to save the value of the Value property. |
| Undo() | Undoes the last edit operation in the text box. |
| 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. |
Events
| Name | Description |
|---|---|
| AcceptsTabChanged | Occurs when the value of the AcceptsTab property has changed. |
| CustomButtonClick | Occurs when Custom button is clicked. |
| DataTypeChanged | Occurs when the DataType property changes. |
| DropDownButtonClick | Occurs when DropDown button is clicked. |
| FormatError | Occurs when the control receives data that cannot be formatted according to the current format and edit mask settings. |
| Formatting | Formatting the value programmatically. |
| HideSelectionChanged | Occurs when the value of the HideSelection property has changed. |
| ModalButtonClick | Occurs when Modal button is clicked. |
| ModifiedChanged | Occurs when the value of the Modified property has changed. |
| MultilineChanged | Occurs when the value of the Multiline property has changed. |
| Parsed | Occurs after the input string value has been converted to the DataType. |
| Parsing | Occurs when the input string is parsed programmatically. |
| PostValidated | Occurs after the typed value has been validated |
| PostValidating | Occurs when programmatic typed value validating. |
| PreValidated | Occurs after the input string value has been validated. |
| PreValidating | Occurs when programmatic input string validating. |
| ReadOnlyChanged | Occurs when the value of the ReadOnly property has changed. |
| TextAlignChanged | Occurs when the value of the TextAlign property has changed. |
| UpDownButtonClick | Occurs when Up or Down buttons are clicked. |
| ValidationError | Occurs when parsing or validating the input string fails. |
| ValueChanged | Occurs when the Value property changes. |
| VerticalAlignChanged | Occurs when the value of the VerticalAlign property changes. |