Entry Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Entry is a single line text entry. It is best used for collecting small discrete pieces of information, like usernames and passwords.
public ref class Entry : Microsoft::Maui::Controls::InputView, Microsoft::Maui::Controls::IElementConfiguration<Microsoft::Maui::Controls::Entry ^>, Microsoft::Maui::Controls::IEntryController, Microsoft::Maui::Controls::Internals::IFontElement, Microsoft::Maui::IEntry
public class Entry : Microsoft.Maui.Controls.InputView, Microsoft.Maui.Controls.IElementConfiguration<Microsoft.Maui.Controls.Entry>, Microsoft.Maui.Controls.IEntryController, Microsoft.Maui.Controls.Internals.IFontElement, Microsoft.Maui.IEntry
type Entry = class
inherit InputView
interface IFontElement
interface IEntryController
interface IElementConfiguration<Entry>
interface IEntry
interface IView
interface IElement
interface ITransform
interface ITextInput
interface IText
interface ITextStyle
interface IPlaceholder
interface ITextAlignment
Public Class Entry
Inherits InputView
Implements IElementConfiguration(Of Entry), IEntry, IEntryController, IFontElement
- Inheritance
- Implements
Remarks
Entry is a single line text entry. It is best used for collecting small discrete pieces of information, like usernames and passwords.
The following example creates a new username and password set of entries.
View CreateLoginForm ()
{
var usernameEntry = new Entry {Placeholder = "Username"};
var passwordEntry = new Entry {
Placeholder = "Password",
IsPassword = true
};
return new StackLayout {
Children = {
usernameEntry,
passwordEntry
}
};
}
The FormsGallery sample, which can be found on the Sample Applications page, has an EntryDemoPage.cs file. This file contains a more complete example.
Constructors
Entry() |
Creates a new Entry object with default values. |
Fields
Properties
AnchorX |
Gets or sets the X component of the center point for any transform, relative to the bounds of the element. This is a bindable property. (Inherited from VisualElement) |
AnchorY |
Gets or sets the Y component of the center point for any transform, relative to the bounds of the element. This is a bindable property. (Inherited from VisualElement) |
AutomationId |
Gets or sets a value that allows the automation framework to find and interact with this element. (Inherited from Element) |
Background | (Inherited from VisualElement) |
BackgroundColor |
Gets or sets the color which will fill the background of a VisualElement. This is a bindable property. (Inherited from VisualElement) |
Batched |
For internal use by the Microsoft.Maui.Controls platform. (Inherited from VisualElement) |
Behaviors |
Gets the list of Behaviors associated to this element. This is a bindable property. (Inherited from VisualElement) |
BindingContext |
Gets or sets object that contains the properties that will be targeted by the bound properties that belong to this BindableObject. (Inherited from BindableObject) |
Bounds |
Gets the bounds of the element. (Inherited from VisualElement) |
CharacterSpacing |
Gets or sets a value that indicates the number of device-independent units that should be in between characters in the text displayed by the Entry. Applies to Text and Placeholder. (Inherited from InputView) |
class | (Inherited from NavigableElement) |
ClassId |
Gets or sets a value used to identify a collection of semantically similar elements. (Inherited from Element) |
ClearButtonVisibility |
Determines the behavior of the clear text button on this entry. This is a bindable property. |
Clip | (Inherited from VisualElement) |
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. This is a bindable property. |
DesiredSize | (Inherited from VisualElement) |
DisableLayout |
For internal use by the Microsoft.Maui.Controls platform. (Inherited from VisualElement) |
Dispatcher | (Inherited from BindableObject) |
EffectControlProvider |
For internal use by the Microsoft.Maui.Controls platform. (Inherited from Element) |
Effects |
A list of the effects that are applied to this item. (Inherited from Element) |
FlowDirection |
Gets or sets the layout flow direction. (Inherited from VisualElement) |
FontAttributes |
Gets or sets a value that indicates whether the font for the text of this entry is bold, italic, or neither. This is a bindable property. |
FontAutoScalingEnabled |
Determines whether or not the font of this entry should scale automatically according to the operating system settings. Default value is |
FontFamily |
Gets or sets the font family for the text of this entry. This is a bindable property. |
FontSize |
Gets or sets the size of the font for the text of this entry. This is a bindable property. |
Frame | (Inherited from VisualElement) |
GestureController | (Inherited from View) |
GestureRecognizers |
The collection of gesture recognizers associated with this view. (Inherited from View) |
Handler | (Inherited from VisualElement) |
Height |
Gets the current rendered height of this element. This is a read-only bindable property. (Inherited from VisualElement) |
HeightRequest |
Gets or sets the desired height override of this element. (Inherited from VisualElement) |
HorizontalOptions |
Gets or sets the LayoutOptions that define how the element gets laid in a layout cycle. This is a bindable property. (Inherited from View) |
HorizontalTextAlignment |
Gets or sets the horizontal text alignment. This is a bindable property. |
Id |
Gets a value that can be used to uniquely identify an element through the run of an application. (Inherited from Element) |
InputTransparent |
Gets or sets a value indicating whether this element should be involved in the user interaction cycle. This is a bindable property. (Inherited from VisualElement) |
IsEnabled |
Gets or sets a value indicating whether this element is enabled in the user interface. This is a bindable property. (Inherited from VisualElement) |
IsFocused |
Gets a value indicating whether this element is focused currently. This is a bindable property. (Inherited from VisualElement) |
IsInPlatformLayout | (Inherited from VisualElement) |
IsLoaded |
Indicates if a VisualElement is connected to the main object tree. (Inherited from VisualElement) |
IsPassword |
Gets or sets a value that indicates if the entry should visually obscure typed text.
Value is |
IsPlatformEnabled |
For internal use by the Microsoft.Maui.Controls platform. (Inherited from VisualElement) |
IsPlatformStateConsistent | (Inherited from VisualElement) |
IsReadOnly |
Gets or sets a value that indicates whether user should be prevented from modifying the text. Default is |
IsSpellCheckEnabled |
Gets or sets a value that controls whether spell checking is enabled. (Inherited from InputView) |
IsTextPredictionEnabled |
Determines whether text prediction and automatic text correction is enabled. Default value is |
IsVisible |
Gets or sets a value that determines whether this elements should be part of the visual tree or not. This is a bindable property. (Inherited from VisualElement) |
Keyboard |
Gets or sets the Keyboard for the InputView. This is a bindable property. (Inherited from InputView) |
LogicalChildren |
Obsolete.
For internal use by the Microsoft.Maui.Controls platform. (Inherited from Element) |
Margin |
Gets or sets the margin for the view. (Inherited from View) |
MaximumHeightRequest | (Inherited from VisualElement) |
MaximumWidthRequest | (Inherited from VisualElement) |
MaxLength |
Gets or sets the maximum allowed length of input. (Inherited from InputView) |
MinimumHeightRequest |
Gets or sets a value which overrides the minimum height the element will request during layout. (Inherited from VisualElement) |
MinimumWidthRequest |
Gets or sets a value which overrides the minimum width the element will request during layout. (Inherited from VisualElement) |
Navigation | (Inherited from NavigableElement) |
NavigationProxy | (Inherited from NavigableElement) |
Opacity |
Gets or sets the opacity value applied to the element when it is rendered. This is a bindable property. (Inherited from VisualElement) |
Parent |
Gets or sets the parent element of the element. (Inherited from Element) |
Placeholder |
Gets or sets the text that is displayed when the control is empty. (Inherited from InputView) |
PlaceholderColor |
Gets or sets the color of the placeholder text. (Inherited from InputView) |
RealParent |
For internal use by the Microsoft.Maui.Controls platform. (Inherited from Element) |
Resources |
Gets or sets the local resource dictionary. (Inherited from VisualElement) |
ReturnCommand |
Gets or sets the command to run when the user presses the return key, either physically or on the on-screen keyboard. This is a bindable property. |
ReturnCommandParameter |
Gets or sets the parameter object for the ReturnCommand that can be used to provide extra information. This is a bindable property. |
ReturnType |
Determines what the return key on the on-screen keyboard should look like. This is a bindable property. |
Rotation |
Gets or sets the rotation (in degrees) about the Z-axis (affine rotation) when the element is rendered. (Inherited from VisualElement) |
RotationX |
Gets or sets the rotation (in degrees) about the X-axis (perspective rotation) when the element is rendered. (Inherited from VisualElement) |
RotationY |
Gets or sets the rotation (in degrees) about the Y-axis (perspective rotation) when the element is rendered. (Inherited from VisualElement) |
Scale |
Gets or sets the scale factor applied to the element. (Inherited from VisualElement) |
ScaleX |
Gets or sets a scale value to apply to the X direction. (Inherited from VisualElement) |
ScaleY |
Gets or sets a scale value to apply to the Y direction. (Inherited from VisualElement) |
SelectionLength |
Gets or sets the length of the selection. The selection will start at CursorPosition. This is a bindable property. |
Shadow | (Inherited from VisualElement) |
Style | (Inherited from NavigableElement) |
StyleClass | (Inherited from NavigableElement) |
StyleId |
Gets or sets a user defined value to uniquely identify the element. (Inherited from Element) |
Text |
Gets or sets the text of the input view. This is a bindable property. (Inherited from InputView) |
TextColor |
Gets or sets the text color. (Inherited from InputView) |
TextTransform | (Inherited from InputView) |
TranslationX |
Gets or sets the X translation delta of the element. (Inherited from VisualElement) |
TranslationY |
Gets or sets the Y translation delta of the element. (Inherited from VisualElement) |
Triggers |
Gets the list of Trigger associated to this element. This is a bindable property. (Inherited from VisualElement) |
VerticalOptions |
Gets or sets the LayoutOptions that define how the element gets laid in a layout cycle. This is a bindable property. (Inherited from View) |
VerticalTextAlignment |
Gets or sets the vertical text alignment. This is a bindable property. |
Visual | (Inherited from VisualElement) |
Width |
Gets the current rendered width of this element. This is a read-only bindable property. (Inherited from VisualElement) |
WidthRequest |
Gets or sets the desired width override of this element. (Inherited from VisualElement) |
Window | (Inherited from VisualElement) |
X |
Gets the current X position of this element. This is a read-only bindable property. (Inherited from VisualElement) |
Y |
Gets the current Y position of this element. This is a read-only bindable property. (Inherited from VisualElement) |
ZIndex | (Inherited from VisualElement) |
Methods
ApplyBindings() | (Inherited from BindableObject) |
Arrange(Rect) | (Inherited from VisualElement) |
ArrangeOverride(Rect) | (Inherited from VisualElement) |
BatchBegin() |
Signals the start of a batch of changes to the elements properties. (Inherited from VisualElement) |
BatchCommit() |
Signals the end of a batch of commands to the element and that those commands should now be committed. (Inherited from VisualElement) |
ChangeVisualState() | (Inherited from VisualElement) |
ClearValue(BindableProperty) |
Clears any value set by SetValue for |
ClearValue(BindablePropertyKey) |
Clears any value set by SetValue for the property that is identified by |
CoerceValue(BindableProperty) | (Inherited from BindableObject) |
CoerceValue(BindablePropertyKey) | (Inherited from BindableObject) |
EffectIsAttached(String) |
For internal use by the Microsoft.Maui.Controls platform. (Inherited from Element) |
FindByName(String) |
Returns the element that has the specified name. (Inherited from Element) |
Focus() |
Attemps to set focus to this element. (Inherited from VisualElement) |
GetChildElements(Point) |
Returns the child elements that are visually beneath the specified |
GetRendererOverrides<T>() | (Inherited from View) |
GetValue(BindableProperty) |
Returns the value that is contained in the BindableProperty. (Inherited from BindableObject) |
InvalidateMeasure() | (Inherited from VisualElement) |
InvalidateMeasureNonVirtual(InvalidationTrigger) |
For internal use by the Microsoft.Maui.Controls platform. (Inherited from VisualElement) |
InvalidateMeasureOverride() | (Inherited from VisualElement) |
IsSet(BindableProperty) |
Returns |
Layout(Rect) |
Updates the bounds of the element during the layout cycle. (Inherited from VisualElement) |
MapText(EntryHandler, Entry) | |
MapText(IEntryHandler, Entry) | |
Measure(Double, Double, MeasureFlags) |
Returns the minimum size that a visual element needs in order to be displayed on the device. (Inherited from VisualElement) |
MeasureOverride(Double, Double) | (Inherited from VisualElement) |
On<T>() |
Returns the platform-specific instance of this |
OnBindingContextChanged() | (Inherited from View) |
OnChildAdded(Element) | (Inherited from VisualElement) |
OnChildRemoved(Element, Int32) | (Inherited from VisualElement) |
OnChildrenReordered() | (Inherited from VisualElement) |
OnHandlerChanged() | (Inherited from Element) |
OnHandlerChanging(HandlerChangingEventArgs) | (Inherited from Element) |
OnMeasure(Double, Double) | (Inherited from VisualElement) |
OnParentChanged() | (Inherited from Element) |
OnParentChanging(ParentChangingEventArgs) | (Inherited from Element) |
OnParentSet() | (Inherited from NavigableElement) |
OnPropertyChanged(String) | (Inherited from Element) |
OnPropertyChanging(String) | (Inherited from BindableObject) |
OnSizeAllocated(Double, Double) | (Inherited from VisualElement) |
OnTextChanged(String, String) | (Inherited from InputView) |
OnTextTransformChanged(TextTransform, TextTransform) | (Inherited from InputView) |
PlatformSizeChanged() | (Inherited from VisualElement) |
RemoveBinding(BindableProperty) |
Removes a previously set binding. (Inherited from BindableObject) |
RemoveDynamicResource(BindableProperty) |
Removes a previously set dynamic resource (Inherited from Element) |
SendCompleted() |
Internal method to trigger Completed and ReturnCommand. Should not be called manually outside of .NET MAUI. |
SetBinding(BindableProperty, BindingBase) |
Assigns a binding to a property. (Inherited from BindableObject) |
SetDynamicResource(BindableProperty, String) |
Sets the BindableProperty property of this element to be updated via the DynamicResource with the provided key. (Inherited from Element) |
SetValue(BindableProperty, Object) |
Sets the value of the specified property. (Inherited from BindableObject) |
SetValue(BindablePropertyKey, Object) |
Sets the value of the propertyKey. (Inherited from BindableObject) |
SetValueCore(BindableProperty, Object, SetValueFlags) |
For internal use by the Microsoft.Maui.Controls platform. (Inherited from BindableObject) |
SetValueFromRenderer(BindableProperty, Object) |
For internal use by the Microsoft.Maui.Controls platform. (Inherited from Element) |
SetValueFromRenderer(BindablePropertyKey, Object) |
For internal use by the Microsoft.Maui.Controls platform. (Inherited from Element) |
SizeAllocated(Double, Double) | (Inherited from VisualElement) |
UnapplyBindings() | (Inherited from BindableObject) |
Unfocus() |
Unsets focus to this element. (Inherited from VisualElement) |
UpdateFormsText(String, TextTransform) | (Inherited from InputView) |
Events
BatchCommitted | (Inherited from VisualElement) |
BindingContextChanged | (Inherited from BindableObject) |
ChildAdded | (Inherited from Element) |
ChildRemoved | (Inherited from Element) |
ChildrenReordered | (Inherited from VisualElement) |
Completed |
Occurs when the user finalizes the text in an entry with the return key. |
DescendantAdded | (Inherited from Element) |
DescendantRemoved | (Inherited from Element) |
FocusChangeRequested | (Inherited from VisualElement) |
Focused | (Inherited from VisualElement) |
HandlerChanged | (Inherited from Element) |
HandlerChanging | (Inherited from Element) |
Loaded |
Occurs when a VisualElement has been constructed and added to the object tree. This event may occur before the VisualElement has been measured so should not be relied on for size information. (Inherited from VisualElement) |
MeasureInvalidated | (Inherited from VisualElement) |
ParentChanged | (Inherited from Element) |
ParentChanging | (Inherited from Element) |
PropertyChanged | (Inherited from BindableObject) |
PropertyChanging | (Inherited from BindableObject) |
SizeChanged | (Inherited from VisualElement) |
TextChanged | (Inherited from InputView) |
Unfocused | (Inherited from VisualElement) |
Unloaded |
Occurs when this VisualElement is no longer connected to the main object tree. (Inherited from VisualElement) |
Explicit Interface Implementations
Extension Methods
AbortAnimation(IAnimatable, String) |
Stops the animation. |
Animate(IAnimatable, String, Animation, UInt32, UInt32, Easing, Action<Double,Boolean>, Func<Boolean>) |
Sets the specified parameters and starts the animation. |
Animate(IAnimatable, String, Action<Double>, Double, Double, UInt32, UInt32, Easing, Action<Double,Boolean>, Func<Boolean>) |
Sets the specified parameters and starts the animation. |
Animate(IAnimatable, String, Action<Double>, UInt32, UInt32, Easing, Action<Double,Boolean>, Func<Boolean>) |
Sets the specified parameters and starts the animation. |
Animate<T>(IAnimatable, String, Func<Double,T>, Action<T>, UInt32, UInt32, Easing, Action<T,Boolean>, Func<Boolean>, IAnimationManager) |
Sets the specified parameters and starts the animation. |
AnimateKinetic(IAnimatable, String, Func<Double,Double,Boolean>, Double, Double, Action, IAnimationManager) |
Sets the specified parameters and starts the kinetic animation. |
AnimationIsRunning(IAnimatable, String) |
Returns a Boolean value that indicates whether or not the animation that is specified by |
Batch(IAnimatable) | |
GetPropertyIfSet<T>(BindableObject, BindableProperty, T) | |
SetAppTheme<T>(BindableObject, BindableProperty, T, T) | |
SetAppThemeColor(BindableObject, BindableProperty, Color, Color) | |
SetBinding(BindableObject, BindableProperty, String, BindingMode, IValueConverter, String) |
Creates and applies a binding to a property. |
ToFont(IFontElement, Nullable<Double>) | |
FindByName<T>(Element, String) | |
CancelAnimations(VisualElement) |
Aborts all animations (e.g. |
FadeTo(VisualElement, Double, UInt32, Easing) |
Returns a task that performs the fade that is described by the |
LayoutTo(VisualElement, Rect, UInt32, Easing) |
view
to the rectangle that is specified by the bounds parameter. |
RelRotateTo(VisualElement, Double, UInt32, Easing) |
Rotates the VisualElement that is specified by |
RelScaleTo(VisualElement, Double, UInt32, Easing) |
Returns a task that scales the VisualElement that is specified by |
RotateTo(VisualElement, Double, UInt32, Easing) |
Returns a task that rotates the VisualElement that is specified by |
RotateXTo(VisualElement, Double, UInt32, Easing) |
Returns a task that skews the X axis of the the VisualElement that is specified by |
RotateYTo(VisualElement, Double, UInt32, Easing) |
Returns a task that skews the Y axis of the the VisualElement that is specified by |
ScaleTo(VisualElement, Double, UInt32, Easing) |
Returns a task that scales the VisualElement that is specified by |
ScaleXTo(VisualElement, Double, UInt32, Easing) |
Returns a task that scales the X axis of the the VisualElement that is specified by |
ScaleYTo(VisualElement, Double, UInt32, Easing) |
Returns a task that scales the Y axis of the the VisualElement that is specified by |
TranslateTo(VisualElement, Double, Double, UInt32, Easing) |
Animates an elements TranslationX and TranslationY properties from their current values to the new values. This ensures that the input layout is in the same position as the visual layout. |
HasVisualStateGroups(VisualElement) |
Returns |
CheckHandlers(IView) | |
UpdateText(ITextInput, String) | |
ComputeDesiredSize(IView, Double, Double) | |
ComputeFrame(IView, Rect) | |
ToHandler(IElement, IMauiContext) | |
ToPlatform(IElement, IMauiContext) | |
ToHandler(IView, IMauiContext) | |
SetSemanticFocus(IView) | |
CaptureAsync(IView) | |
GetVisualElementWindow(IVisualTreeElement) |
Gets the Window containing the Visual Tree Element, if the element is contained within one. |
GetVisualTreeDescendants(IVisualTreeElement) |
Gets the entire hierarchy of descendants as a list of children for a given Visual Tree Element. |
GetVisualTreeElements(IVisualTreeElement, Point) |
Gets list of a Visual Tree Element's children based off of a given Point. |
GetVisualTreeElements(IVisualTreeElement, Rect) |
Gets list of a Visual Tree Elements children based off of a rectangle. |
GetVisualTreeElements(IVisualTreeElement, Double, Double) |
Gets list of a Visual Tree Elements children based off of a given x, y point. |
GetVisualTreeElements(IVisualTreeElement, Double, Double, Double, Double) |
Gets list of a Visual Tree Elements children based off of a rectangle defined by its coordinates which are specified in platform units, not pixels. |