[All] Bindable span #1850

adamped · 2018-02-09T08:11:33Z

Description of Change

This allows Text to be Bindable on a Span.
It also added the Style property to the Span, to set the Font Elements.

fixes #1340

Bugs Fixed

N/A

API Changes

Added:

TextColor { get; set; } // Bindable Property

Marked Obsolete:

ForegroundColor { get; set; }
ForegroundColor now just updates TextColor

Behavioral Changes

N/A

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

adamped · 2018-02-10T01:00:55Z

Xamarin.Forms.Core/MergedStyle.cs

@@ -5,163 +5,160 @@

 namespace Xamarin.Forms
 {
-	public partial class VisualElement
+	sealed class MergedStyle : IStyle


All I did here was remove the public partial class VisualElement line.

Didn't make any formatting changes, Github just thinks its all different.

adamped · 2018-02-10T01:01:48Z

Xamarin.Forms.Core/Label.cs

+				{
+					var formattedString = (FormattedString)newvalue;
+					formattedString.PropertyChanged += ((Label)bindable).OnFormattedTextChanged;
+					SetInheritedBindingContext(formattedString, bindable.BindingContext);


Changes the BindingContext when it is updated on the Label.

adamped · 2018-02-10T01:02:18Z

Xamarin.Forms.Core/FormattedString.cs

+		{
+			base.OnBindingContextChanged();
+			for (int i = 0; i < Spans.Count; i++)
+				SetInheritedBindingContext(Spans[i], BindingContext);


Sets BindingContext of Spans when the FormattedText BindingContext changes

adamped · 2018-02-10T01:03:03Z

Xamarin.Forms.Controls/CoreGalleryPages/LabelCoreGalleryPage.cs

-			formattedString.Spans.Add (new Span { BackgroundColor = Color.Red, ForegroundColor = Color.Olive, Text = "Span 1 " });
-			formattedString.Spans.Add (new Span { BackgroundColor = Color.Black, ForegroundColor = Color.White, Text = "Span 2 " });
-			formattedString.Spans.Add (new Span { BackgroundColor = Color.Pink, ForegroundColor = Color.Purple, Text = "Span 3" });
+			formattedString.Spans.Add (new Span { BackgroundColor = Color.Red, TextColor = Color.Olive, Text = "Span 1 " });


These are changed because the ForegroundColor is now obsolete, as per Stephane's request.

adamped · 2018-02-10T01:04:08Z

Xamarin.Forms.Core/Span.cs

-			set { _fontElement.SetValue(FontElement.FontProperty, value); }
+		public static readonly BindableProperty TextColorProperty = TextElement.TextColorProperty;
+
+		public Color TextColor


TextColor property now used, to align with rest of XF framework, from ITextElement interface.

jassmith

Looks pretty good, there are plenty of places where double GetValue calls occur but those were there in the past too. If you want to go the extra mile and clean those up, great, otherwise its nowhere near a blocker.

jassmith · 2018-02-16T04:10:49Z

Im wondering if it might make sense to have all the bindings in here be OneTime by default. I doubt that generally speaking spans need dynamic binding and OneTime bindings are much cheaper. We have an opportunity here to make things fast by default in this area at least, even if we cant change it elsewhere.

StephaneDelcroix

It looks good, but I think that, as the Parent/Children concept is missing, you won't be able to apply css styles, dynamic resources, ...

I can look at that when I have a few minutes, but in the mean time, do not merge this PR

jassmith · 2018-02-16T19:13:25Z

Thats a really good point stephane. At the bare minimum the Parent will need to be set on the BindableSpan.

adamped · 2018-02-17T03:39:22Z

@StephaneDelcroix - I set the parent going down. The FormattedText was changed to inherit from Element, then parent set, and Parent set on all Spans.

@jassmith - I assume the GetValue multiple calls was the Text property is called a lot of times, I made minor changes to reduce the number of calls. Down to 1 on iOS and UWP. Down to 2 from 4 on Android.

As for OneTime bindings, I didn't know they existed. How would you implement them?

jassmith · 2018-02-17T05:57:34Z

Just set the default binding mode on the BindableProperty to be OneTime instead of not specifying it (which defaults to OneWay).

adamped · 2018-02-17T06:48:11Z

@jassmith - ok, added them. BindingMode.OneTime was only added 10 days ago, so I needed to rebase. Didn't know OneTime binding was available.

jassmith · 2018-02-17T07:03:52Z

Yeah its new :)

jassmith · 2018-02-18T10:02:46Z

Xamarin.Forms.Core/BindableProperty.cs

@@ -66,7 +66,7 @@ public sealed class BindableProperty
 				throw new ArgumentNullException("declaringType");

 			// don't use Enum.IsDefined as its redonkulously expensive for what it does
-			if (defaultBindingMode != BindingMode.Default && defaultBindingMode != BindingMode.OneWay && defaultBindingMode != BindingMode.OneWayToSource && defaultBindingMode != BindingMode.TwoWay)
+			if (defaultBindingMode != BindingMode.Default && defaultBindingMode != BindingMode.OneWay && defaultBindingMode != BindingMode.OneWayToSource && defaultBindingMode != BindingMode.TwoWay && defaultBindingMode != BindingMode.OneTime)


smartprogrammer93 · 2018-03-04T20:11:07Z

Any Updates on this?
It's really needed

Thank you @adamped for your work

jassmith · 2018-03-06T00:50:10Z

build

samhouts · 2018-03-06T01:00:57Z

Xamarin.Forms.Core/Span.cs

 		}

+		[Obsolete("Foreground is obsolete as of version 2.6.0. Please use the TextColor property instead.")]


We'll want to change this (and probably others in the repo) to 3.0.0 at some point).

samhouts · 2018-03-06T01:01:19Z

Xamarin.Forms.Platform.GTK/Extensions/LabelExtensions.cs

@@ -56,9 +56,9 @@ private static string GenerateMarkupText(Span span)
            }

            // ForegroundColor => 


obsolete comment

rmarinho · 2018-03-06T12:33:21Z

Build is failing related to docs issues

adamped · 2018-03-07T13:51:42Z

@rmarinho @jassmith - I updated the docs. Hopefully it works this time.

rmarinho · 2018-03-07T14:13:58Z

@adamped passed docs! thanks

jassmith · 2018-03-07T18:53:55Z

Good I want to get this in

alanag13 · 2018-03-07T18:59:06Z

@jassmith me too, underlines are a big deal

StephaneDelcroix · 2018-03-08T14:44:47Z

This is unlikely styleable using either Style or CSS as FromattedStrings and Spans aren't VisualElement.

@adamped: you don't have to act on this comment, I need to discuss how to fix this with @jassmith

adamped · 2018-03-08T22:27:04Z

@StephaneDelcroix - Styles work, I even have a unit test for it. Haven't tested on XAML with a Style though, but in code it works.

CSS I haven't tried. Haven't tested merged styles either.

jassmith · 2018-03-08T23:50:25Z

In she goes! Congratulations adam, this is a major feature!

adamped · 2018-03-08T23:59:44Z

Awesome, thanks @jassmith

Will forge ahead with tappable spans now, have slowly been working on them, will be ready for another review soon.

jassmith · 2018-03-09T00:14:09Z

excellent

floriankick · 2018-04-23T14:18:28Z

I love this feature! When will this come to nuget?

smartprogrammer93 · 2018-04-23T14:30:05Z

@findus

You can get it now on the nightly build.

From the xamarin nightly repository.

VincentH-Net · 2018-05-19T08:56:47Z

@adamped This is great. I'm really interested in tappable spans, do you still plan on implementing that? Eta? Thx!

adamped · 2018-05-19T09:10:13Z

@VincentH-Net - Its already implemented - #2173

rzihe · 2018-05-24T17:37:24Z

Really excited about this feature. Installed 3.1.0 pre release to test this out but I keep getting the following error: System.MissingFieldException: Field 'Xamarin.Forms.Span.TextProperty' not found.

My code is as followed:
<Label FontSize="Small" TextColor="Gray" > <Label.FormattedText> <FormattedString> <Span Text="{Binding User.Firstname}" FontAttributes="Bold" /> <Span Text="{Binding ResponseIsMatch}" /> <Span Text="{Binding Option.Title}" FontAttributes="Bold"/> </FormattedString> </Label.FormattedText> </Label>
what am I missing?

rmarinho requested review from jassmith and StephaneDelcroix February 9, 2018 10:25

rmarinho added t/enhancement ➕ F100 labels Feb 9, 2018

samhouts changed the title ~~Feature/1340 bindable span~~ [All] Bindable span Feb 9, 2018

samhouts added the community-sprint label Feb 9, 2018

samhouts added this to Ready in v3.1.0 via automation Feb 9, 2018

samhouts moved this from Ready to In Review in v3.1.0 Feb 9, 2018

adamped mentioned this pull request Feb 10, 2018

Feature/1340 bindable span XamarinFormsCommunity/Xamarin.Forms#4

Closed

4 tasks

adamped commented Feb 10, 2018

View reviewed changes

samhouts added this to In Progress in Enhancements Feb 12, 2018

adamped mentioned this pull request Feb 14, 2018

Feature/1701 Span GestureRecognizers XamarinFormsCommunity/Xamarin.Forms#8

Open

4 tasks

jassmith approved these changes Feb 15, 2018

View reviewed changes

StephaneDelcroix suggested changes Feb 16, 2018

View reviewed changes

StephaneDelcroix added the DO-NOT-MERGE-!!! 🛑 This is in progress and needs to be updated before it can be merged. label Feb 16, 2018

adamped force-pushed the feature/1340-bindable-span branch from f5d8a4c to 5b9546d Compare February 17, 2018 06:44

jassmith reviewed Feb 18, 2018

View reviewed changes

This was referenced Feb 18, 2018

Feature/1632 label underline strike XamarinFormsCommunity/Xamarin.Forms#9

Closed

[Enhancement] Label underline/strikethrough support #1632

Closed

samhouts moved this from In Review to In Progress in v3.1.0 Feb 20, 2018

samhouts approved these changes Mar 6, 2018

View reviewed changes

Updated docs

de65c91

jassmith merged commit e42bd62 into xamarin:master Mar 8, 2018

v3.1.0 automation moved this from In Progress to Done Mar 8, 2018

Enhancements automation moved this from In Progress to Done Mar 8, 2018

samhouts removed the DO-NOT-MERGE-!!! 🛑 This is in progress and needs to be updated before it can be merged. label Mar 23, 2018

smartprogrammer93 mentioned this pull request Mar 24, 2018

Span Binding not updating even after OnPropertyChanged #2177

Closed

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

jerone mentioned this pull request Apr 8, 2018

[Enhancement] Bindable Span #1340

Closed

samhouts added this to the 3.1.0 milestone May 5, 2018

adamped deleted the feature/1340-bindable-span branch May 19, 2018 09:10

samhouts modified the milestone: 3.1.0 Jun 1, 2018

samhouts removed this from Done in Enhancements Jun 12, 2018

StephaneDelcroix mentioned this pull request Jun 19, 2018

Exception when creating BindableProperty with BindingMode.OneTime #3071

Closed

Keboo mentioned this pull request Jun 27, 2018

Proposal: Change default binding mode of Span Text property to OneWay #3167

Closed

eddie010 mentioned this pull request Aug 16, 2018

Span does not have bindable property 'GestureRecognizers' #3586

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[All] Bindable span #1850

[All] Bindable span #1850

adamped commented Feb 9, 2018 •

edited by samhouts

adamped Feb 10, 2018

adamped Feb 10, 2018

adamped Feb 10, 2018

adamped Feb 10, 2018

adamped Feb 10, 2018

jassmith left a comment

jassmith commented Feb 16, 2018

StephaneDelcroix left a comment

jassmith commented Feb 16, 2018

adamped commented Feb 17, 2018

jassmith commented Feb 17, 2018

adamped commented Feb 17, 2018 •

edited

jassmith commented Feb 17, 2018

jassmith Feb 18, 2018

smartprogrammer93 commented Mar 4, 2018

jassmith commented Mar 6, 2018

samhouts Mar 6, 2018

samhouts Mar 6, 2018

rmarinho commented Mar 6, 2018

adamped commented Mar 7, 2018 •

edited

rmarinho commented Mar 7, 2018

jassmith commented Mar 7, 2018

alanag13 commented Mar 7, 2018

StephaneDelcroix commented Mar 8, 2018

adamped commented Mar 8, 2018 •

edited

jassmith commented Mar 8, 2018

adamped commented Mar 8, 2018

jassmith commented Mar 9, 2018

floriankick commented Apr 23, 2018

smartprogrammer93 commented Apr 23, 2018

VincentH-Net commented May 19, 2018

adamped commented May 19, 2018

rzihe commented May 24, 2018

		}

		[Obsolete("Foreground is obsolete as of version 2.6.0. Please use the TextColor property instead.")]

		@@ -56,9 +56,9 @@ private static string GenerateMarkupText(Span span)
		}

		// ForegroundColor =>

[All] Bindable span #1850

[All] Bindable span #1850

Conversation

adamped commented Feb 9, 2018 • edited by samhouts

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

Choose a reason for hiding this comment

jassmith left a comment

Choose a reason for hiding this comment

jassmith commented Feb 16, 2018

StephaneDelcroix left a comment

Choose a reason for hiding this comment

jassmith commented Feb 16, 2018

adamped commented Feb 17, 2018

jassmith commented Feb 17, 2018

adamped commented Feb 17, 2018 • edited

jassmith commented Feb 17, 2018

Choose a reason for hiding this comment

smartprogrammer93 commented Mar 4, 2018

jassmith commented Mar 6, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rmarinho commented Mar 6, 2018

adamped commented Mar 7, 2018 • edited

rmarinho commented Mar 7, 2018

jassmith commented Mar 7, 2018

alanag13 commented Mar 7, 2018

StephaneDelcroix commented Mar 8, 2018

adamped commented Mar 8, 2018 • edited

jassmith commented Mar 8, 2018

adamped commented Mar 8, 2018

jassmith commented Mar 9, 2018

floriankick commented Apr 23, 2018

smartprogrammer93 commented Apr 23, 2018

VincentH-Net commented May 19, 2018

adamped commented May 19, 2018

rzihe commented May 24, 2018

adamped commented Feb 9, 2018 •

edited by samhouts

adamped commented Feb 17, 2018 •

edited

adamped commented Mar 7, 2018 •

edited

adamped commented Mar 8, 2018 •

edited