-
Notifications
You must be signed in to change notification settings - Fork 619
/
ControlInfoData.json
2892 lines (2892 loc) · 138 KB
/
ControlInfoData.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"Groups": [
{
"UniqueId": "Design_Guidance",
"Title": "Design guidance",
"IconGlyph": "",
"IsSpecialSection": true,
"Folder": "DesignGuidance",
"Items": [
{
"UniqueId": "Typography",
"Title": "Typography",
"SourcePath": "/CommonStyles/TextBlock_themeresources.xaml",
"Docs": [
{
"Title": "Typography in Windows Apps",
"Uri": "https://learn.microsoft.com/windows/apps/design/style/typography"
},
{
"Title": "XAML theme resources",
"Uri": "https://learn.microsoft.com/windows/apps/design/style/xaml-theme-resources#the-xaml-type-ramp"
},
{
"Title": "Typography in Windows 11",
"Uri": "https://learn.microsoft.com/windows/apps/design/signature-experiences/typography"
}
]
},
{
"UniqueId": "Icons",
"Title": "Icons",
"Docs": [
{
"Title": "Iconography in Windows 11",
"Uri": "https://learn.microsoft.com/windows/apps/design/signature-experiences/iconography#system-icons"
},
{
"Title": "Segoe Fluent Icons font",
"Uri": "https://learn.microsoft.com/windows/apps/design/style/segoe-fluent-icons-font"
}
]
},
{
"UniqueId": "Colors",
"Title": "Colors",
"Docs": [
{
"Title": "Colors in Windows 11",
"Uri": "https://learn.microsoft.com/windows/apps/design/signature-experiences/color"
},
{
"Title": "Windows UI Toolkit (Figma)",
"Uri": "https://www.figma.com/community/file/1159947337437047524"
},
{
"Title": "WinUI Theme Resources (GitHub)",
"Uri": "https://github.com/microsoft/microsoft-ui-xaml/blob/winui3/release/1.4-stable/controls/dev/CommonStyles/Common_themeresources_any.xaml"
}
]
}
]
},
{
"UniqueId": "AccessibilityItem",
"Title": "Accessibility",
"IsSpecialSection": true,
"Folder": "Accessibility",
"Items": [
{
"UniqueId": "AccessibilityColorContrast",
"Title": "Color Contrast",
"ImagePath": "ms-appx:///Assets/ControlImages/AppBarSeparator.png",
"Docs": [
{
"Title": "Accessibility",
"Uri": "https://learn.microsoft.com/windows/apps/design/accessibility/accessibility"
},
{
"Title": "Automation Properties - API",
"Uri": "https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/microsoft.ui.xaml.automation.automationproperties"
}
]
},
{
"UniqueId": "AccessibilityKeyboard",
"Title": "Keyboard Support",
"ImagePath": "ms-appx:///Assets/ControlImages/AppBarSeparator.png",
"Docs": [
{
"Title": "Accessibility",
"Uri": "https://learn.microsoft.com/windows/apps/design/accessibility/accessibility"
},
{
"Title": "Accessibility overview",
"Uri": "https://learn.microsoft.com/windows/apps/design/accessibility/accessibility-overview"
},
{
"Title": "Keyboard accessibility",
"Uri": "https://learn.microsoft.com/windows/apps/design/accessibility/keyboard-accessibility"
},
{
"Title": "Keyboard interactions",
"Uri": "https://learn.microsoft.com/windows/apps/design/input/keyboard-interactions"
},
{
"Title": "Access keys",
"Uri": "https://learn.microsoft.com/windows/apps/design/input/access-keys"
},
{
"Title": "Keyboard accelerators",
"Uri": "https://learn.microsoft.com/windows/apps/design/input/keyboard-accelerators"
},
{
"Title": "Focus navigation for keyboard, gamepad, remote control, and accessibility tools",
"Uri": "https://learn.microsoft.com/windows/apps/design/input/focus-navigation"
},
{
"Title": "Automation Properties - API",
"Uri": "https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/microsoft.ui.xaml.automation.automationproperties"
}
]
},
{
"UniqueId": "AccessibilityScreenReader",
"Title": "Screen Reader Support",
"ImagePath": "ms-appx:///Assets/ControlImages/AppBarSeparator.png",
"Docs": [
{
"Title": "Accessibility",
"Uri": "https://learn.microsoft.com/windows/apps/design/accessibility/accessibility"
},
{
"Title": "Accessibility overview",
"Uri": "https://learn.microsoft.com/windows/apps/design/accessibility/accessibility-overview"
},
{
"Title": "Expose basic accessibility information",
"Uri": "https://learn.microsoft.com/windows/apps/design/accessibility/basic-accessibility-information"
},
{
"Title": "Landmarks and Headings",
"Uri": "https://learn.microsoft.com/windows/apps/design/accessibility/landmarks-and-headings"
},
{
"Title": "Accessible text requirements",
"Uri": "https://learn.microsoft.com/windows/apps/design/accessibility/accessible-text-requirements"
},
{
"Title": "Complete guide to Narrator",
"Uri": "https://support.microsoft.com/windows/complete-guide-to-narrator-e4397a0d-ef4f-b386-d8ae-c172f109bdb1"
}
]
}
]
},
{
"UniqueId": "MenusAndToolbars",
"Title": "Menus & toolbars",
"ImagePath": "",
"IconGlyph": "",
"Items": [
{
"UniqueId": "XamlUICommand",
"Title": "XamlUICommand",
"ApiNamespace": "Microsoft.UI.Xaml.Input",
"Subtitle": "An object which is used to define the look and feel of a given command.",
"ImagePath": "ms-appx:///Assets/ControlImages/AppBarSeparator.png",
"Description": "An object which is used to define the look and feel of a given command, which can be reused across your app, and which is understood natively by the standard XAML controls.",
"Docs": [
{
"Title": "Guidelines",
"Uri": "https://learn.microsoft.com/windows/apps/design/controls/commanding#command-experiences-using-the-xamluicommand-class"
},
{
"Title": "XamlUICommand - API",
"Uri": "https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/microsoft.ui.xaml.input.xamluicommand"
}
],
"RelatedControls": [
"StandardUICommand",
"AppBarButton",
"AppBarToggleButton",
"CommandBar"
]
},
{
"UniqueId": "StandardUICommand",
"Title": "StandardUICommand",
"ApiNamespace": "Microsoft.UI.Xaml.Input",
"Subtitle": "A StandardUICommand is a built-in 'XamlUICommand' which represents a commonly used command, e.g. 'Save'.",
"ImagePath": "ms-appx:///Assets/ControlImages/AppBarSeparator.png",
"Description": "StandardUICommands are a set of built-in XamlUICommands represeting commonly used commands. Including the look and feel of a given command, which can be reused across your app, and which is understood natively by the standard XAML controls. E.g. Save, Open, Copy, Paste, etc.",
"Docs": [
{
"Title": "Guidelines",
"Uri": "https://learn.microsoft.com/windows/apps/design/controls/commanding#command-experiences-using-the-standarduicommand-class"
},
{
"Title": "StandardUICommand - API",
"Uri": "https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/microsoft.ui.xaml.input.standarduicommand"
}
],
"RelatedControls": [
"XamlUICommand",
"AppBarButton",
"AppBarToggleButton",
"CommandBar"
]
},
{
"UniqueId": "AppBarButton",
"Title": "AppBarButton",
"ApiNamespace": "Microsoft.UI.Xaml.Controls",
"Subtitle": "A button that's styled for use in a CommandBar.",
"ImagePath": "ms-appx:///Assets/ControlImages/AppBarButton.png",
"Description": "App bar buttons differ from standard buttons in several ways:\n- Their default appearance is a transparent background with a smaller size.\n- You use the Label and Icon properties to set the content instead of the Content property. The Content property is ignored.\n- The button's IsCompact property controls its size.",
"Content": "<p>You can open the app bar and toggle the IsCompact button to see how the app bar buttons on this page change.</p><p>Use the <b>Label</b> and <b>Icon</b> properties to define the content of the app bar buttons. Set the <b>Label</b> property to a string to specify the text label. The label is shown by default but is hidden when the button is in its compact state, so you also need to specify a meaningful icon. To do that, set the button's <b>Icon</b> property to an element derived from the <b>IconElement</b> class. Four kinds of icon elements are provided:</p><p><b>FontIcon</b> - The icon is based on a glyph from the specified font family.</p><p><b>BitmapIcon</b> - The icon is based on a bitmap image file with the specified Uri.</p><p><b>PathIcon</b> - The icon is based on Path data.</p><p><b>SymbolIcon</b> - The icon is based on a predefined list of glyphs from the Segoe UI Symbol font.</p><p>Look at the <i>AppBarButtonPage.xaml</i> file in Visual Studio to see the full code for this page.</p>",
"SourcePath": "/CommonStyles/AppBarButton_themeresources.xaml",
"Docs": [
{
"Title": "AppBarButton - API",
"Uri": "https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/microsoft.ui.xaml.controls.appbarbutton"
},
{
"Title": "SymbolIcon - API",
"Uri": "https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/microsoft.ui.xaml.controls.symbolicon"
},
{
"Title": "FontIcon - API",
"Uri": "https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/microsoft.ui.xaml.controls.fonticon"
},
{
"Title": "BitmapIcon - API",
"Uri": "https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/microsoft.ui.xaml.controls.bitmapicon"
},
{
"Title": "PathIcon - API",
"Uri": "https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/microsoft.ui.xaml.controls.pathicon"
},
{
"Title": "Guidelines",
"Uri": "https://learn.microsoft.com/windows/apps/design/controls/command-bar"
}
],
"RelatedControls": [
"AppBarToggleButton",
"AppBarSeparator",
"CommandBar"
]
},
{
"UniqueId": "AppBarSeparator",
"Title": "AppBarSeparator",
"ApiNamespace": "Microsoft.UI.Xaml.Controls",
"Subtitle": "A vertical line that's used to visually separate groups of commands in an app bar.",
"ImagePath": "ms-appx:///Assets/ControlImages/AppBarSeparator.png",
"Description": "An AppBarSeparator creates a vertical line to visually separate groups of commands in a app bar. It has a compact state with reduced padding to match the compact state of the AppBarButton and AppBarToggleButton controls.",
"Content": "<p>You can open the app bar and toggle the IsCompact button to see how the app bar buttons and separators on this page change.</p><p>When the <b>IsCompact</b> property is true, the padding around the <b>AppBarSeparator</b> is reduced.</p><p>Look at the <i>AppBarSeparatorPage.xaml</i> file in Visual Studio to see the full code for this page.</p>",
"SourcePath": "/CommonStyles/AppBarSeparator_themeresources.xaml",
"Docs": [
{
"Title": "AppBarSeparator - API",
"Uri": "https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/microsoft.ui.xaml.controls.appbarseparator"
},
{
"Title": "Guidelines",
"Uri": "https://learn.microsoft.com/windows/apps/design/controls/command-bar"
}
],
"RelatedControls": [
"AppBarButton",
"AppBarToggleButton",
"CommandBar"
]
},
{
"UniqueId": "AppBarToggleButton",
"Title": "AppBarToggleButton",
"ApiNamespace": "Microsoft.UI.Xaml.Controls",
"Subtitle": "A button that can be on, off, or indeterminate like a CheckBox, and is styled for use in an app bar or other specialized UI.",
"ImagePath": "ms-appx:///Assets/ControlImages/AppBarToggleButton.png",
"Description": "An AppBarToggleButton looks like an AppBarButton, but works like a CheckBox. It typically has two states, checked (on) or unchecked (off), but can be indeterminate if the IsThreeState property is true. You can determine it's state by checking the IsChecked property.",
"Content": "<p>You can open the app bar and toggle the IsCompact button to see how the app bar buttons on this page change.</p><p>Look at the <i>AppBarToggleButtonPage.xaml</i> file in Visual Studio to see the full code for this page.</p>",
"SourcePath": "/CommonStyles/AppBarToggleButton_themeresources.xaml",
"Docs": [
{
"Title": "AppBarToggleButton - API",
"Uri": "https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/microsoft.ui.xaml.controls.appbartogglebutton"
},
{
"Title": "SymbolIcon - API",
"Uri": "https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/microsoft.ui.xaml.controls.symbolicon"
},
{
"Title": "FontIcon - API",
"Uri": "https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/microsoft.ui.xaml.controls.fonticon"
},
{
"Title": "BitmapIcon - API",
"Uri": "https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/microsoft.ui.xaml.controls.bitmapicon"
},
{
"Title": "PathIcon - API",
"Uri": "https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/microsoft.ui.xaml.controls.pathicon"
},
{
"Title": "Guidelines",
"Uri": "https://learn.microsoft.com/windows/apps/design/controls/command-bar"
}
],
"RelatedControls": [
"AppBarButton",
"AppBarSeparator",
"CommandBar"
]
},
{
"UniqueId": "CommandBar",
"Title": "CommandBar",
"ApiNamespace": "Microsoft.UI.Xaml.Controls",
"Subtitle": "A toolbar for displaying application-specific commands that handles layout and resizing of its contents.",
"ImagePath": "ms-appx:///Assets/ControlImages/CommandBar.png",
"Description": "The CommandBar simplifies the creation of basic app bars by providing:\n- Automatic layout of commands, with primary commands on the right and secondary commands on the left.\n- Automatic resizing of app bar commands when the app size changes.\nWhen you need an app bar that contains only AppBarButton,AppBarToggleButton , and AppBarSeparator controls, use a CommandBar. If you need more complex content, such as images, progress bars, or text blocks, use an AppBar control.",
"Content": "<p>The bottom app bar on this page is a <b>CommandBar</b> control.</p><p>Add secondary commands and then resize the app to see how the <b>CommandBar</b> automatically adapts to different widths.</p><p>This <b>CommandBar</b> element is in the ItemPage so it can be shared across all control pages in the app. Look at the <i>ItemPage.xaml</i> file in Visual Studio to see the full code for this page.</p>",
"SourcePath": "/CommonStyles/CommandBar_themeresources.xaml",
"Docs": [
{
"Title": "CommandBar - API",
"Uri": "https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/microsoft.ui.xaml.controls.commandbar"
},
{
"Title": "Guidelines",
"Uri": "https://learn.microsoft.com/windows/apps/design/controls/command-bar"
}
],
"RelatedControls": [
"AppBarButton",
"AppBarToggleButton",
"AppBarSeparator"
]
},
{
"UniqueId": "MenuBar",
"Title": "MenuBar",
"ApiNamespace": "Microsoft.UI.Xaml.Controls",
"Subtitle": "A classic menu, allowing the display of MenuItems containing MenuFlyoutItems.",
"ImagePath": "ms-appx:///Assets/ControlImages/MenuBar.png",
"Description": "The Menubar simplifies the creation of basic applications by providing a set of menus at the top of the app or window.",
"SourcePath": "/MenuBar",
"Docs": [
{
"Title": "MenuBar - API",
"Uri": "https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/microsoft.ui.xaml.Controls.MenuBar"
},
{
"Title": "Guidelines",
"Uri": "https://learn.microsoft.com/windows/apps/design/controls/menus"
}
],
"RelatedControls": [
"CommandBar",
"MenuFlyout",
"StandardUICommand",
"XamlUICommand"
]
},
{
"UniqueId": "CommandBarFlyout",
"Title": "CommandBarFlyout",
"ApiNamespace": "Microsoft.UI.Xaml.Controls",
"Subtitle": "A mini-toolbar displaying proactive commands, and an optional menu of commands.",
"ImagePath": "ms-appx:///Assets/ControlImages/CommandBarFlyout.png",
"Description": "A mini-toolbar which displays a set of proactive commands, as well as a secondary menu of commands if desired.",
"SourcePath": "/MenuBar",
"Docs": [
{
"Title": "CommandBarFlyout - API",
"Uri": "https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/microsoft.ui.xaml.controls.commandbarflyout"
},
{
"Title": "Guidelines",
"Uri": "https://learn.microsoft.com/windows/apps/design/controls/command-bar-flyout"
}
],
"RelatedControls": [
"CommandBar",
"MenuFlyout",
"RichEditBox",
"TextBox",
"StandardUICommand",
"XamlUICommand"
]
},
{
"UniqueId": "MenuFlyout",
"Title": "MenuFlyout",
"ApiNamespace": "Microsoft.UI.Xaml.Controls",
"Subtitle": "Shows a contextual list of simple commands or options.",
"ImagePath": "ms-appx:///Assets/ControlImages/MenuFlyout.png",
"Description": "A MenuFlyout displays lightweight UI that is light dismissed by clicking or tapping off of it. Use it to let the user choose from a contextual list of simple commands or options.",
"Content": "<p>Look at the <i>MenuFlyoutPage.xaml</i> file in Visual Studio to see the full code.</p>",
"SourcePath": "/CommonStyles/MenuFlyout_themeresources.xaml",
"Docs": [
{
"Title": "MenuFlyout - API",
"Uri": "https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/microsoft.ui.xaml.controls.menuflyout"
},
{
"Title": "MenuFlyoutItem - API",
"Uri": "https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/microsoft.ui.xaml.controls.menuflyoutitem"
},
{
"Title": "MenuFlyoutSeparator - API",
"Uri": "https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/microsoft.ui.xaml.controls.menuflyoutseparator"
},
{
"Title": "ToggleMenuFlyoutItem - API",
"Uri": "https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/microsoft.ui.xaml.controls.togglemenuflyoutitem"
},
{
"Title": "Guidelines",
"Uri": "https://learn.microsoft.com/windows/apps/design/controls/menus"
}
],
"RelatedControls": [
"Flyout",
"ContentDialog",
"Button",
"AppBarButton"
]
},
{
"UniqueId": "SwipeControl",
"Title": "SwipeControl",
"ApiNamespace": "Microsoft.UI.Xaml.Controls",
"Subtitle": "Touch gesture for quick menu actions on items.",
"ImagePath": "ms-appx:///Assets/ControlImages/SwipeControl.png",
"Description": "Touch gesture for quick menu actions on items.",
"IsUpdated": true,
"Docs": [
{
"Title": "SwipeControl - API",
"Uri": "https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/microsoft.ui.xaml.controls.swipecontrol"
},
{
"Title": "SwipeItems - API",
"Uri": "https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/microsoft.ui.xaml.controls.swipeitems"
},
{
"Title": "Guidelines",
"Uri": "https://learn.microsoft.com/windows/apps/design/controls/swipe"
},
{
"Title": "Gesture Actions",
"Uri": "https://learn.microsoft.com/windows/apps/design/controls/collection-commanding"
}
],
"RelatedControls": [
"GridView",
"ListView"
]
}
]
},
{
"UniqueId": "Collections",
"Title": "Collections",
"ImagePath": "",
"IconGlyph": "",
"Items": [
{
"UniqueId": "FlipView",
"Title": "FlipView",
"ApiNamespace": "Microsoft.UI.Xaml.Controls",
"Subtitle": "Presents a collection of items that the user can flip through, one item at a time.",
"ImagePath": "ms-appx:///Assets/ControlImages/FlipView.png",
"Description": "The FlipView lets you flip through a collection of items, one at a time. It's great for displaying images from a gallery, pages of a magazine, or similar items.",
"Content": "<p><b>FlipView</b> is an <b>ItemsControl</b>, so it can contain a collection of items of any type. To populate the view, add items to the <b>Items</b> collection, or set the <b>ItemsSource</b> property to a data source.</p><p>Look at the <i>FlipViewPage.xaml</i> file in Visual Studio to see the full code for this page.</p>",
"SourcePath": "/CommonStyles/FlipView_themeresources.xaml",
"Docs": [
{
"Title": "FlipView - API",
"Uri": "https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/microsoft.ui.xaml.controls.flipview"
},
{
"Title": "Guidelines",
"Uri": "https://learn.microsoft.com/windows/apps/design/controls/flipview"
}
],
"RelatedControls": [
"GridView",
"ListView",
"SemanticZoom"
]
},
{
"UniqueId": "GridView",
"Title": "GridView",
"ApiNamespace": "Microsoft.UI.Xaml.Controls",
"Subtitle": "A control that presents a collection of items in rows and columns.",
"ImagePath": "ms-appx:///Assets/ControlImages/GridView.png",
"Description": "The GridView lets you show a collection of items arranged in rows and columns that scroll horizontally.",
"Content": "<p><b>GridView</b> is an <b>ItemsControl</b>, so it can contain a collection of items of any type. To populate the view, add items to the <b>Items</b> collection, or set the <b>ItemsSource</b> property to a data source.</p><p>Set an <b>ItemTemplate</b> to define the look of individual items.</p><p>Look at the <i>GridViewPage.xaml</i> file in Visual Studio to see the full code for this page.</p>",
"SourcePath": "/CommonStyles/GridViewItem_themeresources.xaml",
"Docs": [
{
"Title": "GridView - API",
"Uri": "https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/microsoft.ui.xaml.controls.gridview"
},
{
"Title": "Guidelines",
"Uri": "https://learn.microsoft.com/windows/apps/design/controls/lists"
}
],
"RelatedControls": [
"ItemsView",
"ListView",
"FlipView",
"SemanticZoom"
]
},
{
"UniqueId": "ItemsView",
"Title": "ItemsView",
"ApiNamespace": "Microsoft.UI.Xaml.Controls",
"Subtitle": "A control that presents a collection of items using various layouts.",
"ImagePath": "ms-appx:///Assets/ControlImages/ItemsView.png",
"Description": "The ItemsView lets you show a collection of items using scrollable & swappable layouts.",
"Content": "<p><b>ItemsView</b> can contain a collection of items of any type. To populate the view, set the <b>ItemsSource</b> property to a data source.</p><p>Set a <b>Layout</b> to define how the items are laid out.</p><p>Set an <b>ItemTemplate</b> to define the look of individual items.</p><p>Look at the <i>ItemsViewPage.xaml</i> file in Visual Studio to see the full code for this page.</p>",
"SourcePath": "/ItemsView",
"IsNew": true,
"Docs": [
{
"Title": "ItemsView - API",
"Uri": "https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/microsoft.ui.xaml.controls.itemsview"
},
{
"Title": "CollectionViewSource - API",
"Uri": "https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/microsoft.ui.xaml.Data.CollectionViewSource"
}
],
"RelatedControls": [
"AnnotatedScrollBar",
"ItemsRepeater",
"ListView",
"GridView",
"ScrollView"
]
},
{
"UniqueId": "ListBox",
"Title": "ListBox",
"ApiNamespace": "Microsoft.UI.Xaml.Controls",
"Subtitle": "A control that presents an inline list of items that the user can select from.",
"ImagePath": "ms-appx:///Assets/ControlImages/ListBox.png",
"Description": "Use a ListBox when you want the options to be visible all the time or when users can select more than one option at a time. ListBox controls are always open, which allows several items to be displayed to the user without user interaction.",
"Content": "<p>Look at the <i>ListBoxPage.xaml</i> file in Visual Studio to see the full code for this page.</p>",
"SourcePath": "/CommonStyles/ListBox_themeresources.xaml",
"Docs": [
{
"Title": "ListBox - API",
"Uri": "https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/microsoft.ui.xaml.controls.listbox"
},
{
"Title": "ListBoxItem - API",
"Uri": "https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/microsoft.ui.xaml.controls.listboxitem"
}
],
"RelatedControls": [
"ComboBox",
"RadioButton",
"CheckBox",
"AutoSuggestBox"
]
},
{
"UniqueId": "ListView",
"Title": "ListView",
"ApiNamespace": "Microsoft.UI.Xaml.Controls",
"Subtitle": "A control that presents a collection of items in a vertical list.",
"ImagePath": "ms-appx:///Assets/ControlImages/ListView.png",
"Description": "The ListView lets you show a collection of items in a list that scrolls vertically.",
"Content": "<p><b>ListView</b> is an <b>ItemsControl</b>, so it can contain a collection of items of any type. To populate the view, add items to the <b>Items</b> collection, or set the <b>ItemsSource</b> property to a data source.</p><p>Set an <b>ItemTemplate</b> to define the look of individual items.</p><p>Look at the <i>ListViewPage.xaml</i> file in Visual Studio to see the full code for this page.</p>",
"IsUpdated": true,
"SourcePath": "/CommonStyles/ListViewItem_themeresources.xaml",
"Docs": [
{
"Title": "ListView - API",
"Uri": "https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/microsoft.ui.xaml.controls.listview"
},
{
"Title": "Guidelines",
"Uri": "https://learn.microsoft.com/windows/apps/design/controls/listview-and-gridview"
},
{
"Title": "Drag and Drop - Full Sample",
"Uri": "https://github.com/microsoft/Windows-universal-samples/tree/master/Samples/XamlDragAndDrop"
},
{
"Title": "CollectionViewSource - API",
"Uri": "https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/microsoft.ui.xaml.Data.CollectionViewSource"
},
{
"Title": "Filtering collections and lists through user input",
"Uri": "https://learn.microsoft.com/windows/apps/design/controls/listview-filtering"
},
{
"Title": "Inverted Lists",
"Uri": "https://learn.microsoft.com/windows/apps/design/controls/inverted-lists"
},
{
"Title": "Inverted Lists - Full Sample",
"Uri": "https://github.com/Microsoft/Windows-universal-samples/tree/master/Samples/XamlBottomUpList"
}
],
"RelatedControls": [
"ItemsView",
"GridView",
"StandardUICommand",
"FlipView",
"SemanticZoom"
]
},
{
"UniqueId": "PullToRefresh",
"Title": "PullToRefresh",
"ApiNamespace": "Microsoft.UI.Xaml.Controls",
"Subtitle": "Provides the ability to pull on a collection of items in a list/grid to refresh the contents of the collection.",
"ImagePath": "ms-appx:///Assets/ControlImages/PullToRefresh.png",
"Description": "PullToRefresh lets a user pull down on a list of data using touch in order to retrieve more data. PullToRefresh is widely used on devices with a touch screen.",
"Content": "<p><b>PullToRefresh</b> can be used for a collection of items of any type. To populate the view, add items to the <b>Items</b> collection, or set the <b>ItemsSource</b> property to a data source.</p><p>Set an <b>ItemTemplate</b> to define the look of individual items.</p><p>Look at the <i>ListViewPage.xaml</i> file in Visual Studio to see the full code for this page.</p>",
"SourcePath": "/PullToRefresh",
"Docs": [
{
"Title": "RefreshContainer - API",
"Uri": "https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/microsoft.ui.xaml.Controls.RefreshContainer"
},
{
"Title": "RefreshVisualizer - API",
"Uri": "https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/microsoft.ui.xaml.Controls.RefreshVisualizer"
},
{
"Title": "Guidelines",
"Uri": "https://learn.microsoft.com/windows/apps/design/controls/pull-to-refresh"
}
]
},
{
"UniqueId": "TreeView",
"Title": "TreeView",
"ApiNamespace": "Microsoft.UI.Xaml.Controls",
"Subtitle": "The TreeView control is a hierarchical list pattern with expanding and collapsing nodes that contain nested items.",
"ImagePath": "ms-appx:///Assets/ControlImages/TreeView.png",
"Description": "The TreeView control is a hierarchical list pattern with expanding and collapsing nodes that contain nested items. ",
"Content": "<p><b>PullToRefresh</b> can be used for a collection of items of any type. To populate the view, add items to the <b>Items</b> collection, or set the <b>ItemsSource</b> property to a data source.</p><p>Set an <b>ItemTemplate</b> to define the look of individual items.</p><p>Look at the <i>ListViewPage.xaml</i> file in Visual Studio to see the full code for this page.</p>",
"SourcePath": "/TreeView",
"Docs": [
{
"Title": "TreeView - API",
"Uri": "https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/microsoft.ui.xaml.Controls.TreeView"
},
{
"Title": "Guidelines",
"Uri": "https://learn.microsoft.com/windows/apps/design/controls/tree-view"
}
]
},
{
"UniqueId": "DataGrid",
"Title": "DataGrid",
"Subtitle": "The DataGrid control presents data in a customizable table of rows and columns.",
"ImagePath": "ms-appx:///Assets/ControlImages/GridView.png",
"Description": "The DataGrid control provides a flexible way to display a collection of data in rows and columns.",
"Content": "The DataGrid control presents data in a customizable table of rows and columns.",
"Docs": [
{
"Title": "DataGrid - API",
"Uri": "https://aka.ms/win10datagridapidoc"
},
{
"Title": "Guidelines",
"Uri": "https://aka.ms/win10datagriddoc"
},
{
"Title": "Windows Community Toolkit",
"Uri": "https://learn.microsoft.com/windows/communitytoolkit"
}
],
"RelatedControls": [
"GridView",
"TreeView"
]
}
]
},
{
"UniqueId": "DateAndTime",
"Title": "Date & time",
"ImagePath": "",
"IconGlyph": "",
"Items": [
{
"UniqueId": "CalendarDatePicker",
"Title": "CalendarDatePicker",
"ApiNamespace": "Microsoft.UI.Xaml.Controls",
"Subtitle": "A control that lets users pick a date value using a calendar.",
"ImagePath": "ms-appx:///Assets/ControlImages/CalendarDatePicker.png",
"Description": "A control that lets users pick a date value using a calendar.",
"SourcePath": "/CommonStyles/CalendarDatePicker_themeresources.xaml",
"Docs": [
{
"Title": "CalendarDatePicker - API",
"Uri": "https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/microsoft.ui.xaml.controls.calendardatepicker"
},
{
"Title": "Guidelines",
"Uri": "https://learn.microsoft.com/windows/apps/design/controls/calendar-date-picker"
}
],
"RelatedControls": [
"DatePicker",
"CalendarView"
]
},
{
"UniqueId": "CalendarView",
"Title": "CalendarView",
"ApiNamespace": "Microsoft.UI.Xaml.Controls",
"Subtitle": "A control that presents a calendar for a user to choose a date from.",
"ImagePath": "ms-appx:///Assets/ControlImages/CalendarView.png",
"Description": "CalendarView shows a larger view for showing and selecting dates. DatePicker by contrast has a compact view with inline selection.",
"Content": "<p>Look at the <i>CalendarView.xaml</i> file in Visual Studio to see the full code for this page.</p>",
"SourcePath": "/CommonStyles/CalendarView_themeresources.xaml",
"Docs": [
{
"Title": "CalendarView - API",
"Uri": "https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/microsoft.ui.xaml.controls.calendarview"
},
{
"Title": "Guidelines",
"Uri": "https://learn.microsoft.com/windows/apps/design/controls/calendar-view"
}
],
"RelatedControls": [
"CalendarDatePicker",
"DatePicker",
"TimePicker"
]
},
{
"UniqueId": "DatePicker",
"Title": "DatePicker",
"ApiNamespace": "Microsoft.UI.Xaml.Controls",
"Subtitle": "A control that lets a user pick a date value.",
"ImagePath": "ms-appx:///Assets/ControlImages/DatePicker.png",
"Description": "Use a DatePicker to let users set a date in your app, for example to schedule an appointment. The DatePicker displays three controls for month, date, and year. These controls are easy to use with touch or mouse, and they can be styled and configured in several different ways.",
"Content": "<p>Look at the <i>DatePickerPage.xaml</i> file in Visual Studio to see the full code for this page.</p>",
"SourcePath": "/CommonStyles/DatePicker_themeresources.xaml",
"Docs": [
{
"Title": "DatePicker - API",
"Uri": "https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/microsoft.ui.xaml.controls.datepicker"
},
{
"Title": "Guidelines",
"Uri": "https://learn.microsoft.com/windows/apps/design/controls/date-picker"
}
],
"RelatedControls": [
"CalendarDatePicker",
"CalendarView",
"TimePicker"
]
},
{
"UniqueId": "TimePicker",
"Title": "TimePicker",
"ApiNamespace": "Microsoft.UI.Xaml.Controls",
"Subtitle": "A configurable control that lets a user pick a time value.",
"ImagePath": "ms-appx:///Assets/ControlImages/TimePicker.png",
"Description": "Use a TimePicker to let users set a time in your app, for example to set a reminder. The TimePicker displays three controls for hour, minute, and AM/PM. These controls are easy to use with touch or mouse, and they can be styled and configured in several different ways.",
"Content": "<p>Look at the <i>TimePickerPage.xaml</i> file in Visual Studio to see the full code for this page.</p>",
"SourcePath": "/CommonStyles/TimePicker_themeresources.xaml",
"Docs": [
{
"Title": "TimePicker - API",
"Uri": "https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/microsoft.ui.xaml.controls.timepicker"
},
{
"Title": "Guidelines",
"Uri": "https://learn.microsoft.com/windows/apps/design/controls/time-picker"
}
],
"RelatedControls": [
"DatePicker",
"CalendarView"
]
}
]
},
{
"UniqueId": "BasicInput",
"Title": "Basic input",
"ImagePath": "",
"IconGlyph": "",
"Items": [
{
"UniqueId": "InputValidation",
"Title": "InputValidation",
"Subtitle": "A feature to display developer-defined errors for text values",
"ApiNamespace": "Microsoft.UI.Xaml.Controls",
"ImagePath": "ms-appx:///Assets/ControlImages/InputValidation.png",
"Description": "A feature that will display an error for invalid text. The app is notified when text has been changed by the user and is responsible for determining whether the text is valid and the error message",
"Content": "<p>Look at the <i>InputValidationPage.xaml</i> file in Visual Studio to see the full code for this page.</p>",
"RelatedControls": [
"TextBox",
"PasswordBox"
]
},
{
"UniqueId": "Button",
"Title": "Button",
"ApiNamespace": "Microsoft.UI.Xaml.Controls",
"Subtitle": "A control that responds to user input and raises a Click event.",
"ImagePath": "ms-appx:///Assets/ControlImages/Button.png",
"Description": "The Button control provides a Click event to respond to user input from a touch, mouse, keyboard, stylus, or other input device. You can put different kinds of content in a button, such as text or an image, or you can restyle a button to give it a new look.",
"Content": "<p>The main purpose of a <b>Button</b> is to make something happen when a user clicks it. There are two ways you can make something happen:</p><ul><li>Handle the <b>Click</b> event.</li><li>Bind the <b>Command</b> property to an ICommand implementation that describes the command logic.</li></ul><p>Buttons often have only simple string content, but you can use any object as content. You can also change the style and template to give them any look you want.</p><p>Look at the <i>ButtonPage.xaml</i> file in Visual Studio to see the custom button style and template definitions used on this page.</p>",
"IsUpdated": true,
"SourcePath": "/CommonStyles/Button_themeresources.xaml",
"Docs": [
{
"Title": "Button - API",
"Uri": "https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/microsoft.ui.xaml.controls.button"
},
{
"Title": "Guidelines",
"Uri": "https://learn.microsoft.com/windows/apps/design/controls/buttons"
}
],
"RelatedControls": [
"ToggleButton",
"RepeatButton",
"HyperlinkButton",
"AppBarButton"
]
},
{
"UniqueId": "DropDownButton",
"Title": "DropDownButton",
"ApiNamespace": "Microsoft.UI.Xaml.Controls",
"Subtitle": "A button that displays a flyout of choices when clicked.",
"ImagePath": "ms-appx:///Assets/ControlImages/DropDownButton.png",
"Description": "A control that drops down a flyout of choices from which one can be chosen.",
"SourcePath": "/DropDownButton",
"Docs": [
{
"Title": "DropDownButton - API",
"Uri": "https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/microsoft.ui.xaml.controls.dropdownbutton"
},
{
"Title": "Guidelines",
"Uri": "https://learn.microsoft.com/windows/apps/design/controls/buttons"
}
],
"RelatedControls": [
"SplitButton",
"ToggleSplitButton",
"ToggleButton",
"RepeatButton",
"HyperlinkButton",
"AppBarButton",
"CommandBar"
]
},
{
"UniqueId": "HyperlinkButton",
"Title": "HyperlinkButton",
"ApiNamespace": "Microsoft.UI.Xaml.Controls",
"Subtitle": "A button that appears as hyperlink text, and can navigate to a URI or handle a Click event.",
"ImagePath": "ms-appx:///Assets/ControlImages/HyperlinkButton.png",
"Description": "A HyperlinkButton appears as a text hyperlink. When a user clicks it, it opens the page you specify in the NavigateUri property in the default browser. Or you can handle its Click event, typically to navigate within your app.",
"Content": "<p>A <b>HyperlinkButton</b> looks like hyperlink text, but works like a button. You can use it in two ways:</p><ul><li>Set the <b>NavigateUri</b> property. When a user clicks it, it will automatically open the URI in the default browser.</li><li>Handle the <b>Click</b> event. This works just like the <b>Click</b> event of a standard <b>Button</b>, and can be used to navigate within your app.</li></ul><p>Each control page in this app has two sets of hyperlink buttons, one set to open documentation in Internet Explorer, and one set to navigate to related control pages in the app.</p><p>Look at the <i>HyperlinkButtonPage.xaml</i> file in Visual Studio to see the full code for this page.</p>",
"SourcePath": "/CommonStyles/HyperlinkButton_themeresources.xaml",
"Docs": [
{
"Title": "HyperlinkButton - API",
"Uri": "https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/microsoft.ui.xaml.controls.hyperlinkbutton"
},
{
"Title": "Guidelines",
"Uri": "https://learn.microsoft.com/windows/apps/design/controls/hyperlinks"
}
],
"RelatedControls": [
"Button",
"ToggleButton",
"RepeatButton",
"AppBarButton"
]
},
{
"UniqueId": "RepeatButton",
"Title": "RepeatButton",
"ApiNamespace": "Microsoft.UI.Xaml.Controls.Primitives",
"Subtitle": "A button that raises its Click event repeatedly from the time it's pressed until it's released.",
"ImagePath": "ms-appx:///Assets/ControlImages/Button.png",
"Description": "The RepeatButton control is like a standard Button, except that the Click event occurs continuously while the user presses the RepeatButton.",
"Content": "<p>A <b>RepeatButton</b> looks just like a regular <b>Button</b>, but it's <b>Click</b> event occurs continuously while the button is pressed.</p><p>Look at the <i>RepeatButtonPage.xaml</i> file in Visual Studio to see the full code for this page.</p>",
"SourcePath": "/CommonStyles/RepeatButton_themeresources.xaml",
"Docs": [
{
"Title": "RepeatButton - API",
"Uri": "https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/microsoft.ui.xaml.controls.primitives.repeatbutton"
},
{
"Title": "Guidelines",
"Uri": "https://learn.microsoft.com/windows/apps/design/controls/buttons"
}
],
"RelatedControls": [
"Button",
"ToggleButton",
"HyperlinkButton",
"AppBarButton"
]
},
{
"UniqueId": "ToggleButton",
"Title": "ToggleButton",
"ApiNamespace": "Microsoft.UI.Xaml.Controls.Primitives",
"Subtitle": "A button that can be switched between two states like a CheckBox.",
"ImagePath": "ms-appx:///Assets/ControlImages/ToggleButton.png",
"Description": "A ToggleButton looks like a Button, but works like a CheckBox. It typically has two states, checked (on) or unchecked (off), but can be indeterminate if the IsThreeState property is true. You can determine it's state by checking the IsChecked property.",
"Content": "<p><b>ToggleButton</b> is used as a base class for similar controls like <b>CheckBox</b> and <b>RadioButton</b>. It can be used on its own, but don't use it if a <b>CheckBox</b>, <b>RadioButton</b>, or <b>ToggleSwitch</b> would convey your intent better.</p><p>Look at the <i>ToggleButtonPage.xaml</i> file in Visual Studio to see the full code for this page.</p>",
"SourcePath": "/CommonStyles/ToggleButton_themeresources.xaml",
"Docs": [
{
"Title": "ToggleButton - API",
"Uri": "https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/microsoft.ui.xaml.controls.primitives.togglebutton"
},
{
"Title": "Guidelines",
"Uri": "https://learn.microsoft.com/windows/apps/design/controls/buttons#create-a-toggle-split-button"
}
],
"RelatedControls": [
"Button",
"AppBarToggleButton",
"ToggleSwitch",
"CheckBox",
"CommandBarFlyout",
"CommandBar"
]
},
{
"UniqueId": "SplitButton",
"Title": "SplitButton",
"ApiNamespace": "Microsoft.UI.Xaml.Controls",
"Subtitle": "A two-part button that displays a flyout when its secondary part is clicked.",
"ImagePath": "ms-appx:///Assets/ControlImages/SplitButton.png",
"Description": "The splitbutton is a dropdown button, but with an addition execution hit target.",
"IsUpdated": true,
"SourcePath": "/SplitButton",
"Docs": [
{
"Title": "SplitButton - API",
"Uri": "https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/microsoft.ui.xaml.controls.splitbutton"
},
{
"Title": "Guidelines",
"Uri": "https://learn.microsoft.com/windows/apps/design/controls/buttons#create-a-split-button"
}
],
"RelatedControls": [
"Button",
"AppBarToggleButton",
"CommandBar",
"ToggleSwitch",
"CheckBox",
"CommandBarFlyout",
"CommandBar"
]
},
{
"UniqueId": "ToggleSplitButton",
"Title": "ToggleSplitButton",
"ApiNamespace": "Microsoft.UI.Xaml.Controls",
"Subtitle": "A version of the SplitButton where the activation target toggles on/off.",
"ImagePath": "ms-appx:///Assets/ControlImages/ToggleSplitButton.png",
"Description": "A version of the SplitButton where the activation target toggles on/off.",
"SourcePath": "/SplitButton",
"Docs": [
{
"Title": "ToggleSplitButton - API",
"Uri": "https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/microsoft.ui.xaml.controls.togglesplitbutton"
},
{
"Title": "Guidelines",
"Uri": "https://learn.microsoft.com/windows/apps/design/controls/buttons"
}