TextAlignment property added to NumberBox #2901

sonnemaf · 2020-07-14T12:13:15Z

The NumberBox was missing a TextAlignment property. Now it has one.

Description

I added the TextAlignment dependency property to the NumberBox. It needs testing and documentation. Don't know how to do this. Sorry.

Motivation and Context

Closes #1722

How Has This Been Tested?

Added two NumberBoxes to the test page with Center and Right TextAlignment.

marcelwgn · 2020-07-14T13:24:34Z

dev/NumberBox/NumberBox.xaml

@@ -1,14 +1,13 @@
-<!-- Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT License. See LICENSE in the project root for license information. -->
-<ResourceDictionary


Almost all of those changes are just formatting. Can you please revert the formatting changes?
With all these changes it is hard to review the actual new feature in question.

I just reverted the changes. I had XAML Styler running which moved things around. Sorry.

marcelwgn · 2020-07-14T13:27:15Z

dev/NumberBox/NumberBox.idl

@@ -60,6 +60,7 @@ unsealed runtimeclass NumberBox : Windows.UI.Xaml.Controls.Control
    String PlaceholderText;
    Windows.UI.Xaml.Controls.Primitives.FlyoutBase SelectionFlyout;
    Windows.UI.Xaml.Media.SolidColorBrush SelectionHighlightColor;
+    Windows.UI.Xaml.TextAlignment TextAlignment;


Posting previous comment here as this is more suitable in the IDL file.

I think this would technically go through API review first. @MikeHillberg Should this be marked as preview until then?

Yes, this should be reviewed and marked as preview because of an apparent mismatch between the documentation and the API behavior regarding the TextBox.HorizontalTextAlignment and TextBox.TextAlignment APIs.

@sonnemaf until this has an approved spec, you'll need to mark the API as preview, examples can been seen in some other IDL files in the repo

@sonnemaf For example here.

marcelwgn · 2020-07-14T13:29:01Z

You can add a test NumberBox which uses the TextAlignment property on the test page inside the NumberBox_TestUI project(which is under /dev/NumberBox), to verify that the changes work correctly.

@sonnemaf What kind of information would have helped you on the source code structure documentation to make it easier understanding the source code?

…s now Left. Also added the TextAlignment properties in the Test app.

sonnemaf · 2020-07-14T13:58:20Z

You can add a test NumberBox which uses the TextAlignment property on the test page inside the NumberBox_TestUI project(which is under /dev/NumberBox), to verify that the changes work correctly.

@sonnemaf What kind of information would have helped you on the source code structure documentation to make it easier understanding the source code?

The source code is quite clear (although I have no real experience in C++). I just couldn't find the test app. I found the MUXControlsTestApp app and I can now test the app.

Felix-Dev · 2020-07-14T14:09:37Z

For the API review: @MikeHillberg and I are currently looking at an apparent mismatch between the documentation and the API behavior regarding the TextBox.HorizontalTextAlignment and TextBox.TextAlignment APIs. This is relevant here because the naming of this API perhaps should be changed to NumberBox.HorizontalTextAlignment instead (depending on how the mismatch will be resolved).

MikeHillberg · 2020-07-14T15:29:48Z

A spec for this is a good place to have a discussion about those two alignment properties. Also the InputScope property.

StephenLPeters · 2020-07-15T23:22:45Z

@SavoySchuler FYI

StephenLPeters · 2020-07-16T23:01:57Z

dev/NumberBox/TestUI/NumberBoxPage.xaml

+                                        Value="456" />
+
+
+                    <controls:NumberBox x:Name="TestNumberBox"


Can you please add a Combo box which has the text alignment options as combo box items and selecting one of those will change the TestNumberBox's TextAlignment to the chosen value.

Great suggestion. Done!

Felix-Dev · 2020-07-17T10:19:01Z

dev/NumberBox/NumberBox.idl

@@ -60,7 +60,12 @@ unsealed runtimeclass NumberBox : Windows.UI.Xaml.Controls.Control
    String PlaceholderText;
    Windows.UI.Xaml.Controls.Primitives.FlyoutBase SelectionFlyout;
    Windows.UI.Xaml.Media.SolidColorBrush SelectionHighlightColor;
-    Windows.UI.Xaml.TextAlignment TextAlignment;
+
+    [WUXC_VERSION_PREVIEW]


You also need to include static Windows.UI.Xaml.DependencyProperty TextAlignmentProperty{ get; }; here.

Done, makes sense.

Felix-Dev · 2020-07-17T10:57:52Z

dev/Generated/NumberBox.properties.cpp

@@ -226,7 +226,7 @@ void NumberBoxProperties::EnsureProperties()
                winrt::name_of<winrt::TextAlignment>(),
                winrt::name_of<winrt::NumberBox>(),
                false /* isAttached */,
-                ValueHelper<winrt::TextAlignment>::BoxValueIfNecessary(winrt::TextAlignment::Left),


Why did you remove the default value? TextBox.TextAlignment/HorizontalTextAlignment uses TextAlignment::Left as their default value and we should pick the same default here.

To add a default value, you add the default value in the NumberBox .idl file by adding [MUX_DEFAULT_VALUE("winrt::TextAlignment::Left")] above the TextAlignment entry (you can find examples in the .idl file).

Agree with @Felix-Dev here, please set the default value to TextAlignment::Left.

Don't know what happened with the Default. It is now back to Left. Sorry...

@sonnemaf It appears to me you have manually edited the NumberBox.properties.cpp file to include the default value in commit dc9cef7. Since that file is auto-generated (for example whenever a new API is added to the NumberBox.idl file) manually added code will not persist here. In fact, I wouldn't be surprised if that was the reason the default value was removed in a previous commit (the file was probably automatically generated again and you committed that new version).

Instead, to specify a persisting default value for a public API, please add it to the .idl file like so:

[WUXC_VERSION_PREVIEW] { [MUX_DEFAULT_VALUE("winrt::TextAlignment::Left")] Windows.UI.Xaml.TextAlignment TextAlignment; }

This will generate the correct code whenever a new version of that file is automatically created. If you build WinUI after adding this code to the NumberBox.idl file and check the generated NumberBox.properties.cpp file, you will see the default value included as desired.

Yes I was editing the NumberBox.properties.cpp manually. I fixed it now using the MUX_DEFAULT_VALUE attribute in the .idl file. C++ is totally new for me. Thanks for your help.

marcelwgn · 2020-07-17T11:03:42Z

dev/NumberBox/TestUI/NumberBoxPage.xaml

-    xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
-    xmlns:contract5Present="http://schemas.microsoft.com/winfx/2006/xaml/presentation?IsApiContractPresent(Windows.Foundation.UniversalApiContract,5)"
-    mc:Ignorable="d">
+<!--  Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT License. See LICENSE in the project root for license information.  -->


A lot of these changes are only formatting, please revert them.

Sorry, XAML Styler was interfering again. Disabled it for now.

I have reverted the changes. I should be ok again.

I think you forgot to push that commit 😅

I'd also prefer the styling update to be a separate commit

In reply to: 456551014 [](ancestors = 456551014)

I forgot the Push 😒 and made now two separate commits 😊.

… marked as Preview

… TextAlignment default value using an attribute in the idl.

…nted the TextAlignment default value using an attribute in the idl." This reverts commit 2410590.

StephenLPeters · 2020-07-20T17:52:47Z

/azp run

azure-pipelines · 2020-07-20T17:52:58Z

Azure Pipelines successfully started running 1 pipeline(s).

StephenLPeters

StephenLPeters · 2020-07-21T22:17:44Z

@ranjeshj and @SavoySchuler I think the change looks good assuming the API does.

Felix-Dev · 2020-07-21T22:18:39Z

Should we also add an API test here? (based on the current implementation: verifying that setting this API sets the corresponding API on the TextBox - for which I assume tests exist to verify its correctness.)

ranjeshj · 2020-07-23T12:03:08Z

@ranjeshj and @SavoySchuler I think the change looks good assuming the API does.

I think its fine to merge as a preview API.

StephenLPeters · 2020-07-31T20:45:33Z

Should we also add an API test here? (based on the current implementation: verifying that setting this API sets the corresponding API on the TextBox - for which I assume tests exist to verify its correctness.)

I think this is a valid consideration. @sonnemaf do you have time to add a test?

StephenLPeters · 2020-08-04T18:17:33Z

Should we also add an API test here? (based on the current implementation: verifying that setting this API sets the corresponding API on the TextBox - for which I assume tests exist to verify its correctness.)

I think this is a valid consideration. @sonnemaf do you have time to add a test?

@sonnemaf Do you need help writing a tests?

StephenLPeters · 2020-08-10T19:41:21Z

/azp run

azure-pipelines · 2020-08-10T19:41:33Z

Azure Pipelines successfully started running 1 pipeline(s).

…l#2901)

TextAlignment property added

5e11e44

msft-github-bot added the needs-triage Issue needs to be triaged by the area owners label Jul 14, 2020

marcelwgn reviewed Jul 14, 2020

View reviewed changes

sonnemaf added 2 commits July 14, 2020 15:32

XAML Formatting reverted

d08f678

Fixed the invalid default value for TextAlignment. This was Center, i…

281db65

…s now Left. Also added the TextAlignment properties in the Test app.

StephenLPeters added area-NumberBox NumberBox Control team-Controls Issue for the Controls team and removed needs-triage Issue needs to be triaged by the area owners labels Jul 15, 2020

StephenLPeters reviewed Jul 16, 2020

View reviewed changes

sonnemaf added 2 commits July 17, 2020 11:27

TextAlignment combobox added to the NumberBoxPage for testing.

9b4223f

Marked TextAlignment as a Preview API in the IDL file

6a6e0c9

Felix-Dev reviewed Jul 17, 2020

View reviewed changes

marcelwgn reviewed Jul 17, 2020

View reviewed changes

sonnemaf added 5 commits July 17, 2020 13:51

NumberBox default TextAlignment set to Left and TextAlignmentProperty…

dc9cef7

… marked as Preview

Reverted the formatting of the NumberBoxPage.xaml and implemented the…

2410590

… TextAlignment default value using an attribute in the idl.

Revert "Reverted the formatting of the NumberBoxPage.xaml and impleme…

2c89e33

…nted the TextAlignment default value using an attribute in the idl." This reverts commit 2410590.

Reverted tne formatting caused by XAML Styler

c51b1c7

Default Left TextAlligment

006ba1d

StephenLPeters approved these changes Jul 21, 2020

View reviewed changes

Felix-Dev mentioned this pull request Aug 6, 2020

Proposal: Make the Tooltips of the NumberBox SpinButtons customizable #2808

Open

Add a TextAlignment API test

0b13227

StephenLPeters merged commit fb87bec into microsoft:master Aug 11, 2020

Kinnara added a commit to Kinnara/ModernWpf that referenced this pull request Aug 17, 2020

TextAlignment property added to NumberBox (microsoft/microsoft-ui-xam…

7fe3563

…l#2901)

dependabot bot mentioned this pull request Oct 3, 2020

Bump ModernWpfUI from 0.9.1 to 0.9.2 astenlund/fs2ff#4

Merged

Youssef1313 mentioned this pull request Aug 30, 2021

fix: Add and apply NumberBox CommonStates unoplatform/uno#6905

Merged

6 tasks

bogdan-patraucean mentioned this pull request Jul 19, 2022

NumberBox TextAlignment property is missing #7399

Closed

2 tasks

		@@ -1,14 +1,13 @@
		<!-- Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT License. See LICENSE in the project root for license information. -->
		<ResourceDictionary

TextAlignment property added to NumberBox #2901

TextAlignment property added to NumberBox #2901

Conversation

sonnemaf commented Jul 14, 2020 • edited Loading

Description

Motivation and Context

How Has This Been Tested?

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

marcelwgn commented Jul 14, 2020 • edited Loading

sonnemaf commented Jul 14, 2020 • edited Loading

Felix-Dev commented Jul 14, 2020

MikeHillberg commented Jul 14, 2020

StephenLPeters commented Jul 15, 2020

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

Felix-Dev Jul 17, 2020 • edited Loading

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

StephenLPeters commented Jul 20, 2020

azure-pipelines bot commented Jul 20, 2020

StephenLPeters left a comment

Choose a reason for hiding this comment

StephenLPeters commented Jul 21, 2020

Felix-Dev commented Jul 21, 2020 • edited Loading

ranjeshj commented Jul 23, 2020

StephenLPeters commented Jul 31, 2020

StephenLPeters commented Aug 4, 2020

StephenLPeters commented Aug 10, 2020

azure-pipelines bot commented Aug 10, 2020

sonnemaf commented Jul 14, 2020 •

edited

Loading

marcelwgn commented Jul 14, 2020 •

edited

Loading

sonnemaf commented Jul 14, 2020 •

edited

Loading

Felix-Dev Jul 17, 2020 •

edited

Loading

Felix-Dev commented Jul 21, 2020 •

edited

Loading