Skip to main content

EditBase Members

The base class for all data editors.

Fields

Name Description
AllowAnimationProperty static Identifies the AllowAnimation bindable property.
BorderColorProperty static Identifies the BorderColor bindable property.
BorderThicknessProperty static Identifies the BorderThickness bindable property.
BottomTextFontAttributesProperty static Identifies the BottomTextFontAttributes bindable property.
BottomTextFontFamilyProperty static Identifies the BottomTextFontFamily bindable property.
BottomTextFontSizeProperty static Identifies the BottomTextFontSize bindable property.
BottomTextTopIndentProperty static Identifies the BottomTextTopIndent bindable property.
BoxHeightProperty static Identifies the BoxHeight dependency property.
BoxMarginProperty static Identifies the BoxMargin dependency property.
BoxMinHeightProperty static Identifies the BoxMinHeight dependency property.
BoxMinWidthProperty static Identifies the BoxMinWidth dependency property.
BoxModeProperty static Identifies the BoxMode bindable property.
BoxPaddingProperty static Identifies the BoxPadding bindable property.
CharacterCasingProperty static Identifies the CharacterCasing dependency property.
ClearIconColorProperty static Identifies the ClearIconColor dependency property.
ClearIconCommandParameterProperty static Identifies the ClearIconCommandParameter dependency property.
ClearIconCommandProperty static Identifies the ClearIconCommand dependency property.
ClearIconProperty static Identifies the ClearIcon dependency property.
ClearIconVisibilityProperty static Identifies the ClearIconVisibility dependency property.
CornerModeProperty static Identifies the CornerMode bindable property.
CornerRadiusProperty static Identifies the CornerRadius dependency property.
CursorColorProperty static Identifies the CursorColor dependency property.
DisabledBackgroundColorProperty static Identifies the DisabledBackgroundColor dependency property.
DisabledBorderColorProperty static Identifies the DisabledBorderColor bindable property.
DisabledBorderThicknessProperty static Identifies the DisabledBorderThickness bindable property.
DisabledHelpTextColorProperty static Identifies the DisabledHelpTextColor bindable property.
DisabledIconColorProperty static Identifies the DisabledIconColor bindable property.
DisabledLabelColorProperty static Identifies the DisabledLabelColor bindable property.
DisabledTextColorProperty static Identifies the DisabledTextColor bindable property.
DisplayTextProperty static Identifies the DisplayText dependency property.
EndIconColorProperty static Identifies the EndIconColor dependency property.
EndIconCommandParameterProperty static Identifies the EndIconCommandParameter bindable property.
EndIconCommandProperty static Identifies the EndIconCommand bindable property.
EndIconProperty static Identifies the EndIcon bindable property.
ErrorColorProperty static Identifies the ErrorColor bindable property.
ErrorIconColorProperty static Identifies the ErrorIconColor dependency property.
ErrorIconCommandParameterProperty static Identifies the ErrorIconCommandParameter bindable property.
ErrorIconCommandProperty static Identifies the ErrorIconCommand bindable property.
ErrorIconProperty static Identifies the ErrorIcon bindable property.
ErrorTextProperty static Identifies the ErrorText bindable property.
FocusedBorderColorProperty static Identifies the FocusedBorderColor bindable property.
FocusedBorderThicknessProperty static Identifies the FocusedBorderThickness bindable property.
FocusedLabelColorProperty static Identifies the FocusedLabelColor bindable property.
HasErrorProperty static Identifies the HasError bindable property.
HelpTextColorProperty static Identifies the HelpTextColor bindable property.
HelpTextProperty static Identifies the HelpText bindable property.
IconColorProperty static Identifies the IconColor bindable property.
IconIndentProperty static Identifies the IconIndent bindable property.
IconSpacingProperty static Identifies the IconSpacing bindable property.
IconVerticalAlignmentProperty static Identifies the IconVerticalAlignment bindable property.
IsEndIconVisibleProperty static Identifies the IsEndIconVisible bindable property.
IsErrorIconVisibleProperty static Identifies the IsErrorIconVisible bindable property.
IsLabelFloatingProperty static Identifies the IsLabelFloating bindable property.
IsReadOnlyProperty static Identifies the IsReadOnly dependency property.
IsStartIconVisibleProperty static Identifies the IsStartIconVisible bindable property.
LabelColorProperty static Identifies the LabelColor bindable property.
LabelFontSizeProperty static Identifies the LabelFontSize bindable property.
LabelTextProperty static Identifies the LabelText bindable property.
PlaceholderColorProperty static Identifies the PlaceholderColor bindable property.
PlaceholderTextProperty static Identifies the PlaceholderText dependency property.
ReserveBottomTextLineProperty static Identifies the ReserveBottomTextLine bindable property.
ReturnCommandParameterProperty static Identifies the ReturnCommandParameter dependency property.
ReturnCommandProperty static Identifies the ReturnCommand dependency property.
ReturnTypeProperty static Identifies the ReturnType dependency property.
StartIconColorProperty static Identifies the StartIconColor dependency property.
StartIconCommandParameterProperty static Identifies the StartIconCommandParameter bindable property.
StartIconCommandProperty static Identifies the StartIconCommand bindable property.
StartIconProperty static Identifies the StartIcon bindable property.
TextColorProperty static Identifies the TextColor bindable property.
TextFontAttributesProperty static Identifies the TextFontAttributes bindable property.
TextFontFamilyProperty static Identifies the TextFontFamily bindable property.
TextFontSizeProperty static Identifies the TextFontSize bindable property.
TextHorizontalAlignmentProperty static Identifies the TextHorizontalAlignment bindable property.

Properties

Name Description
AllowAnimation Specifies whether the editor’s floating label moves with a smooth animation effect.
BorderColor Gets or sets the color of the editor box borders.
BorderThickness Gets or sets the thickness of the editor box borders.
BottomTextFontAttributes Gets or sets whether the editor’s help and error text is bold or italic.
BottomTextFontFamily Gets or sets the font family name for the editor’s help and error text.
BottomTextFontSize Gets or sets the font size of the editor’s help and error text.
BottomTextTopIndent Gets or sets the distance between the editor’s bottom border and help/error text.
BoxHeight Gets or sets the edit box height.
BoxMargin Gets the margin of the edit box inside the editor.
BoxMinHeight Gets or sets the minimum edit box height.
BoxMinWidth Gets or sets the minimum edit box width.
BoxMode Gets or sets whether a stroke is displayed around the entire editor box or for the bottom edge only.
BoxPadding Gets or sets the amount of space between borders of the edit box and its content.
CharacterCasing Gets or sets whether to automatically convert characters to lowercase or uppercase when a user enters text in the editor.
ClearIcon Specifies the clear icon image.
ClearIconColor Gets or sets the color of the clear icon.
ClearIconCommand Specifies the command executed when a user taps the clear icon.
ClearIconCommandParameter Specifies the parameter passed to the ClearIconCommand.
ClearIconVisibility Specifies when the clear icon is displayed.
CornerMode Gets or sets whether edit box corners are rounded or cut.
CornerRadius Gets or sets the corner radius of the edit box.
CursorColor Gets or sets the color of the input cursor.
DisabledBackgroundColor Gets or sets the edit box background in disabled state.
DisabledBorderColor Gets or sets the color of the editor box borders in a disabled state.
DisabledBorderThickness Gets or sets the thickness of the editor box borders in a disabled state.
DisabledHelpTextColor Specifies the color of the help text shown below the disabled editor.
DisabledIconColor Specifies the color for icons of the editor in a disabled state.
DisabledLabelColor Gets or sets the text color for the label of the editor in a disabled state.
DisabledTextColor Gets or sets the color of text entered into the editor in a disabled state.
DisplayText Gets a string value that specifies the formatted text displayed in the editor.
EndIcon Specifies the trailing icon image.
EndIconColor Gets or sets the color of a custom icon displayed at the editor’s far edge.
EndIconCommand Specifies the command executed when a user taps the trailing icon.
EndIconCommandParameter Specifies the parameter passed to the EndIconCommand.
ErrorColor Gets or sets the color of the edit box’s borders, label, error icon, and error message if there is an input error.
ErrorIcon Specifies the error icon image.
ErrorIconColor Gets or sets the color of an icon displayed when HasError is set to true.
ErrorIconCommand Specifies the command executed when a user taps the error icon.
ErrorIconCommandParameter Specifies the parameter passed to the ErrorIconCommand.
ErrorText Specifies the text message that appears below the editor in an error state.
FocusedBorderColor Gets or sets the color of the editor box borders in the focused state.
FocusedBorderThickness Gets or sets the thickness of the editor box borders in a focused state.
FocusedLabelColor Gets or sets the text color for the label of the editor in a focused state.
HasError Allows you to switch the editor to an error state.
HelpText Specifies the input prompt text displayed below the edit box.
HelpTextColor Specifies the color of the help text shown below the edit box.
IconColor Specifies the color for editor icons.
IconIndent Gets or sets the distance between an icon and input text (affix).
IconSpacing Gets or sets the distance between icons.
IconVerticalAlignment Gets or sets the vertical alignment of icons.
IsEndIconVisible Gets or sets whether the trailing icon is visible.
IsErrorIconVisible Gets or sets whether the error icon is visible.
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.
IsReadOnly Gets or sets whether users can change a value in the editor.
IsStartIconVisible Gets or sets whether the leading icon is visible.
LabelColor Gets or sets the text color for the label of the editor in an unfocused state.
LabelFontSize Gets or sets the font size of the editor’s label text.
LabelText Gets or sets the editor’s label text.
PlaceholderColor Specifies the placeholder color.
PlaceholderText Specifies the placeholder text.
ReserveBottomTextLine Allows you to reserve a line for the error text below the edit box.
ReturnCommand Specifies the command that is executed when a user taps the ‘Return’ button.
ReturnCommandParameter Specifies the parameter passed to the ReturnCommand.
ReturnType Specifies the appearance of the ‘Return’ button on the operating system’s on-screen keyboard.
StartIcon Specifies the leading icon image.
StartIconColor Gets or sets the color of a custom icon displayed at the editor’s near edge.
StartIconCommand Specifies the command executed when a user taps the leading icon.
StartIconCommandParameter Specifies the parameter passed to the StartIconCommand.
TextColor Gets or sets the color of text entered into the editor.
TextFontAttributes Gets or sets the font style that the editor uses for input text, label and placeholder.
TextFontFamily Gets or sets the font family that the editor uses for input text, label and placeholder.
TextFontSize Gets or sets the font size of text entered into the editor.
TextHorizontalAlignment Gets or sets the horizontal alignment of text entered in the editor.

Events

Name Description
ClearIconClicked Occurs when a user taps the clear icon.
Completed Occurs when a user taps the ‘Return’ button of the keyboard.
DoubleTap Fires when the user double taps the editor.
EndIconClicked Occurs when a user taps the trailing icon.
ErrorIconClicked Occurs when a user taps the error icon.
LongPress Fires when the user presses and holds the editor.
StartIconClicked Occurs when a user taps the leading icon.
Tap Fires when the user taps the editor.
See Also