TextEditBase Members
The base class for text editors.Constructors
| Name | Description |
|---|---|
| TextEditBase() | Initializes a new instance of the TextEditBase class. |
Fields
| Name | Description |
|---|---|
| AllowAnimationProperty static | Identifies the AllowAnimation bindable property. Inherited from EditBase. |
| BorderColorProperty static | Identifies the BorderColor bindable property. Inherited from EditBase. |
| BorderThicknessProperty static | Identifies the BorderThickness bindable property. Inherited from EditBase. |
| BottomTextFontAttributesProperty static | Identifies the BottomTextFontAttributes bindable property. Inherited from EditBase. |
| BottomTextFontFamilyProperty static | Identifies the BottomTextFontFamily bindable property. Inherited from EditBase. |
| BottomTextFontSizeProperty static | Identifies the BottomTextFontSize bindable property. Inherited from EditBase. |
| BottomTextTopIndentProperty static | Identifies the BottomTextTopIndent bindable property. Inherited from EditBase. |
| BoxHeightProperty static | Identifies the BoxHeight dependency property. Inherited from EditBase. |
| BoxMarginProperty static | Identifies the BoxMargin dependency property. Inherited from EditBase. |
| BoxMinHeightProperty static | Identifies the BoxMinHeight dependency property. Inherited from EditBase. |
| BoxMinWidthProperty static | Identifies the BoxMinWidth dependency property. Inherited from EditBase. |
| BoxModeProperty static | Identifies the BoxMode bindable property. Inherited from EditBase. |
| BoxPaddingProperty static | Identifies the BoxPadding bindable property. Inherited from EditBase. |
| CharacterCasingProperty static | Identifies the CharacterCasing dependency property. Inherited from EditBase. |
| CharacterCounterIndentProperty static | Identifies the CharacterCounterIndent bindable property. |
| ClearIconColorProperty static | Identifies the ClearIconColor dependency property. Inherited from EditBase. |
| ClearIconCommandParameterProperty static | Identifies the ClearIconCommandParameter dependency property. Inherited from EditBase. |
| ClearIconCommandProperty static | Identifies the ClearIconCommand dependency property. Inherited from EditBase. |
| ClearIconProperty static | Identifies the ClearIcon dependency property. Inherited from EditBase. |
| ClearIconVisibilityProperty static | Identifies the ClearIconVisibility dependency property. Inherited from EditBase. |
| CornerModeProperty static | Identifies the CornerMode bindable property. Inherited from EditBase. |
| CornerRadiusProperty static | Identifies the CornerRadius dependency property. Inherited from EditBase. |
| CursorColorProperty static | Identifies the CursorColor dependency property. Inherited from EditBase. |
| CursorPositionProperty static | Identifies the CursorPosition bindable property. |
| DisabledBackgroundColorProperty static | Identifies the DisabledBackgroundColor dependency property. Inherited from EditBase. |
| DisabledBorderColorProperty static | Identifies the DisabledBorderColor bindable property. Inherited from EditBase. |
| DisabledBorderThicknessProperty static | Identifies the DisabledBorderThickness bindable property. Inherited from EditBase. |
| DisabledHelpTextColorProperty static | Identifies the DisabledHelpTextColor bindable property. Inherited from EditBase. |
| DisabledIconColorProperty static | Identifies the DisabledIconColor bindable property. Inherited from EditBase. |
| DisabledLabelColorProperty static | Identifies the DisabledLabelColor bindable property. Inherited from EditBase. |
| DisabledTextColorProperty static | Identifies the DisabledTextColor bindable property. Inherited from EditBase. |
| DisplayTextProperty static | Identifies the DisplayText dependency property. Inherited from EditBase. |
| EndIconColorProperty static | Identifies the EndIconColor dependency property. Inherited from EditBase. |
| EndIconCommandParameterProperty static | Identifies the EndIconCommandParameter bindable property. Inherited from EditBase. |
| EndIconCommandProperty static | Identifies the EndIconCommand bindable property. Inherited from EditBase. |
| EndIconProperty static | Identifies the EndIcon bindable property. Inherited from EditBase. |
| ErrorColorProperty static | Identifies the ErrorColor bindable property. Inherited from EditBase. |
| ErrorIconColorProperty static | Identifies the ErrorIconColor dependency property. Inherited from EditBase. |
| ErrorIconCommandParameterProperty static | Identifies the ErrorIconCommandParameter bindable property. Inherited from EditBase. |
| ErrorIconCommandProperty static | Identifies the ErrorIconCommand bindable property. Inherited from EditBase. |
| ErrorIconProperty static | Identifies the ErrorIcon bindable property. Inherited from EditBase. |
| ErrorTextProperty static | Identifies the ErrorText bindable property. Inherited from EditBase. |
| FocusedBorderColorProperty static | Identifies the FocusedBorderColor bindable property. Inherited from EditBase. |
| FocusedBorderThicknessProperty static | Identifies the FocusedBorderThickness bindable property. Inherited from EditBase. |
| FocusedLabelColorProperty static | Identifies the FocusedLabelColor bindable property. Inherited from EditBase. |
| HasErrorProperty static | Identifies the HasError bindable property. Inherited from EditBase. |
| HelpTextColorProperty static | Identifies the HelpTextColor bindable property. Inherited from EditBase. |
| HelpTextProperty static | Identifies the HelpText bindable property. Inherited from EditBase. |
| IconColorProperty static | Identifies the IconColor bindable property. Inherited from EditBase. |
| IconIndentProperty static | Identifies the IconIndent bindable property. Inherited from EditBase. |
| IconSpacingProperty static | Identifies the IconSpacing bindable property. Inherited from EditBase. |
| IconVerticalAlignmentProperty static | Identifies the IconVerticalAlignment bindable property. Inherited from EditBase. |
| IsEndIconVisibleProperty static | Identifies the IsEndIconVisible bindable property. Inherited from EditBase. |
| IsErrorIconVisibleProperty static | Identifies the IsErrorIconVisible bindable property. Inherited from EditBase. |
| IsLabelFloatingProperty static | Identifies the IsLabelFloating bindable property. Inherited from EditBase. |
| IsReadOnlyProperty static | Identifies the IsReadOnly dependency property. Inherited from EditBase. |
| IsStartIconVisibleProperty static | Identifies the IsStartIconVisible bindable property. Inherited from EditBase. |
| KeyboardProperty static | Identifies the Keyboard dependency property. |
| LabelColorProperty static | Identifies the LabelColor bindable property. Inherited from EditBase. |
| LabelFontSizeProperty static | Identifies the LabelFontSize bindable property. Inherited from EditBase. |
| LabelTextProperty static | Identifies the LabelText bindable property. Inherited from EditBase. |
| MaxCharacterCountOverflowModeProperty static | Identifies the MaxCharacterCountOverflowMode dependency property. |
| MaxCharacterCountProperty static | Identifies the MaxCharacterCount bindable property. |
| PlaceholderColorProperty static | Identifies the PlaceholderColor bindable property. Inherited from EditBase. |
| PlaceholderTextProperty static | Identifies the PlaceholderText dependency property. Inherited from EditBase. |
| ReserveBottomTextLineProperty static | Identifies the ReserveBottomTextLine bindable property. Inherited from EditBase. |
| ReturnCommandParameterProperty static | Identifies the ReturnCommandParameter dependency property. Inherited from EditBase. |
| ReturnCommandProperty static | Identifies the ReturnCommand dependency property. Inherited from EditBase. |
| ReturnTypeProperty static | Identifies the ReturnType dependency property. Inherited from EditBase. |
| SelectionLengthProperty static | Identifies the SelectionLength bindable property. |
| SelectionStartProperty static | Identifies the SelectionStart dependency property. |
| StartIconColorProperty static | Identifies the StartIconColor dependency property. Inherited from EditBase. |
| StartIconCommandParameterProperty static | Identifies the StartIconCommandParameter bindable property. Inherited from EditBase. |
| StartIconCommandProperty static | Identifies the StartIconCommand bindable property. Inherited from EditBase. |
| StartIconProperty static | Identifies the StartIcon bindable property. Inherited from EditBase. |
| TextChangedCommandParameterProperty static | Identifies the TextChangedCommandParameter dependency property. |
| TextChangedCommandProperty static | Identifies the TextChangedCommand dependency property. |
| TextColorProperty static | Identifies the TextColor bindable property. Inherited from EditBase. |
| TextFontAttributesProperty static | Identifies the TextFontAttributes bindable property. Inherited from EditBase. |
| TextFontFamilyProperty static | Identifies the TextFontFamily bindable property. Inherited from EditBase. |
| TextFontSizeProperty static | Identifies the TextFontSize bindable property. Inherited from EditBase. |
| TextHorizontalAlignmentProperty static | Identifies the TextHorizontalAlignment bindable property. Inherited from EditBase. |
| TextProperty static | Identifies the Text bindable property. |
Properties
| Name | Description |
|---|---|
| AllowAnimation | Specifies whether the editor’s floating label moves with a smooth animation effect. Inherited from EditBase. |
| BorderColor | Gets or sets the color of the editor box borders. Inherited from EditBase. |
| BorderThickness | Gets or sets the thickness of the editor box borders. Inherited from EditBase. |
| BottomTextFontAttributes | Gets or sets whether the editor’s help and error text is bold or italic. Inherited from EditBase. |
| BottomTextFontFamily | Gets or sets the font family name for the editor’s help and error text. Inherited from EditBase. |
| BottomTextFontSize | Gets or sets the font size of the editor’s help and error text. Inherited from EditBase. |
| BottomTextTopIndent | Gets or sets the distance between the editor’s bottom border and help/error text. Inherited from EditBase. |
| BoxHeight | Gets or sets the edit box height. Inherited from EditBase. |
| BoxMargin | Gets the margin of the edit box inside the editor. Inherited from EditBase. |
| BoxMinHeight | Gets or sets the minimum edit box height. Inherited from EditBase. |
| BoxMinWidth | Gets or sets the minimum edit box width. Inherited from EditBase. |
| BoxMode | Gets or sets whether a stroke is displayed around the entire editor box or for the bottom edge only. Inherited from EditBase. |
| BoxPadding | Gets or sets the amount of space between borders of the edit box and its content. Inherited from EditBase. |
| CharacterCasing | Gets or sets whether to automatically convert characters to lowercase or uppercase when a user enters text in the editor. Inherited from EditBase. |
| CharacterCounterIndent | Gets or sets the distance between the character counter and help/error text. |
| ClearIcon | Specifies the clear icon image. Inherited from EditBase. |
| ClearIconColor | Gets or sets the color of the clear icon. Inherited from EditBase. |
| ClearIconCommand | Specifies the command executed when a user taps the clear icon. Inherited from EditBase. |
| ClearIconCommandParameter | Specifies the parameter passed to the ClearIconCommand. Inherited from EditBase. |
| ClearIconVisibility | Specifies when the clear icon is displayed. Inherited from EditBase. |
| CornerMode | Gets or sets whether edit box corners are rounded or cut. Inherited from EditBase. |
| CornerRadius | Gets or sets the corner radius of the edit box. Inherited from EditBase. |
| CursorColor | Gets or sets the color of the input cursor. Inherited from EditBase. |
| CursorPosition | Gets or sets the cursor position. |
| DisabledBackgroundColor | Gets or sets the edit box background in disabled state. Inherited from EditBase. |
| DisabledBorderColor | Gets or sets the color of the editor box borders in a disabled state. Inherited from EditBase. |
| DisabledBorderThickness | Gets or sets the thickness of the editor box borders in a disabled state. Inherited from EditBase. |
| DisabledHelpTextColor | Specifies the color of the help text shown below the disabled editor. Inherited from EditBase. |
| DisabledIconColor | Specifies the color for icons of the editor in a disabled state. Inherited from EditBase. |
| DisabledLabelColor | Gets or sets the text color for the label of the editor in a disabled state. Inherited from EditBase. |
| DisabledTextColor | Gets or sets the color of text entered into the editor in a disabled state. Inherited from EditBase. |
| DisplayText | Gets a string value that specifies the formatted text displayed in the editor. Inherited from EditBase. |
| EndIcon | Specifies the trailing icon image. Inherited from EditBase. |
| EndIconColor | Gets or sets the color of a custom icon displayed at the editor’s far edge. Inherited from EditBase. |
| EndIconCommand | Specifies the command executed when a user taps the trailing icon. Inherited from EditBase. |
| EndIconCommandParameter | Specifies the parameter passed to the EndIconCommand. Inherited from EditBase. |
| ErrorColor | Gets or sets the color of the edit box’s borders, label, error icon, and error message if there is an input error. Inherited from EditBase. |
| ErrorIcon | Specifies the error icon image. Inherited from EditBase. |
| ErrorIconColor | Gets or sets the color of an icon displayed when HasError is set to true. Inherited from EditBase. |
| ErrorIconCommand | Specifies the command executed when a user taps the error icon. Inherited from EditBase. |
| ErrorIconCommandParameter | Specifies the parameter passed to the ErrorIconCommand. Inherited from EditBase. |
| ErrorText | Specifies the text message that appears below the editor in an error state. Inherited from EditBase. |
| FocusedBorderColor | Gets or sets the color of the editor box borders in the focused state. Inherited from EditBase. |
| FocusedBorderThickness | Gets or sets the thickness of the editor box borders in a focused state. Inherited from EditBase. |
| FocusedLabelColor | Gets or sets the text color for the label of the editor in a focused state. Inherited from EditBase. |
| HasError | Allows you to switch the editor to an error state. Inherited from EditBase. |
| HelpText | Specifies the input prompt text displayed below the edit box. Inherited from EditBase. |
| HelpTextColor | Specifies the color of the help text shown below the edit box. Inherited from EditBase. |
| IconColor | Specifies the color for editor icons. Inherited from EditBase. |
| IconIndent | Gets or sets the distance between an icon and input text (affix). Inherited from EditBase. |
| IconSpacing | Gets or sets the distance between icons. Inherited from EditBase. |
| IconVerticalAlignment | Gets or sets the vertical alignment of icons. Inherited from EditBase. |
| IsEndIconVisible | Gets or sets whether the trailing icon is visible. Inherited from EditBase. |
| IsErrorIconVisible | Gets or sets whether the error icon is visible. Inherited from EditBase. |
| IsLabelFloating | Gets or sets whether the label changes its position depending on the editor state, or it is pinned to the top of the editor box. Inherited from EditBase. |
| IsReadOnly | Gets or sets whether users can change a value in the editor. Inherited from EditBase. |
| IsStartIconVisible | Gets or sets whether the leading icon is visible. Inherited from EditBase. |
| Keyboard | Specifies the type of keyboard used to input text. |
| LabelColor | Gets or sets the text color for the label of the editor in an unfocused state. Inherited from EditBase. |
| LabelFontSize | Gets or sets the font size of the editor’s label text. Inherited from EditBase. |
| LabelText | Gets or sets the editor’s label text. Inherited from EditBase. |
| MaxCharacterCount | |
| MaxCharacterCountOverflowMode | |
| PlaceholderColor | Specifies the placeholder color. Inherited from EditBase. |
| PlaceholderText | Specifies the placeholder text. Inherited from EditBase. |
| ReserveBottomTextLine | Allows you to reserve a line for the error text below the edit box. Inherited from EditBase. |
| ReturnCommand | Specifies the command that is executed when a user taps the ‘Return’ button. Inherited from EditBase. |
| ReturnCommandParameter | Specifies the parameter passed to the ReturnCommand. Inherited from EditBase. |
| ReturnType | Specifies the appearance of the ‘Return’ button on the operating system’s on-screen keyboard. Inherited from EditBase. |
| SelectionLength | Gets the number of selected characters. |
| SelectionStart | Gets a character index at which the selection starts. |
| StartIcon | Specifies the leading icon image. Inherited from EditBase. |
| StartIconColor | Gets or sets the color of a custom icon displayed at the editor’s near edge. Inherited from EditBase. |
| StartIconCommand | Specifies the command executed when a user taps the leading icon. Inherited from EditBase. |
| StartIconCommandParameter | Specifies the parameter passed to the StartIconCommand. Inherited from EditBase. |
| Text | Gets or sets the text entered in the editor. |
| TextChangedCommand | Specifies the command executed when text in the edit box changes. |
| TextChangedCommandParameter | Specifies the parameter passed to the TextChangedCommand. |
| TextColor | Gets or sets the color of text entered into the editor. Inherited from EditBase. |
| TextFontAttributes | Gets or sets the font style that the editor uses for input text, label and placeholder. Inherited from EditBase. |
| TextFontFamily | Gets or sets the font family that the editor uses for input text, label and placeholder. Inherited from EditBase. |
| TextFontSize | Gets or sets the font size of text entered into the editor. Inherited from EditBase. |
| TextHorizontalAlignment | Gets or sets the horizontal alignment of text entered in the editor. Inherited from EditBase. |
Methods
| Name | Description |
|---|---|
| SelectAll() | Selects all text in the edit box. |
| SetSelection(Int32, Int32) | Selects the specified portion of the text. |
| SetSelection(Int32) | Select text from the specified position to the end. |
Events
| Name | Description |
|---|---|
| ClearIconClicked | Occurs when a user taps the clear icon. Inherited from EditBase. |
| Completed | Occurs when a user taps the ‘Return’ button of the keyboard. Inherited from EditBase. |
| DoubleTap | Fires when the user double taps the editor. Inherited from EditBase. |
| EndIconClicked | Occurs when a user taps the trailing icon. Inherited from EditBase. |
| ErrorIconClicked | Occurs when a user taps the error icon. Inherited from EditBase. |
| LongPress | Fires when the user presses and holds the editor. Inherited from EditBase. |
| StartIconClicked | Occurs when a user taps the leading icon. Inherited from EditBase. |
| Tap | Fires when the user taps the editor. Inherited from EditBase. |
| TextChanged | Fires when text in the edit box changes. |
See Also