Class RadEntry

RadEntry is a single line text entry. It is best used for collecting small discrete pieces of information, like usernames and passwords.

Inheritance

System.Object

RadContentView

RadCompositeContentView

RadEntry

ChatEntry

Inherited Members

RadCompositeContentView.StyleProperty

RadCompositeContentView.ControlTemplateProperty

RadCompositeContentView.OnBindingContextChanged()

RadCompositeContentView.OnPropertyChanged(String)

RadCompositeContentView.Style

RadCompositeContentView.ControlTemplate

RadContentView.ActualStyleClassProperty

RadContentView.OnChildAdded(Element)

RadContentView.OnChildRemoved(Element, Int32)

RadContentView.OnHandlerChanged()

RadContentView.ActualStyleClass

Namespace: Telerik.Maui.Controls

Assembly: Telerik.Maui.Controls.dll

Syntax

public class RadEntry : RadCompositeContentView, IRadContentView, IContentView, IView, IElement, ITransform, IPadding, ICrossPlatformLayout

Constructors

RadEntry()

Initializes a new instance of the class.

Declaration

public RadEntry()

Fields

ActualClearButtonCommandProperty

Identifies the ActualClearButtonCommand property.

Declaration

public static readonly BindableProperty ActualClearButtonCommandProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

ActualClearButtonStyleProperty

Identifies the ActualClearButtonStyle property.

Declaration

public static readonly BindableProperty ActualClearButtonStyleProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

ActualIsClearButtonVisibleProperty

Identifies the ActualIsClearButtonVisible property.

Declaration

public static readonly BindableProperty ActualIsClearButtonVisibleProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

ActualIsValidationErrorImageVisibleProperty

Identifies the ActualIsValidationErrorImageVisible property.

Declaration

public static readonly BindableProperty ActualIsValidationErrorImageVisibleProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

ActualIsValidationErrorLabelVisibleProperty

Identifies the ActualIsValidationErrorLabelVisible property.

Declaration

public static readonly BindableProperty ActualIsValidationErrorLabelVisibleProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

ActualTextInputStyleProperty

Identifies the ActualTextInputStyle property.

Declaration

public static readonly BindableProperty ActualTextInputStyleProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

ActualValidationErrorImageStyleProperty

Identifies the ActualValidationErrorImageStyle property.

Declaration

public static readonly BindableProperty ActualValidationErrorImageStyleProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

ActualValidationErrorLabelStyleProperty

Identifies the ActualValidationErrorLabelStyle property.

Declaration

public static readonly BindableProperty ActualValidationErrorLabelStyleProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

ActualValidationErrorMessageProperty

Identifies the ActualValidationErrorMessage property.

Declaration

public static readonly BindableProperty ActualValidationErrorMessageProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

BackgroundColorProperty

Identifies the BackgroundColor property.

Declaration

public static readonly BindableProperty BackgroundColorProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

BackgroundProperty

Identifies the Background property.

Declaration

public static readonly BindableProperty BackgroundProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

BorderBrushProperty

Identifies the BorderBrush property.

Declaration

public static readonly BindableProperty BorderBrushProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

BorderThicknessProperty

Identifies the BorderThickness property.

Declaration

public static readonly BindableProperty BorderThicknessProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

CharacterSpacingProperty

Identifies the CharacterSpacing property.

Declaration

public static readonly BindableProperty CharacterSpacingProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

ClearButtonStyleProperty

Identifies the ClearButtonStyle property.

Declaration

public static readonly BindableProperty ClearButtonStyleProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

ClearButtonVisibilityProperty

Identifies the ClearButtonVisibility property.

Declaration

public static readonly BindableProperty ClearButtonVisibilityProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

CornerRadiusProperty

Identifies the CornerRadius property.

Declaration

public static readonly BindableProperty CornerRadiusProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

CursorPositionProperty

Identifies the CursorPosition property.

Declaration

public static readonly BindableProperty CursorPositionProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

FontAttributesProperty

Identifies the FontAttributes property.

Declaration

public static readonly BindableProperty FontAttributesProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

FontAutoScalingEnabledProperty

Identifies the FontAutoScalingEnabled property.

Declaration

public static readonly BindableProperty FontAutoScalingEnabledProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

FontFamilyProperty

Identifies the FontFamily property.

Declaration

public static readonly BindableProperty FontFamilyProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

FontSizeProperty

Identifies the FontSize property.

Declaration

public static readonly BindableProperty FontSizeProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

HorizontalTextAlignmentProperty

Identifies the HorizontalTextAlignment property.

Declaration

public static readonly BindableProperty HorizontalTextAlignmentProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

InvalidFocusedState

Represents the visual state name for invalid focused state.

Declaration

public const string InvalidFocusedState = "InvalidFocused"

Field Value

System.String

InvalidState

Represents the visual state name for invalid state.

Declaration

public const string InvalidState = "Invalid"

Field Value

System.String

IsPasswordProperty

Identifies the IsPassword property.

Declaration

public static readonly BindableProperty IsPasswordProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

IsReadOnlyProperty

Identifies the IsReadOnly property.

Declaration

public static readonly BindableProperty IsReadOnlyProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

IsSpellCheckEnabledProperty

Identifies the IsSpellCheckEnabled property.

Declaration

public static readonly BindableProperty IsSpellCheckEnabledProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

IsTextPredictionEnabledProperty

Identifies the IsTextPredictionEnabled property.

Declaration

public static readonly BindableProperty IsTextPredictionEnabledProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

IsValueValidProperty

Identifies the IsValueValid property.

Declaration

public static readonly BindableProperty IsValueValidProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

KeyboardProperty

Identifies the Keyboard property.

Declaration

public static readonly BindableProperty KeyboardProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

MaxLengthProperty

Identifies the MaxLength property.

Declaration

public static readonly BindableProperty MaxLengthProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

MouseOverState

Represents the visual state name for mouse over state.

Declaration

public const string MouseOverState = "MouseOver"

Field Value

System.String

PaddingProperty

Identifies the Padding property.

Declaration

public static readonly BindableProperty PaddingProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

PlaceholderColorProperty

Identifies the PlaceholderColor property.

Declaration

public static readonly BindableProperty PlaceholderColorProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

PlaceholderProperty

Identifies the Placeholder property.

Declaration

public static readonly BindableProperty PlaceholderProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

ReadOnlyFocusedState

Represents the visual state name for read-only focused state.

Declaration

public const string ReadOnlyFocusedState = "ReadOnlyFocused"

Field Value

System.String

ReadOnlyInvalidFocusedState

Represents the visual state name for read-only invalid focused state.

Declaration

public const string ReadOnlyInvalidFocusedState = "ReadOnlyInvalidFocused"

Field Value

System.String

ReadOnlyInvalidState

Represents the visual state name for read-only invalid state.

Declaration

public const string ReadOnlyInvalidState = "ReadOnlyInvalid"

Field Value

System.String

ReadOnlyState

Represents the visual state name for read-only state.

Declaration

public const string ReadOnlyState = "ReadOnly"

Field Value

System.String

ReserveSpaceForErrorViewProperty

Identifies the ReserveSpaceForErrorView property.

Declaration

public static readonly BindableProperty ReserveSpaceForErrorViewProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

ReturnCommandParameterProperty

Identifies the ReturnCommandParameter property.

Declaration

public static readonly BindableProperty ReturnCommandParameterProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

ReturnCommandProperty

Identifies the ReturnCommand property.

Declaration

public static readonly BindableProperty ReturnCommandProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

ReturnTypeProperty

Identifies the ReturnType property.

Declaration

public static readonly BindableProperty ReturnTypeProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

SelectionLengthProperty

Identifies the SelectionLength property.

Declaration

public static readonly BindableProperty SelectionLengthProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

SelectionOnFocusProperty

Identifies the SelectionOnFocus property.

Declaration

public static readonly BindableProperty SelectionOnFocusProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

TextColorProperty

Identifies the TextColor property.

Declaration

public static readonly BindableProperty TextColorProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

TextProperty

Identifies the Text property.

Declaration

public static readonly BindableProperty TextProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

TextTransformProperty

Identifies the TextTransform property.

Declaration

public static readonly BindableProperty TextTransformProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

ValidationErrorColorProperty

Identifies the ValidationErrorColor property.

Declaration

public static readonly BindableProperty ValidationErrorColorProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

ValidationErrorImageStyleProperty

Identifies the ValidationErrorImageStyle property.

Declaration

public static readonly BindableProperty ValidationErrorImageStyleProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

ValidationErrorLabelStyleProperty

Identifies the ValidationErrorLabelStyle property.

Declaration

public static readonly BindableProperty ValidationErrorLabelStyleProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

ValidationErrorMessageProperty

Identifies the ValidationErrorMessage property.

Declaration

public static readonly BindableProperty ValidationErrorMessageProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

VerticalTextAlignmentProperty

Identifies the VerticalTextAlignment property.

Declaration

public static readonly BindableProperty VerticalTextAlignmentProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

Properties

ActualClearButtonCommand

Gets the command that is executed when the clear button is clicked.

Declaration

public ICommand ActualClearButtonCommand { get; }

Property Value

System.Windows.Input.ICommand

ActualClearButtonStyle

Gets the actual style that is applied to the clear button. This is result of merging the ClearButtonStyle and the default clear button style.

Declaration

public Style ActualClearButtonStyle { get; }

Property Value

Microsoft.Maui.Controls.Style

ActualIsClearButtonVisible

Gets a value indicating whether the clear button should be visible based on the ClearButtonVisibility property.

Declaration

public bool ActualIsClearButtonVisible { get; }

Property Value

System.Boolean

ActualIsValidationErrorImageVisible

Gets a value indicating whether the validation error image should be visible based on the ReserveSpaceForErrorView property.

Declaration

public bool ActualIsValidationErrorImageVisible { get; }

Property Value

System.Boolean

ActualIsValidationErrorLabelVisible

Gets a value indicating whether the validation error label should be visible based on the ReserveSpaceForErrorView property.

Declaration

public bool ActualIsValidationErrorLabelVisible { get; }

Property Value

System.Boolean

ActualTextInputStyle

Gets the actual style that is applied to the text box.

Declaration

public Style ActualTextInputStyle { get; }

Property Value

Microsoft.Maui.Controls.Style

ActualValidationErrorImageStyle

Gets the actual style that is applied to the error icon. This is result of merging the ValidationErrorImageStyle and the default error image style.

Declaration

public Style ActualValidationErrorImageStyle { get; }

Property Value

Microsoft.Maui.Controls.Style

ActualValidationErrorLabelStyle

Gets the actual style that is applied to the error. This is result of merging the ValidationErrorLabelStyle and the default error label style.

Declaration

public Style ActualValidationErrorLabelStyle { get; }

Property Value

Microsoft.Maui.Controls.Style

ActualValidationErrorMessage

Gets the actual validation error text. This value depends on the ValidationErrorMessage and the IsValueValid properties.

Declaration

public string ActualValidationErrorMessage { get; }

Property Value

System.String

Background

Gets or sets the background brush of the control.

Declaration

public Brush Background { get; set; }

Property Value

Microsoft.Maui.Controls.Brush

BackgroundColor

Gets or sets the background color of the control.

Declaration

public Color BackgroundColor { get; set; }

Property Value

Microsoft.Maui.Graphics.Color

BorderBrush

Gets or sets the border brush of the control.

Declaration

public Brush BorderBrush { get; set; }

Property Value

Microsoft.Maui.Controls.Brush

BorderThickness

Gets or sets the border thickness of the control.

Declaration

public Thickness BorderThickness { get; set; }

Property Value

Microsoft.Maui.Thickness

CharacterSpacing

Gets or sets a value indicating the number of device-independent units that should be in between characters in the text displayed by the entry.

Declaration

public double CharacterSpacing { get; set; }

Property Value

System.Double

ClearButtonStyle

Gets or sets a custom style that is to be applied to the clear button. The actual style that is applied is a merger between this style and the default clear button style.

Declaration

public Style ClearButtonStyle { get; set; }

Property Value

Microsoft.Maui.Controls.Style

ClearButtonVisibility

Gets or sets a value indicating when the clear-button (the button that clears the text when pressed) should be displayed.

Declaration

public ClearButtonVisibility ClearButtonVisibility { get; set; }

Property Value

Microsoft.Maui.ClearButtonVisibility

CornerRadius

Gets or sets the corner radius of the control.

Declaration

public CornerRadius CornerRadius { get; set; }

Property Value

Microsoft.Maui.CornerRadius

CursorPosition

Gets or sets the position of the cursor. The value must be more than or equal to 0 and less or equal to the length of text.

Declaration

public int CursorPosition { get; set; }

Property Value

System.Int32

FontAttributes

Gets or sets a value that indicates whether the font for the text of this entry is bold, italic, or neither.

Declaration

public FontAttributes FontAttributes { get; set; }

Property Value

Microsoft.Maui.Controls.FontAttributes

FontAutoScalingEnabled

Determines whether or not the font of this entry should scale automatically according to the operating system settings. Default value is true.

Declaration

public bool FontAutoScalingEnabled { get; set; }

Property Value

System.Boolean

Remarks

Typically this should always be enabled for accessibility reasons.

FontFamily

Gets or sets the font family for the text of this entry.

Declaration

public string FontFamily { get; set; }

Property Value

System.String

FontSize

Gets or sets the size of the font for the text of this entry.

Declaration

public double FontSize { get; set; }

Property Value

System.Double

HorizontalTextAlignment

Gets or sets the horizontal text alignment.

Declaration

public TextAlignment HorizontalTextAlignment { get; set; }

Property Value

Microsoft.Maui.TextAlignment

IsPassword

Gets or sets a value that indicates if the entry should visually obscure typed text. Value is true if the element is a password box; otherwise, false. Default value is false.

Declaration

public bool IsPassword { get; set; }

Property Value

System.Boolean

Remarks

Toggling this value does not reset the contents of the entry, therefore it is advisable to be careful about setting IsPassword to false, as it may contain sensitive information.

IsReadOnly

Gets or sets a value indicating whether the user should be prevented from modifying the text.

Declaration

public bool IsReadOnly { get; set; }

Property Value

System.Boolean

IsSpellCheckEnabled

Gets or sets a value that controls whether spell checking is enabled.

Declaration

public bool IsSpellCheckEnabled { get; set; }

Property Value

System.Boolean

Remarks

On Windows, spellchecking also turns on auto correction

IsTextPredictionEnabled

Gets or sets a value that controls whether text prediction and automatic text correction are enabled.

Declaration

public bool IsTextPredictionEnabled { get; set; }

Property Value

System.Boolean

Remarks

On Windows, text prediction only affects touch keyboards and only affects keyboard word suggestions.

IsValueValid

Gets or sets a value indicating whether the text value of is valid.

Declaration

public bool IsValueValid { get; set; }

Property Value

System.Boolean

Keyboard

Gets or sets the keyboard type that is displayed when this view is in focus.

Declaration

public Keyboard Keyboard { get; set; }

Property Value

Microsoft.Maui.Keyboard

MaxLength

Gets or sets the maximum allowed length of input.

Declaration

public int MaxLength { get; set; }

Property Value

System.Int32

Padding

Gets or sets the padding.

Declaration

public Thickness Padding { get; set; }

Property Value

Microsoft.Maui.Thickness

Placeholder

Gets or sets the text that is displayed when the control is empty.

Declaration

public string Placeholder { get; set; }

Property Value

System.String

PlaceholderColor

Gets or sets the color of the placeholder text.

Declaration

public Color PlaceholderColor { get; set; }

Property Value

Microsoft.Maui.Graphics.Color

ReserveSpaceForErrorView

Gets or sets a value indicating whether space for the error label should always be reserved. When set to true, the entry does not change size when an error is shown. When set to false, the entry might change size to make space for the error label.

Declaration

public bool ReserveSpaceForErrorView { get; set; }

Property Value

System.Boolean

ReturnCommand

Gets or sets the command to run when the user presses the return key, either physically or on the on-screen keyboard.

Declaration

public ICommand ReturnCommand { get; set; }

Property Value

System.Windows.Input.ICommand

ReturnCommandParameter

Gets or sets the parameter object for the ReturnCommand that can be used to provide extra information.

Declaration

public object ReturnCommandParameter { get; set; }

Property Value

System.Object

ReturnType

Determines what the return key on the on-screen keyboard should look like.

Declaration

public ReturnType ReturnType { get; set; }

Property Value

Microsoft.Maui.ReturnType

SelectionLength

Gets or sets the length of the text selection. The selection starts at CursorPosition.

Declaration

public int SelectionLength { get; set; }

Property Value

System.Int32

SelectionOnFocus

Gets or sets a value that specifies the modification over the text selection when the control receives focus.

Declaration

public SelectionOnFocus SelectionOnFocus { get; set; }

Property Value

SelectionOnFocus

Text

Gets or sets the text.

Declaration

public string Text { get; set; }

Property Value

System.String

TextColor

Gets or sets a value indicating whether the user should be prevented from modifying the text.

Declaration

public Color TextColor { get; set; }

Property Value

Microsoft.Maui.Graphics.Color

TextTransform

Gets or sets the text transformation that is applied to the text.

Declaration

public TextTransform TextTransform { get; set; }

Property Value

Microsoft.Maui.TextTransform

ValidationErrorColor

Gets or sets a custom color that should be used to visualize the error views.

Declaration

public Color ValidationErrorColor { get; set; }

Property Value

Microsoft.Maui.Graphics.Color

ValidationErrorImageStyle

Gets or sets a custom style that is to be applied to the error icon. The actual style that is applied is a merger between this style and the default error image style.

Declaration

public Style ValidationErrorImageStyle { get; set; }

Property Value

Microsoft.Maui.Controls.Style

ValidationErrorLabelStyle

Gets or sets a custom style that is to be applied to the error label. The actual style that is applied is a merger between this style and the default error label style.

Declaration

public Style ValidationErrorLabelStyle { get; set; }

Property Value

Microsoft.Maui.Controls.Style

ValidationErrorMessage

Gets or sets a value that contains the message that should be displayed when a validation error occurs.

Declaration

public string ValidationErrorMessage { get; set; }

Property Value

System.String

VerticalTextAlignment

Gets or sets the horizontal text alignment.

Declaration

public TextAlignment VerticalTextAlignment { get; set; }

Property Value

Microsoft.Maui.TextAlignment

Methods

ChangeVisualState()

Updates the visual state of the control based on its current properties.

Declaration

protected override void ChangeVisualState()

OnApplyTemplate()

Called when the control template is applied. Initializes the Telerik.Maui.Controls.RadEntry.TextInput from the template.

Declaration

protected override void OnApplyTemplate()

Overrides

RadCompositeContentView.OnApplyTemplate()

Events

Completed

Occurs when the user finalizes the text in an entry with the return key.

Declaration

public event EventHandler Completed

Event Type

System.EventHandler

TextChanged

Event that is raised when the text has changed.

Declaration

public event EventHandler<TextChangedEventArgs> TextChanged

Event Type

System.EventHandler<Microsoft.Maui.Controls.TextChangedEventArgs>

TextChanging

Event that is raised when the text in the entry starts to change, but before the Text property is updated.

Declaration

public event EventHandler<TextChangingEventArgs> TextChanging

Event Type

System.EventHandler<TextChangingEventArgs>

Extension Methods

AndroidTypeConversionExtensions.ToJavaObject(Object)