RadioMenuFlyoutItem API review #19
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| # Background | ||
| A [MenuFlyoutItem](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.Controls.MenuFlyoutItem) is an item | ||
| in a menu, be it a context menu ([MenuFlyout](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.Controls.MenuFlyout)) | ||
| or a [MenuBarItem](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.Controls.MenuBarItem). | ||
|
|
||
| The new RadioMenuFlyoutItem in this spec is a MenuFlyoutItem that displays and behaves like a radio button | ||
| (can be checked/unchecked, and in a group only one is selected at a time). | ||
|
|
||
| # Description | ||
| A radio menu flyout item is a menu item that is mutually exclusive with other radio menu items in its group. | ||
| This control contol allows you to present users with menus containing multiple options, where a user would choose only one of these options at a given time. | ||
|
|
||
|
|
||
| # Examples | ||
|
|
||
| ## Create RadioMenuFlyoutItems | ||
| *RadioMenuFlyoutItem* can be added into a *MenuBarItem*, *MenuFlyout*, or *MenuFlyoutSubItem*. The following example shows three radio menu flyout items as the content of a cascading menu flyout. | ||
|
|
||
|  | ||
|
|
||
| ````Xaml | ||
| <MenuFlyout> | ||
| <MenuFlyoutSubItem Text="View"> | ||
| <muxc:RadioMenuFlyoutItem Text="Small icons"/> | ||
| <muxc:RadioMenuFlyoutItem Text="Medium icons" IsChecked="True"/> | ||
| <muxc:RadioMenuFlyoutItem Text="Large icons"/> | ||
| </MenuFlyoutSubItem> | ||
| </MenuFlyout> | ||
| ```` | ||
|
|
||
| ## Group RadioMenuFlyoutItem into multiple sets | ||
| Radio menu flyout items work in groups, and users can only select one item in a radio menu flyout item group. To create multiple groups of radio buttons within a single menu, be sure to specify the `GroupName` property of each set. | ||
|
|
||
|  | ||
|
|
||
| ````Xaml | ||
| <muxc:MenuBar> | ||
| <muxc:MenuBarItem Title="View"> | ||
| <MenuFlyoutItem Text="Open"/> | ||
| <MenuFlyoutSeparator/> | ||
| <muxc:RadioMenuFlyoutItem Text="Landscape" GroupName="OrientationGroup"/> | ||
| <muxc:RadioMenuFlyoutItem Text="Portrait" GroupName="OrientationGroup" IsChecked="True"/> | ||
| <MenuFlyoutSeparator/> | ||
| <muxc:RadioMenuFlyoutItem Text="Small icons" GroupName="SizeGroup"/> | ||
| <muxc:RadioMenuFlyoutItem Text="Medium icons" IsChecked="True" GroupName="SizeGroup"/> | ||
| <muxc:RadioMenuFlyoutItem Text="Large icons" GroupName="SizeGroup"/> | ||
| </muxc:MenuBarItem> | ||
| </muxc:MenuBar> | ||
| ```` | ||
|
|
||
| # API Details | ||
| ````c# | ||
| [webhosthidden] | ||
| unsealed runtimeclass RadioMenuFlyoutItem : Windows.UI.Xaml.Controls.MenuFlyoutItem | ||
| { | ||
| RadioMenuFlyoutItem(); | ||
|
|
||
| /// Gets or sets whether the RadioMenuFlyoutItem is checked | ||
| Boolean IsChecked; | ||
|
|
||
| /// Gets or sets the name that specifies which RadioMenuFlyoutItem controls are mutually exclusive | ||
| String GroupName; | ||
|
There was a problem hiding this comment. I assume the There was a problem hiding this comment. It's scoped to siblings in whatever flyout it's in. There was a problem hiding this comment. Recommend: Need to update this in the description. |
||
|
|
||
| static Windows.UI.Xaml.DependencyProperty IsCheckedProperty{ get; }; | ||
| static Windows.UI.Xaml.DependencyProperty GroupNameProperty{ get; }; | ||
| } | ||
| ```` | ||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
RadioButtonderives fromToggleButton, butRadioMenuFlyoutItemdoesn't derive fromToggleMenuFlyoutItem. Intentional?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We did do that intentionally but I could be convinced otherwise. :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does/should it support ThreeState?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think it should, that doesn't feel like a compelling scenario inside a context menu.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Discussion: Based on that, not deriving from ToggleMenuFlyoutItem sounds right.