Implemented MaxLength property on Entry and Editor #1880

jfversluis · 2018-02-14T08:11:31Z

Description of Change

Implementation of MaxLength on both the Entry as well as the Editor (by implementing it on the InputView) for all platforms supported today. Fixes #1663.

No unit tests have been added since I would just be testing the getter/setter of the property.

Bugs Fixed

N/A

API Changes

Added:

static BindableProperty InputView.MaxLengthProperty;
int InputView.MaxLength { get; set; } //Bindable Property, default value int.MaxValue

Behavioral Changes

There shouldn't be any behavioral changes by just upgrading. But they now have the ability to limit the input length of the Editor and Entry controls.

PR Checklist

Has tests (if omitted, state reason in description)
Rebased on top of master at time of PR
Changes adhere to coding standard
Consolidate commits as makes sense

This reverts commit e17a662.

Added MaxLength property on InputView and implemented iOS and Android Entry and Android Editor

First check to see if there is a LengthFilter in there already and remove that first

Except GTK, seems everything is spaces there, so kept it for consistency

StephaneDelcroix · 2018-02-14T21:23:15Z

Xamarin.Forms.Core/InputView.cs

@@ -5,6 +5,14 @@ public class InputView : View
 		public static readonly BindableProperty KeyboardProperty = BindableProperty.Create("Keyboard", typeof(Keyboard), typeof(InputView), Keyboard.Default,
 			coerceValue: (o, v) => (Keyboard)v ?? Keyboard.Default);

+        public static readonly BindableProperty MaxLengthProperty = BindableProperty.Create("MaxLength", typeof(int), typeof(int), int.MaxValue);


I'd use -1 as default value

use nameof(MaxLength)

we usually use tabs for indentation

In the #1663 we sort of decided to go with int.MaxValue. What would be the benefit of using -1?
Fixed nameof and tabs.

I'll discuss the defaultValue with @hartez. both are fine, both make sense. But having Int32.MaxValue prevents us from having a really long text in, while -1 does not.

StephaneDelcroix · 2018-02-14T21:27:23Z

Xamarin.Forms.Platform.iOS/Renderers/EditorRenderer.cs

@@ -60,6 +62,7 @@ protected override void OnElementChanged(ElementChangedEventArgs<Editor> e)
 				Control.Changed += HandleChanged;
 				Control.Started += OnStarted;
 				Control.Ended += OnEnded;
+                Control.ShouldChangeText += ShouldChangeText;


it looks like you do not do anything on property change

Not sure what you mean here. The event is hooked up? If you mean that I don't act on the MaxLength being changed you're right. Wasn't sure what to do with that. The logical thing to do would be to cut off the current value if its length exceeds the new MaxLength value?

The logical thing to do would be to cut off the current value if its length exceeds the new MaxLength value

that's what I'd do

Definitely makes sense, implemented it

…lue length

rmarinho · 2018-02-15T11:11:27Z

@jfversluis the build is failing in the Tizen platform

Xamarin.Forms.Platform.Tizen\Renderers\EditorRenderer.cs (31, 31)
Xamarin.Forms.Platform.Tizen\Renderers\EditorRenderer.cs(31,31): Error CS1503: Argument 1: cannot convert from 'method group' to 'Func<Entry, string, string>'

jfversluis · 2018-02-15T19:13:59Z

@rmarinho should be resolved now

jassmith · 2018-02-15T20:14:20Z

Xamarin.Forms.Controls/CoreGalleryPages/EditorCoreGalleryPage.cs

@@ -35,6 +35,9 @@ protected override void Build (StackLayout stackLayout)
 			var textColorDisabledContainer = new ViewContainer<Editor> (Test.Editor.TextColor,
 				new Editor { Text = "I should have the default disabled text color", TextColor = Color.Red, IsEnabled = false });

+			var maxLengthContainer = new ViewContainer<Editor>(Test.Editor.MaxLength,
+																new Editor { MaxLength = 3 });


Funky whitespace for fun and profit :)

jassmith · 2018-02-15T20:15:53Z

Xamarin.Forms.Platform.Android/Renderers/EditorRenderer.cs

+
+			Control?.SetFilters(currentFilters.ToArray());
+
+			if (Control?.Text.Length > Element.MaxLength)


You fetch Control.Text 3 times here. This causes 3 GetValue calls to be sent down to BindableObject. In this case it should be trivial to use a temporary variable to avoid that :)

jassmith · 2018-02-15T20:24:47Z

Xamarin.Forms.Platform.Android/Renderers/EntryRenderer.cs

+
+			Control?.SetFilters(currentFilters.ToArray());
+
+			if (Control?.Text.Length > Element.MaxLength)


GetValue calls here as well

jassmith · 2018-02-15T20:25:22Z

Xamarin.Forms.Platform.MacOS/Renderers/EditorRenderer.cs

+
+		void UpdateMaxLength()
+		{
+			if (Control?.StringValue?.Length > Element?.MaxLength)


Multiple calls to Control.StringValue again :)

jassmith · 2018-02-15T20:25:30Z

Xamarin.Forms.Platform.MacOS/Renderers/EntryRenderer.cs

+
+		void UpdateMaxLength()
+		{
+			if (Control?.StringValue?.Length > Element?.MaxLength)


jassmith · 2018-02-15T20:26:00Z

Xamarin.Forms.Platform.UAP/EditorRenderer.cs

+		{
+			Control.MaxLength = Element.MaxLength;
+
+			if (Control.Text.Length > Element.MaxLength)


jassmith · 2018-02-15T20:26:37Z

Xamarin.Forms.Platform.WPF/Renderers/EditorRenderer.cs

@@ -105,6 +108,14 @@ void UpdateTextColor()
 			Control.UpdateDependencyColor(System.Windows.Controls.Control.ForegroundProperty, Element.TextColor);
 		}

+		void UpdateMaxLength()
+		{
+			Control.MaxLength = Element.MaxLength;


Not going to call anymore of these out, but there are quite a few more :)

I think you got pretty much all of them? :P But thanks! Learning a lot here :)

Yeah its fun, just doing these little optimizations on our first pass once we realized this was a problem gave Forms a fairly sizeable performance boost. Now its about making sure we dont end up needing to do that again :)

jassmith · 2018-02-16T03:06:15Z

Scheduling builds now

jfversluis · 2018-02-16T06:23:04Z

That’s curious. Does anyone have details on the failing build?

rmarinho · 2018-02-16T10:32:41Z

@jfversluis is failing on docs, you need to generate the docs needed and commit also.

jfversluis · 2018-02-16T10:50:58Z

@rmarinho done!

rmarinho · 2018-02-16T14:51:17Z

docs/Xamarin.Forms.Core/Xamarin.Forms/Application.xml

@@ -451,9 +451,6 @@
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
-        <Attribute>


no need to commit this, build in Debug, then generate docs

@rmarinho I'm not sure what went wrong..? Rebuild the whole solution in Debug and then commit the results? Or what am I supposed to do here?

rmarinho · 2018-02-16T14:51:52Z

docs/Xamarin.Forms.Core/Xamarin.Forms/NavigationPage.xml

@@ -512,9 +512,6 @@
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
-        <Attribute>


no need to commit this

rmarinho · 2018-02-16T14:52:05Z

docs/Xamarin.Forms.Core/index.xml

@@ -3,13 +3,13 @@
    <Assembly Name="Xamarin.Forms.Core" Version="2.0.0.0">
      <Attributes>
        <Attribute>


no need to commit this

rmarinho · 2018-02-16T14:52:33Z

docs/Xamarin.Forms.Maps/index.xml

@@ -3,13 +3,13 @@
    <Assembly Name="Xamarin.Forms.Maps" Version="2.0.0.0">
      <Attributes>
        <Attribute>
-          <AttributeName>System.Diagnostics.Debuggable(System.Diagnostics.DebuggableAttribute+DebuggingModes.Default | System.Diagnostics.DebuggableAttribute+DebuggingModes.DisableOptimizations | System.Diagnostics.DebuggableAttribute+DebuggingModes.EnableEditAndContinue | System.Diagnostics.DebuggableAttribute+DebuggingModes.IgnoreSymbolStoreSequencePoints)</AttributeName>


No need to commit this or the others similar

This reverts commit 416e287.

jfversluis · 2018-02-16T16:09:46Z

@rmarinho better like this? :)

jfversluis · 2018-02-19T14:28:17Z

Is there anything I need to do for the failing UI tests?

rmarinho · 2018-02-19T17:15:06Z

@jfversluis no it's good

* 'master' of https://github.com/xamarin/Xamarin.Forms: (23 commits) [C] use direct cast [Core, iOS, Android, UWP, WPF] Hide scroll view scroll bars (xamarin#1910) Allow users to specify resolution method for handlers, effects, and services (xamarin#1870) fixes xamarin#1739 [Build] Update submodule Capitalization keyboard flag additions for Entry/Editor (xamarin#1683) (xamarin#1833) [Build] Don't specify .net sdk version Simplify event raising invocation pattern (xamarin#1971) [iOS Maps] Pin rendering customization (xamarin#1065) set csharp_space_after_keywords_in_control_flow_statements to true to fit our design guide lines (xamarin#1964) [iOS] Add shadow effect (xamarin#1896) Added support for ListView full width separators on iOS (xamarin#1854) fixes xamarin#1665 Support CascadeInputTransparent to Tizen (xamarin#1916) [Android]?Remove UserVisibleHint (xamarin#1550) fixes xamarin#1438 [iOS] ViewDidLayoutSubviews after removing page (xamarin#1532) fixes xamarin#1426 Use relative URL to support recursive checkout in VSTS (xamarin#1926) [UITest] Fix test for UITest package update (xamarin#1923) Implemented MaxLength property on Entry and Editor (xamarin#1880) [Build]Fix master and build (xamarin#1920) [Build] Fix windows cert Fix to absolute URL ... # Conflicts: # Xamarin.Forms.Controls/CoreGalleryPages/EditorCoreGalleryPage.cs # Xamarin.Forms.Controls/CoreGalleryPages/EntryCoreGalleryPage.cs # Xamarin.Forms.Core/InputView.cs # Xamarin.Forms.CustomAttributes/TestAttributes.cs # Xamarin.Forms.Platform.Android/Renderers/EditorRenderer.cs # Xamarin.Forms.Platform.Android/Renderers/EntryRenderer.cs # Xamarin.Forms.Platform.MacOS/Renderers/EditorRenderer.cs # Xamarin.Forms.Platform.MacOS/Renderers/EntryRenderer.cs # Xamarin.Forms.Platform.Tizen/Renderers/EditorRenderer.cs # Xamarin.Forms.Platform.Tizen/Renderers/EntryRenderer.cs # Xamarin.Forms.Platform.WPF/Renderers/EditorRenderer.cs # Xamarin.Forms.Platform.WPF/Renderers/EntryRenderer.cs # Xamarin.Forms.Platform.iOS/Renderers/EditorRenderer.cs # Xamarin.Forms.Platform.iOS/Renderers/EntryRenderer.cs

jfversluis and others added 16 commits February 6, 2018 22:53

Implemented UAP and WPF

cd6585f

Revert "Implemented UAP and WPF"

b02f8a8

This reverts commit e17a662.

Started implementation of xamarin#1663

2ab7fb4

Added MaxLength property on InputView and implemented iOS and Android Entry and Android Editor

Implemented iOS Editor

6e44c7c

Improved Android MaxLength

4c75dfd

First check to see if there is a LengthFilter in there already and remove that first

Implemented GTK naming enhancement for iOS

c2301aa

Implemented UAP and WPF

c9283bc

Implemented Tizen

87d5a03

Removed Linq and implemented forgotten method 😅

1af5e74

Fixed whitespaces -> tabs

1d002b9

Except GTK, seems everything is spaces there, so kept it for consistency

Added null guard for iOS

47560bd

Implemented Mac OS

43eacf0

Added samples to gallery

c037575

Polished Tizen implementation

07ad020

Tizen EditorRenderer updated and converted more whitespaces to tabs

d919eba

Merge branch 'master' into feature/1663-entry-maxlength

947699f

samhouts added t/enhancement ➕ F100 community-sprint labels Feb 14, 2018

samhouts requested review from jassmith and PureWeen February 14, 2018 18:29

StephaneDelcroix reviewed Feb 14, 2018

View reviewed changes

jfversluis added 2 commits February 15, 2018 08:45

Fixed spaces to tabs and usage of nameof

c41f0ba

Added trimming of current text when MaxLength is less than current va…

8983dcc

…lue length

Reference right Entry for Tizen

a03182a

jfversluis added 2 commits February 15, 2018 21:19

Trimming on MaxLength change for Tizen

0263892

Trimming on MaxLength change for GTK

f5f7a26

jassmith suggested changes Feb 15, 2018

View reviewed changes

jfversluis added 2 commits February 15, 2018 22:36

Removed redundant GetValue calls and whitespace fiesta

da2a571

And the ones I missed

d78f007

jassmith approved these changes Feb 16, 2018

View reviewed changes

jfversluis and others added 2 commits February 16, 2018 11:49

Updated the docs

416e287

Merge branch 'master' into feature/1663-entry-maxlength

009272e

rmarinho suggested changes Feb 16, 2018

View reviewed changes

jfversluis added 2 commits February 16, 2018 17:04

Revert "Updated the docs"

3b3fc3a

This reverts commit 416e287.

Updated docs just for InputView

db6461a

rmarinho approved these changes Feb 19, 2018

View reviewed changes

jassmith merged commit 1f770f6 into xamarin:master Feb 19, 2018

jfversluis deleted the feature/1663-entry-maxlength branch February 19, 2018 22:30

samhouts added the API-change Heads-up to reviewers that this PR may contain an API change label Apr 3, 2018

samhouts added this to the 3.0.0 milestone May 5, 2018

samhouts modified the milestones: 3.0.0, 2.5.0 Oct 29, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implemented MaxLength property on Entry and Editor #1880

Implemented MaxLength property on Entry and Editor #1880

jfversluis commented Feb 14, 2018 •

edited by samhouts

Loading

StephaneDelcroix Feb 14, 2018

StephaneDelcroix Feb 14, 2018

StephaneDelcroix Feb 14, 2018

jfversluis Feb 15, 2018

StephaneDelcroix Feb 15, 2018 •

edited

Loading

StephaneDelcroix Feb 14, 2018

jfversluis Feb 15, 2018

StephaneDelcroix Feb 15, 2018 •

edited

Loading

jfversluis Feb 15, 2018

rmarinho commented Feb 15, 2018

jfversluis commented Feb 15, 2018

jassmith Feb 15, 2018

jassmith Feb 15, 2018

jassmith Feb 15, 2018

jassmith Feb 15, 2018

jassmith Feb 15, 2018

jassmith Feb 15, 2018

jassmith Feb 15, 2018

jfversluis Feb 15, 2018

jassmith Feb 16, 2018

jassmith commented Feb 16, 2018

jfversluis commented Feb 16, 2018

rmarinho commented Feb 16, 2018

jfversluis commented Feb 16, 2018

rmarinho Feb 16, 2018

jfversluis Feb 16, 2018

rmarinho Feb 16, 2018

rmarinho Feb 16, 2018

rmarinho Feb 16, 2018

jfversluis commented Feb 16, 2018

jfversluis commented Feb 19, 2018

rmarinho commented Feb 19, 2018


		Control?.SetFilters(currentFilters.ToArray());

		if (Control?.Text.Length > Element.MaxLength)

Implemented MaxLength property on Entry and Editor #1880

Implemented MaxLength property on Entry and Editor #1880

Conversation

jfversluis commented Feb 14, 2018 • edited by samhouts Loading

Description of Change

Bugs Fixed

API Changes

Behavioral Changes

PR Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

StephaneDelcroix Feb 15, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

StephaneDelcroix Feb 15, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rmarinho commented Feb 15, 2018

jfversluis commented Feb 15, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jassmith commented Feb 16, 2018

jfversluis commented Feb 16, 2018

rmarinho commented Feb 16, 2018

jfversluis commented Feb 16, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jfversluis commented Feb 16, 2018

jfversluis commented Feb 19, 2018

rmarinho commented Feb 19, 2018

jfversluis commented Feb 14, 2018 •

edited by samhouts

Loading

StephaneDelcroix Feb 15, 2018 •

edited

Loading

StephaneDelcroix Feb 15, 2018 •

edited

Loading