-
Notifications
You must be signed in to change notification settings - Fork 0
/
Stride.UI.xml
4208 lines (4208 loc) · 227 KB
/
Stride.UI.xml
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
<?xml version="1.0"?>
<doc>
<assembly>
<name>Stride.UI</name>
</assembly>
<members>
<member name="M:Stride.UI.Attributes.DefaultThicknessValueAttribute.#ctor(System.Single,System.Single,System.Single,System.Single,System.Single,System.Single)">
<summary>
Initializes a new instance of the Thickness structure that has specific lengths applied to each side of the cuboid.
</summary>
<param name="bottom">The thickness for the lower side of the cuboid.</param>
<param name="left">The thickness for the left side of the cuboid.</param>
<param name="right">The thickness for the right side of the cuboid</param>
<param name="top">The thickness for the upper side of the cuboid.</param>
<param name="front">The thickness for the front side of the cuboid.</param>
<param name="back">The thickness for the Back side of the cuboid.</param>
</member>
<member name="P:Stride.UI.Attributes.DefaultThicknessValueAttribute.Back">
<summary>
The Back side of the bounding cuboid.
</summary>
</member>
<member name="F:Stride.UI.Attributes.DefaultThicknessValueAttribute.Bottom">
<summary>
The bottom side of the bounding rectangle or cuboid.
</summary>
</member>
<member name="P:Stride.UI.Attributes.DefaultThicknessValueAttribute.Front">
<summary>
The front side of the bounding cuboid.
</summary>
</member>
<member name="P:Stride.UI.Attributes.DefaultThicknessValueAttribute.Left">
<summary>
The left side of the bounding rectangle or cuboid.
</summary>
</member>
<member name="P:Stride.UI.Attributes.DefaultThicknessValueAttribute.Right">
<summary>
The right side of the bounding rectangle or cuboid.
</summary>
</member>
<member name="P:Stride.UI.Attributes.DefaultThicknessValueAttribute.Top">
<summary>
The upper side of the bounding rectangle or cuboid.
</summary>
</member>
<member name="T:Stride.UI.ClickMode">
<summary>
Specifies when the Click event should be raised.
</summary>
</member>
<member name="F:Stride.UI.ClickMode.Press">
<summary>
Specifies that the Click event should be raised as soon as a button is pressed.
</summary>
<userdoc>Specifies that the Click event should be raised as soon as a button is pressed.</userdoc>
</member>
<member name="F:Stride.UI.ClickMode.Release">
<summary>
Specifies that the Click event should be raised when a button is pressed and released.
</summary>
<userdoc>Specifies that the Click event should be raised when a button is pressed and released.</userdoc>
</member>
<member name="T:Stride.UI.Controls.Border">
<summary>
A border element adds an uniform color border around its content.
</summary>
</member>
<member name="P:Stride.UI.Controls.Border.BorderColor">
<summary>
Gets or sets the color of the border.
</summary>
<userdoc>The color of the border.</userdoc>
</member>
<member name="P:Stride.UI.Controls.Border.BorderThickness">
<summary>
Gets or sets the thickness of the border.
</summary>
<userdoc>The thickness of the border.</userdoc>
</member>
<member name="T:Stride.UI.Controls.Button">
<summary>
Represents a Windows button control, which reacts to the Click event.
</summary>
</member>
<member name="P:Stride.UI.Controls.Button.IsPressed">
<inheritdoc/>
</member>
<member name="P:Stride.UI.Controls.Button.PressedImage">
<summary>
Gets or sets the image displayed when the button is pressed.
</summary>
<userdoc>Image displayed when the button is pressed.</userdoc>
</member>
<member name="P:Stride.UI.Controls.Button.NotPressedImage">
<summary>
Gets or sets the image displayed when the button is not pressed.
</summary>
<userdoc>Image displayed when the button is not pressed.</userdoc>
</member>
<member name="P:Stride.UI.Controls.Button.MouseOverImage">
<summary>
Gets or sets the image displayed when the mouse hovers over the button.
</summary>
<userdoc>Image displayed when the mouse hovers over the button.</userdoc>
</member>
<member name="P:Stride.UI.Controls.Button.ImageStretchType">
<summary>
Gets or sets a value that describes how the button image should be stretched to fill the destination rectangle.
</summary>
<remarks>This property has no effect is <see cref="P:Stride.UI.Controls.Button.SizeToContent"/> is <c>true</c>.</remarks>
<userdoc>Describes how the button image should be stretched to fill the destination rectangle.</userdoc>
</member>
<member name="P:Stride.UI.Controls.Button.ImageStretchDirection">
<summary>
Gets or sets a value that indicates how the button image is scaled.
</summary>
<remarks>This property has no effect is <see cref="P:Stride.UI.Controls.Button.SizeToContent"/> is <c>true</c>.</remarks>
<userdoc>Indicates how the button image is scaled.</userdoc>
</member>
<member name="P:Stride.UI.Controls.Button.SizeToContent">
<summary>
Gets or sets whether the size depends on the Content. The default is <c>true</c>.
</summary>
<userdoc>True if this button's size depends of its content, false otherwise.</userdoc>
</member>
<member name="M:Stride.UI.Controls.Button.ArrangeOverride(Stride.Core.Mathematics.Vector3)">
<inheritdoc/>
</member>
<member name="M:Stride.UI.Controls.Button.MeasureOverride(Stride.Core.Mathematics.Vector3)">
<inheritdoc/>
</member>
<member name="M:Stride.UI.Controls.Button.OnAspectImageInvalidated">
<summary>
Function triggered when one of the <see cref="P:Stride.UI.Controls.Button.PressedImage"/> and <see cref="P:Stride.UI.Controls.Button.NotPressedImage"/> images are invalidated.
This function can be overridden in inherited classes.
</summary>
</member>
<member name="T:Stride.UI.Controls.ButtonBase">
<summary>
Represents the base primitive for all the button-like controls
</summary>
</member>
<member name="M:Stride.UI.Controls.ButtonBase.#ctor">
<summary>
Create an instance of button.
</summary>
</member>
<member name="P:Stride.UI.Controls.ButtonBase.ClickMode">
<summary>
Gets or sets when the Click event occurs.
</summary>
<userdoc>Indicates when the click event occurs.</userdoc>
</member>
<member name="P:Stride.UI.Controls.ButtonBase.IsPressed">
<summary>
Gets a value that indicates whether the button is currently down.
</summary>
</member>
<member name="E:Stride.UI.Controls.ButtonBase.Click">
<summary>
Occurs when a <see cref="T:Stride.UI.Controls.Button"/> is clicked.
</summary>
<remarks>A click event is bubbling</remarks>
</member>
<member name="F:Stride.UI.Controls.ButtonBase.ClickEvent">
<summary>
Identifies the <see cref="E:Stride.UI.Controls.ButtonBase.Click"/> routed event.
</summary>
</member>
<member name="M:Stride.UI.Controls.ButtonBase.OnClick(Stride.UI.Events.RoutedEventArgs)">
<summary>
The class handler of the event <see cref="E:Stride.UI.Controls.ButtonBase.Click"/>.
This method can be overridden in inherited classes to perform actions common to all instances of a class.
</summary>
<param name="args">The arguments of the event</param>
</member>
<member name="T:Stride.UI.Controls.ContentControl">
<summary>
Represents a control with a single piece of content of any type.
</summary>
</member>
<member name="F:Stride.UI.Controls.ContentControl.ContentArrangeMatrixPropertyKey">
<summary>
The key to the ContentArrangeMatrix dependency property.
</summary>
</member>
<member name="P:Stride.UI.Controls.ContentControl.Content">
<summary>
Gets or sets the content of the ContentControl.
</summary>
<exception cref="T:System.InvalidOperationException">The value passed has already a parent.</exception>
<userdoc>The content of the Content Control.</userdoc>
</member>
<member name="P:Stride.UI.Controls.ContentControl.VisualContent">
<summary>
Gets the visual content of the ContentControl.
</summary>
</member>
<member name="M:Stride.UI.Controls.ContentControl.EnumerateChildren">
<inheritdoc/>
</member>
<member name="T:Stride.UI.Controls.ContentDecorator">
<summary>
A <see cref="T:Stride.UI.Controls.ContentControl"/> decorating its <see cref="P:Stride.UI.Controls.ContentControl.Content"/> with a background image.
</summary>
</member>
<member name="P:Stride.UI.Controls.ContentDecorator.BackgroundImage">
<summary>
Gets or sets the background image.
</summary>
<userdoc>The background image.</userdoc>
</member>
<member name="T:Stride.UI.Controls.ContentPresenter">
<summary>
A class aiming at presenting another <see cref="T:Stride.UI.UIElement"/>.
</summary>
</member>
<member name="P:Stride.UI.Controls.ContentPresenter.Content">
<summary>
Gets or sets the content of the presenter.
</summary>
<userdoc>The content of the presenter.</userdoc>
</member>
<member name="M:Stride.UI.Controls.ContentPresenter.EnumerateChildren">
<inheritdoc/>
</member>
<member name="T:Stride.UI.Controls.Control">
<summary>
Represents the base class for user interface (UI) controls.
</summary>
</member>
<member name="P:Stride.UI.Controls.Control.Padding">
<summary>
Gets or sets the padding inside a control.
</summary>
<userdoc>The padding inside a control.</userdoc>
</member>
<member name="T:Stride.UI.Controls.EditText">
<summary>
Represent an edit text where the user can enter text.
</summary>
</member>
<member name="F:Stride.UI.Controls.EditText.InputTypeFlags.None">
<summary>
No specific input type for the <see cref="T:Stride.UI.Controls.EditText"/>.
</summary>
<userdoc>No specific input type for the Edit Text.</userdoc>
</member>
<member name="F:Stride.UI.Controls.EditText.InputTypeFlags.Password">
<summary>
A password input type. Password text is hidden while editing.
</summary>
<userdoc>A password input type. Password text is hidden while editing.</userdoc>
</member>
<member name="M:Stride.UI.Controls.EditText.OnIsReadOnlyChanged">
<summary>
Function triggered when the value of <see cref="P:Stride.UI.Controls.EditText.IsReadOnly"/> changed.
</summary>
</member>
<member name="M:Stride.UI.Controls.EditText.OnMaxLengthChanged">
<summary>
Function triggered when the value of <see cref="P:Stride.UI.Controls.EditText.MaxLength"/> changed.
</summary>
</member>
<member name="M:Stride.UI.Controls.EditText.OnMaxLinesChanged">
<summary>
Function triggered when the value of <see cref="P:Stride.UI.Controls.EditText.MaxLines"/> changed.
</summary>
</member>
<member name="M:Stride.UI.Controls.EditText.OnMinLinesChanged">
<summary>
Function triggered when the value of <see cref="P:Stride.UI.Controls.EditText.MinLines"/> changed.
</summary>
</member>
<member name="M:Stride.UI.Controls.EditText.#ctor">
<summary>
Create a new instance of <see cref="T:Stride.UI.Controls.EditText"/>.
</summary>
</member>
<member name="P:Stride.UI.Controls.EditText.IsSelectionActive">
<summary>
Gets a value that indicates whether the text box has focus and selected text.
</summary>
</member>
<member name="P:Stride.UI.Controls.EditText.SynchronousCharacterGeneration">
<summary>
Gets or sets the value indicating if the text block should generate <see cref="T:Stride.Graphics.Font.RuntimeRasterizedSpriteFont"/> characters synchronously or asynchronously.
</summary>
<remarks>If synchronous generation is activated, the game will be block until all the characters have finished to be generate.
If asynchronous generation is activated, some characters can appears with one or two frames of delay.</remarks>
<userdoc>True if dynamic characters should be generated synchronously, false otherwise.</userdoc>
</member>
<member name="P:Stride.UI.Controls.EditText.ShouldHideText">
<summary>
Gets a value indicating if the text should be hidden when displayed.
</summary>
</member>
<member name="P:Stride.UI.Controls.EditText.Font">
<summary>
Gets or sets the font of the text block.
</summary>
<userdoc>The font of the text block.</userdoc>
</member>
<member name="P:Stride.UI.Controls.EditText.TextSize">
<summary>
Gets or sets the size of the text in virtual pixels unit.
</summary>
<remarks>The value is coerced in the range [0, <see cref="F:System.Single.MaxValue"/>].</remarks>
<userdoc>The size of the text in virtual pixels unit.</userdoc>
</member>
<member name="P:Stride.UI.Controls.EditText.TextColor">
<summary>
Gets or sets the color of the text.
</summary>
<userdoc>The color of the text.</userdoc>
</member>
<member name="P:Stride.UI.Controls.EditText.TextAlignment">
<summary>
Gets or sets the alignment of the text to display.
</summary>
<userdoc>The alignment of the text to display.</userdoc>
</member>
<member name="P:Stride.UI.Controls.EditText.ActiveImage">
<summary>
Gets or sets the image that is displayed in background when the edit is active.
</summary>
<userdoc>The image that is displayed in background when the edit is active.</userdoc>
</member>
<member name="P:Stride.UI.Controls.EditText.InactiveImage">
<summary>
Gets or sets the image that is displayed in background when the edit is inactive.
</summary>
<userdoc>The image that is displayed in background when the edit is inactive.</userdoc>
</member>
<member name="P:Stride.UI.Controls.EditText.MouseOverImage">
<summary>
Gets or sets the image that the button displays when the mouse is over it.
</summary>
<userdoc>The image that the button displays when the mouse is over it.</userdoc>
</member>
<member name="P:Stride.UI.Controls.EditText.CaretColor">
<summary>
Gets or sets the color of the caret.
</summary>
<userdoc>The color of the caret.</userdoc>
</member>
<member name="P:Stride.UI.Controls.EditText.CaretWidth">
<summary>
Gets or sets the width of the edit text's cursor (in virtual pixels).
</summary>
<remarks>The value is coerced in the range [0, <see cref="F:System.Single.MaxValue"/>].</remarks>
<userdoc>The width of the edit text's cursor (in virtual pixels).</userdoc>
</member>
<member name="P:Stride.UI.Controls.EditText.SelectionColor">
<summary>
Gets or sets the color of the selection.
</summary>
<userdoc>The color of the selection.</userdoc>
</member>
<member name="P:Stride.UI.Controls.EditText.IMESelectionColor">
<summary>
Gets or sets the color of the IME composition selection.
</summary>
<userdoc>The color of the selection.</userdoc>
</member>
<member name="P:Stride.UI.Controls.EditText.IsReadOnly">
<summary>
Gets or sets whether the control is read-only, or not.
</summary>
<userdoc>True if the control is read-only, false otherwise.</userdoc>
</member>
<member name="P:Stride.UI.Controls.EditText.InputType">
<summary>
Gets or sets the edit text input type by setting a combination of <see cref="T:Stride.UI.Controls.EditText.InputTypeFlags"/>.
</summary>
<userdoc>The edit text input type.</userdoc>
</member>
<member name="P:Stride.UI.Controls.EditText.MaxLength">
<summary>
Gets or sets the maximum number of characters that can be manually entered into the text box.
</summary>
<remarks>The value is coerced in the range [1, <see cref="F:System.Int32.MaxValue"/>].</remarks>
<userdoc>The maximum number of characters that can be manually entered into the text box.</userdoc>
</member>
<member name="P:Stride.UI.Controls.EditText.MinLines">
<summary>
Gets or sets the minimum number of visible lines.
</summary>
<remarks>The value is coerced in the range [1, <see cref="F:System.Int32.MaxValue"/>].</remarks>
<userdoc>The minimum number of visible lines.</userdoc>
</member>
<member name="P:Stride.UI.Controls.EditText.MaxLines">
<summary>
Gets or sets the maximum number of visible lines.
</summary>
<remarks>The value is coerced in the range [int, <see cref="F:System.Int32.MaxValue"/>].</remarks>
<userdoc>The maximum number of visible lines.</userdoc>
</member>
<member name="P:Stride.UI.Controls.EditText.DoNotSnapText">
<summary>
Gets or sets the value indicating if the snapping of the <see cref="P:Stride.UI.Controls.EditText.Text"/> of the <see cref="T:Stride.UI.Controls.TextBlock"/> to the closest screen pixel should be skipped.
</summary>
<remarks>When <value>true</value>, the element's text is never snapped.
When <value>false</value>, it is snapped only if the font is dynamic and the element is rendered by a SceneUIRenderer.</remarks>
<userdoc>True if the snapping of the Text to the closest screen pixel should be skipped, false otherwise.</userdoc>
</member>
<member name="P:Stride.UI.Controls.EditText.CaretFrequency">
<summary>
Gets or sets the caret blinking frequency.
</summary>
<remarks>The value is coerced in the range [0, <see cref="F:System.Single.MaxValue"/>].</remarks>
<userdoc>The caret blinking frequency.</userdoc>
</member>
<member name="P:Stride.UI.Controls.EditText.CaretPosition">
<summary>
Gets or sets the caret position in the <see cref="T:Stride.UI.Controls.EditText"/>'s text.
</summary>
<userdoc>The caret position.</userdoc>
</member>
<member name="P:Stride.UI.Controls.EditText.IsCaretVisible">
<summary>
Gets the value indicating if the blinking caret is currently visible or not.
</summary>
</member>
<member name="M:Stride.UI.Controls.EditText.ResetCaretBlinking">
<summary>
Reset the caret blinking to initial state (visible).
</summary>
</member>
<member name="P:Stride.UI.Controls.EditText.LineCount">
<summary>
Gets the total number of lines in the text box.
</summary>
</member>
<member name="P:Stride.UI.Controls.EditText.CharacterFilterPredicate">
<summary>
Gets or sets the filter used to determine whether the inputed characters are valid or not.
Accepted character are characters that the provided predicate function returns <value>true</value>.
</summary>
<remarks>If <see cref="P:Stride.UI.Controls.EditText.CharacterFilterPredicate"/> is not set all characters are accepted.</remarks>
</member>
<member name="P:Stride.UI.Controls.EditText.SelectedText">
<summary>
Gets or sets the content of the current selection in the text box.
</summary>
<exception cref="T:System.ArgumentNullException">The provided string value is null</exception>
</member>
<member name="P:Stride.UI.Controls.EditText.SelectionLength">
<summary>
Gets or sets a value indicating the number of characters in the current selection in the text box.
</summary>
<remarks>If the provided length of the selection is too big, the selection is extended until the end of the current text</remarks>
</member>
<member name="P:Stride.UI.Controls.EditText.SelectionStart">
<summary>
Gets or sets a character index for the beginning of the current selection.
</summary>
<remarks>If the provided selection start index is too big, the caret is placed at the end of the current text</remarks>
</member>
<member name="P:Stride.UI.Controls.EditText.Text">
<summary>
Gets or sets the text content of the text box.
</summary>
<remarks>Setting explicitly the text sets the cursor at the end of the new text.</remarks>
<userdoc>The text content of the text box.</userdoc>
</member>
<member name="P:Stride.UI.Controls.EditText.IsTouchedDown">
<summary>
Gets a value that indicates whether the is currently touched down.
</summary>
</member>
<member name="P:Stride.UI.Controls.EditText.ActualTextSize">
<summary>
Returns the actual size of the text in virtual pixels unit.
</summary>
<remarks>If <see cref="P:Stride.UI.Controls.EditText.TextSize"/> is <see cref="M:System.Single.IsNaN(System.Single)"/>, returns the default size of the <see cref="P:Stride.UI.Controls.EditText.Font"/>.</remarks>
<seealso cref="P:Stride.UI.Controls.EditText.TextSize"/>
<seealso cref="P:Stride.Graphics.SpriteFont.Size"/>
</member>
<member name="P:Stride.UI.Controls.EditText.TextToDisplay">
<summary>
The actual text to show into the edit text.
</summary>
</member>
<member name="M:Stride.UI.Controls.EditText.AppendText(System.String)">
<summary>
Appends a string to the contents of a text control.
</summary>
<param name="textData">A string that specifies the text to append to the current contents of the text control.</param>
</member>
<member name="M:Stride.UI.Controls.EditText.SelectAll(System.Boolean)">
<summary>
Selects all the contents of the text editing control.
</summary>
<param name="caretAtBeginning">Indicate if the caret should be at the beginning or the end of the selection</param>
</member>
<member name="M:Stride.UI.Controls.EditText.Clear">
<summary>
Clears all the content from the text box.
</summary>
</member>
<member name="M:Stride.UI.Controls.EditText.Select(System.Int32,System.Int32,System.Boolean)">
<summary>
Selects a range of text in the text box.
</summary>
<param name="start">The zero-based character index of the first character in the selection.</param>
<param name="length">The length of the selection, in characters.</param>
<param name="caretAtBeginning">Indicate if the caret should be at the beginning or the end of the selection</param>
<remarks>If the value of start is too big the caret is positioned at the end of the current text.
If the value of length is too big the selection is extended to the end current text.</remarks>
</member>
<member name="M:Stride.UI.Controls.EditText.CalculateTextSize">
<summary>
Calculate and returns the size of the <see cref="P:Stride.UI.Controls.EditText.Text"/> in virtual pixels size.
</summary>
<returns>The size of the Text in virtual pixels.</returns>
</member>
<member name="M:Stride.UI.Controls.EditText.CalculateTextSize(System.String)">
<summary>
Calculate and returns the size of the provided <paramref name="textToMeasure"/>"/> in virtual pixels size.
</summary>
<param name="textToMeasure">The text to measure</param>
<returns>The size of the text in virtual pixels</returns>
</member>
<member name="E:Stride.UI.Controls.EditText.TextChanged">
<summary>
Occurs when the text selection has changed.
</summary>
<remarks>A click event is bubbling</remarks>
</member>
<member name="F:Stride.UI.Controls.EditText.TextChangedEvent">
<summary>
Identifies the <see cref="E:Stride.UI.Controls.EditText.TextChanged"/> routed event.
</summary>
</member>
<member name="M:Stride.UI.Controls.EditText.OnTextChanged(Stride.UI.Events.RoutedEventArgs)">
<summary>
The class handler of the event <see cref="E:Stride.UI.Controls.EditText.TextChanged"/>.
This method can be overridden in inherited classes to perform actions common to all instances of a class.
</summary>
<param name="args">The arguments of the event</param>
</member>
<member name="M:Stride.UI.Controls.EditText.FindNearestCharacterIndex(Stride.Core.Mathematics.Vector2)">
<summary>
Find the index of the nearest character to the provided position.
</summary>
<param name="position">The position in edit text space</param>
<returns>The 0-based index of the nearest character</returns>
</member>
<member name="T:Stride.UI.Controls.ImageButton">
<summary>
A <see cref="T:Stride.UI.Controls.Button"/> whose <see cref="P:Stride.UI.Controls.ContentControl.Content"/> are the <see cref="P:Stride.UI.Controls.Button.PressedImage"/> and <see cref="P:Stride.UI.Controls.Button.NotPressedImage"/>.
</summary>
</member>
<member name="P:Stride.UI.Controls.ImageButton.Content">
<summary>
The current content of the <see cref="T:Stride.UI.Controls.ImageButton"/>, that is the current image used.
</summary>
<remarks>The <see cref="P:Stride.UI.Controls.ImageButton.Content"/> of a <see cref="T:Stride.UI.Controls.ImageButton"/> is determined by its state (pressed/not pressed) and the value of
<see cref="P:Stride.UI.Controls.Button.PressedImage"/> and <see cref="P:Stride.UI.Controls.Button.NotPressedImage"/>.
The <see cref="P:Stride.UI.Controls.ImageButton.Content"/> cannot be set manually by the user.</remarks>
<exception cref="T:System.InvalidOperationException">The user tried to modify the <see cref="T:Stride.UI.Controls.ImageButton"/> content.</exception>
</member>
<member name="T:Stride.UI.Controls.ImageElement">
<summary>
Represents a control that displays an image.
</summary>
</member>
<member name="P:Stride.UI.Controls.ImageElement.Source">
<summary>
Gets or sets the <see cref="T:Stride.Engine.ISpriteProvider"/> for the image.
</summary>
<userdoc>The provider for the image.</userdoc>
</member>
<member name="P:Stride.UI.Controls.ImageElement.Color">
<summary>
Gets or set the color used to tint the image. Default value is White/>.
</summary>
<remarks>The initial image color is multiplied by this color.</remarks>
<userdoc>The color used to tint the image. The default value is white.</userdoc>
</member>
<member name="P:Stride.UI.Controls.ImageElement.StretchType">
<summary>
Gets or sets a value that describes how the image should be stretched to fill the destination rectangle.
</summary>
<userdoc>Indicates how the image should be stretched to fill the destination rectangle.</userdoc>
</member>
<member name="P:Stride.UI.Controls.ImageElement.StretchDirection">
<summary>
Gets or sets a value that indicates how the image is scaled.
</summary>
<userdoc>Indicates how the image is scaled.</userdoc>
</member>
<member name="T:Stride.UI.Controls.ModalElement">
<summary>
Represents a modal element that puts an overlay upon the underneath elements and freeze their input.
</summary>
</member>
<member name="E:Stride.UI.Controls.ModalElement.OutsideClick">
<summary>
Occurs when the element is modal and the user click outside of the modal element.
</summary>
<remarks>A click event is bubbling</remarks>
</member>
<member name="F:Stride.UI.Controls.ModalElement.OutsideClickEvent">
<summary>
Identifies the <see cref="E:Stride.UI.Controls.ModalElement.OutsideClick"/> routed event.
</summary>
</member>
<member name="P:Stride.UI.Controls.ModalElement.OverlayColor">
<summary>
The color of the overlay drawn upon underneath elements.
</summary>
<userdoc>he color of the overlay drawn upon underneath elements.</userdoc>
<userdoc>he color of the overlay drawn upon underneath elements.</userdoc>
</member>
<member name="P:Stride.UI.Controls.ModalElement.IsModal">
<summary>
Determine if the control should block the input of underneath elements or not.
</summary>
<userdoc>True if the control should block the input of underneath elements, false otherwise.</userdoc>
</member>
<member name="T:Stride.UI.Controls.ScrollBar">
<summary>
Represents a scroll bar.
</summary>
</member>
<member name="P:Stride.UI.Controls.ScrollBar.BarColor">
<summary>
The color of the bar.
</summary>
<userdoc>The color of the bar.</userdoc>
</member>
<member name="T:Stride.UI.Controls.ScrollingText">
<summary>
A text viewer that scrolls automatically the text from right to left.
</summary>
</member>
<member name="F:Stride.UI.Controls.ScrollingText.nextLetterIndex">
<summary>
The index in <see cref="P:Stride.UI.Controls.TextBlock.Text"/> defining the position of the next letter to add to <see cref="P:Stride.UI.Controls.ScrollingText.TextToDisplay"/>.
</summary>
</member>
<member name="P:Stride.UI.Controls.ScrollingText.ScrollingOffset">
<summary>
The current offset of the text in the Ox axis.
</summary>
</member>
<member name="P:Stride.UI.Controls.ScrollingText.AccumulatedWidth">
<summary>
The total accumulated width of the scrolling text since the last call the <see cref="M:Stride.UI.Controls.ScrollingText.ResetDisplayingText"/>
</summary>
</member>
<member name="P:Stride.UI.Controls.ScrollingText.ScrollingSpeed">
<summary>
Gets or sets the scrolling speed of the text. The unit is in virtual pixels.
</summary>
<remarks>The value is coerced in the range [0, <see cref="F:System.Single.MaxValue"/>].</remarks>
<userdoc>The scrolling speed of the text. The unit is in virtual pixels.</userdoc>
</member>
<member name="P:Stride.UI.Controls.ScrollingText.DesiredCharacterNumber">
<summary>
Gets or sets the desired number of character in average to display at a given time. This value is taken in account during the measurement stage of the element.
</summary>
<userdoc>The desired number of character in average to display at a given time. This value is taken in account during the measurement stage of the element.</userdoc>
</member>
<member name="P:Stride.UI.Controls.ScrollingText.RepeatText">
<summary>
Gets or sets the a value indicating if the text message must be repeated (wrapped) or not.
</summary>
<userdoc>True if the text message must be repeated (wrapped), false otherwise.</userdoc>
</member>
<member name="M:Stride.UI.Controls.ScrollingText.AppendText(System.String)">
<summary>
Append the provided text to the end of the current <see cref="P:Stride.UI.Controls.TextBlock.Text"/> without restarting the display to the begin of the <see cref="P:Stride.UI.Controls.TextBlock.Text"/>.
</summary>
<param name="text">The text to append</param>
</member>
<member name="M:Stride.UI.Controls.ScrollingText.ClearText">
<summary>
Clear the currently scrolling text.
</summary>
</member>
<member name="M:Stride.UI.Controls.ScrollingText.CalculateTextToDisplayWidth">
<summary>
Calculate the width of the text to display in virtual pixels size.
</summary>
<returns>The size of the text in virtual pixels</returns>
</member>
<member name="M:Stride.UI.Controls.ScrollingText.MeasureSize">
<summary>
Measure the size of the <see cref="T:Stride.UI.Controls.ScrollingText"/> element.
</summary>
<returns>The size of the element</returns>
</member>
<member name="T:Stride.UI.Controls.ScrollViewer">
<summary>
Represents a scroll viewer.
A scroll viewer element has an infinite virtual size defined by its <see cref="T:Stride.UI.ScrollingMode"/>.
The user can move in that virtual size by touching and panning on the screen.
</summary>
</member>
<member name="F:Stride.UI.Controls.ScrollViewer.ScrollOffsets">
<summary>
The current offsets (in virtual pixels) generated by the scrolling on the <see cref="P:Stride.UI.Controls.ContentControl.Content"/> element.
</summary>
</member>
<member name="F:Stride.UI.Controls.ScrollViewer.CurrentScrollingSpeed">
<summary>
The current speed of the scrolling in virtual pixels.
</summary>
</member>
<member name="P:Stride.UI.Controls.ScrollViewer.IsUserScrollingViewer">
<summary>
Indicate if the user is currently touching the scroll viewer and performing a scroll gesture with its finger.
</summary>
</member>
<member name="P:Stride.UI.Controls.ScrollViewer.ViewPort">
<summary>
The viewport of the <see cref="T:Stride.UI.Controls.ScrollViewer"/> in virtual pixels.
</summary>
</member>
<member name="P:Stride.UI.Controls.ScrollViewer.ScrollBarColor">
<summary>
Gets or sets the color of the scrolling bar.
</summary>
<userdoc>The color of the scrolling bar.</userdoc>
</member>
<member name="P:Stride.UI.Controls.ScrollViewer.ScrollBarThickness">
<summary>
Gets or sets the scrolling bar thickness in virtual pixels.
</summary>
<userdoc>The scrolling bar thickness in virtual pixels.</userdoc>
</member>
<member name="P:Stride.UI.Controls.ScrollViewer.ScrollMode">
<summary>
The viewer allowed scrolling mode.
</summary>
<userdoc>The viewer allowed scrolling mode.</userdoc>
</member>
<member name="P:Stride.UI.Controls.ScrollViewer.ScrollStartThreshold">
<summary>
Gets or sets the threshold distance over which a touch move starts scrolling.
</summary>
<userdoc>The threshold distance over which a touch move starts scrolling.</userdoc>
</member>
<member name="P:Stride.UI.Controls.ScrollViewer.Deceleration">
<summary>
The automatic deceleration of the scroll after the user remove its finger from the screen. The unit is in virtual pixels.
</summary>
<userdoc>The automatic deceleration of the scroll after the user remove its finger from the screen. The unit is in virtual pixels.</userdoc>
</member>
<member name="P:Stride.UI.Controls.ScrollViewer.TouchScrollingEnabled">
<summary>
Gets or sets the scrolling behavior on touches. True to allow the user to scroll by touching, false to forbid it.
</summary>
<userdoc>True to allow the user to scroll by touching, false to forbid it.</userdoc>
</member>
<member name="P:Stride.UI.Controls.ScrollViewer.SnapToAnchors">
<summary>
Gets or sets the value indicating if the element should snap its scrolling to anchors.
</summary>
<remarks>Snapping will work only if <see cref="P:Stride.UI.Controls.ScrollViewer.Content"/> implements interface <see cref="T:Stride.UI.IScrollAnchorInfo"/></remarks>
<userdoc>True if the element should snap its scrolling to anchors, false otherwise.</userdoc>
</member>
<member name="P:Stride.UI.Controls.ScrollViewer.ContentAsScrollInfo">
<summary>
The current content casted as <see cref="T:Stride.UI.IScrollInfo"/>.
</summary>
<remarks><value>Null</value> if the <see cref="P:Stride.UI.Controls.ScrollViewer.Content"/> does not implement the interface</remarks>
</member>
<member name="P:Stride.UI.Controls.ScrollViewer.ContentAsAnchorInfo">
<summary>
The current content casted as <see cref="T:Stride.UI.IScrollAnchorInfo"/>
</summary>
<remarks><value>Null</value> if the <see cref="P:Stride.UI.Controls.ScrollViewer.Content"/> does not implement the interface</remarks>
</member>
<member name="P:Stride.UI.Controls.ScrollViewer.ScrollPosition">
<summary>
The current scroll position (in virtual pixels) of the <see cref="T:Stride.UI.Controls.ScrollViewer"/>.
That is, the position of the left-top-front corner of the <see cref="T:Stride.UI.Controls.ScrollViewer"/> in its <see cref="P:Stride.UI.Controls.ScrollViewer.Content"/>.
</summary>
<remarks>
<para>If the <see cref="P:Stride.UI.Controls.ScrollViewer.Content"/> of the scroll viewer implements the <see cref="T:Stride.UI.IScrollInfo"/> interface,
the <see cref="P:Stride.UI.Controls.ScrollViewer.ScrollPosition"/> will be <value>0</value> in all directions where <see cref="M:Stride.UI.IScrollInfo.CanScroll(Stride.UI.Orientation)"/> is true.</para>
<para>Note that <see cref="P:Stride.UI.Controls.ScrollViewer.ScrollPosition"/> is valid only when <see cref="P:Stride.UI.UIElement.IsArrangeValid"/> is <value>true</value>.
If <see cref="P:Stride.UI.UIElement.IsArrangeValid"/> is <value>false</value>, <see cref="P:Stride.UI.Controls.ScrollViewer.ScrollPosition"/> contains the position of the scrolling
before the action that actually invalidated the layout.</para>
</remarks>
</member>
<member name="F:Stride.UI.Controls.ScrollViewer.scrollingRequests">
<summary>
The list of scrolling requests that need to be performed during the next <see cref="M:Stride.UI.Controls.ScrollViewer.ArrangeOverride(Stride.Core.Mathematics.Vector3)"/>
</summary>
</member>
<member name="M:Stride.UI.Controls.ScrollViewer.StopCurrentScrolling">
<summary>
Stops the scrolling at the current position.
</summary>
</member>
<member name="M:Stride.UI.Controls.ScrollViewer.CanScroll(Stride.UI.Orientation)">
<summary>
Indicate if the scroll viewer can scroll in the given direction.
</summary>
<param name="direction">The direction to use for the test</param>
<returns><value>true</value> if the scroll viewer can scroll in the provided direction, or else <value>false</value></returns>
</member>
<member name="M:Stride.UI.Controls.ScrollViewer.OnScrollModeChanged">
<summary>
Method triggered when <see cref="P:Stride.UI.Controls.ScrollViewer.ScrollMode"/> changed.
Can be overridden in inherited class to change the default behavior.
</summary>
</member>
<member name="M:Stride.UI.Controls.ScrollViewer.OnTouchScrollingEnabledChanged">
<summary>
Method triggered when <see cref="P:Stride.UI.Controls.ScrollViewer.TouchScrollingEnabled"/> changed.
Can be overridden in inherited class to change the default behavior.
</summary>
</member>
<member name="P:Stride.UI.Controls.ScrollViewer.LastFrameTranslation">
<summary>
Gets the scrolling translation that occurred during the last frame
</summary>
</member>
<member name="P:Stride.UI.Controls.ScrollViewer.IsTouchedDown">
<summary>
Gets a value that indicates whether the is currently touched down.
</summary>
</member>
<member name="M:Stride.UI.Controls.ScrollViewer.ScrollToBeginning(Stride.UI.Orientation,System.Boolean)">
<summary>
Go to the beginning of the scroll viewer's content in the provided direction.
</summary>
<param name="direction">The direction in which to scroll</param>
<param name="stopScrolling">Indicate if the scrolling should be stopped after the scroll action.</param>
</member>
<member name="M:Stride.UI.Controls.ScrollViewer.ScrollToEnd(Stride.UI.Orientation,System.Boolean)">
<summary>
Go to the end of the scroll viewer's content in the provided direction.
</summary>
<param name="direction">The direction in which to scroll</param>
<param name="stopScrolling">Indicate if the scrolling should be stopped after the scroll action.</param>
</member>
<member name="M:Stride.UI.Controls.ScrollViewer.ScrollTo(Stride.Core.Mathematics.Vector3,System.Boolean)">
<summary>
Try to scroll to the provided position (in virtual pixels).
If the provided translation is too important, it is clamped.
</summary>
<remarks>Note that the computational cost of <see cref="M:Stride.UI.Controls.ScrollViewer.ScrollTo(Stride.Core.Mathematics.Vector3,System.Boolean)"/> can be greatly higher than <see cref="M:Stride.UI.Controls.ScrollViewer.ScrollOf(Stride.Core.Mathematics.Vector3,System.Boolean)"/>
when scrolling is delegated to a <see cref="P:Stride.UI.Controls.ScrollViewer.Content"/> virtualizing its items. When possible, prefer call to <see cref="M:Stride.UI.Controls.ScrollViewer.ScrollOf(Stride.Core.Mathematics.Vector3,System.Boolean)"/></remarks>
<param name="scrollAbsolutePosition">The scroll offsets to apply</param>
<param name="stopScrolling">Indicate if the scrolling should be stopped after the scroll action.</param>
</member>
<member name="M:Stride.UI.Controls.ScrollViewer.ScrollOf(Stride.Core.Mathematics.Vector3,System.Boolean)">
<summary>
Try to scroll of the provided scrolling translation value from the current position.
If the provided translation is too important, it is clamped.
</summary>
<param name="scrollTranslation">The scroll translation to perform (in virtual pixels)</param>
<param name="stopScrolling">Indicate if the scrolling should be stopped after the scroll action.</param>
</member>
<member name="M:Stride.UI.Controls.ScrollViewer.InvalidateScrollInfo">
<summary>
Called by an <see cref="T:Stride.UI.IScrollInfo"/> interface that is attached to a <see cref="T:Stride.UI.Controls.ScrollViewer"/> when the value of any scrolling property size changes.
Scrolling properties include offset, extent, or viewport.
</summary>
</member>
<member name="M:Stride.UI.Controls.ScrollViewer.InvalidateAnchorInfo">
<summary>
Called by an <see cref="T:Stride.UI.IScrollAnchorInfo"/> interface that attached to a <see cref="T:Stride.UI.Controls.ScrollViewer"/> when the value of any anchor changed.
</summary>
</member>
<member name="T:Stride.UI.Controls.Slider">
<summary>
Represents a slider element.
</summary>
</member>
<member name="M:Stride.UI.Controls.Slider.#ctor">
<summary>
Create a new instance of slider.
</summary>
</member>
<member name="P:Stride.UI.Controls.Slider.Value">
<summary>
Gets or sets the current value of the slider.
</summary>
<remarks>The value is coerced in the range [<see cref="P:Stride.UI.Controls.Slider.Minimum"/>, <see cref="P:Stride.UI.Controls.Slider.Maximum"/>].</remarks>
<userdoc>The current value of the slider.</userdoc>
</member>
<member name="P:Stride.UI.Controls.Slider.Minimum">
<summary>
Gets or sets the smallest possible value of the slider.
</summary>
<remarks>The value is coerced in the range [<see cref="F:System.Single.MinValue"/>, <see cref="F:System.Single.MaxValue"/>].</remarks>
<userdoc>The smallest possible value of the slider.</userdoc>
</member>
<member name="P:Stride.UI.Controls.Slider.Maximum">
<summary>
Gets or sets the greatest possible value of the slider.
</summary>
<remarks>The value is coerced in the range [<see cref="P:Stride.UI.Controls.Slider.Minimum"/>, <see cref="F:System.Single.MaxValue"/>].</remarks>
<userdoc>The greatest possible value of the slider.</userdoc>
</member>
<member name="P:Stride.UI.Controls.Slider.Step">
<summary>
Gets or sets the step of a <see cref="P:Stride.UI.Controls.Slider.Value"/> change.
</summary>
<remarks>The value is coerced in the range [0, <see cref="F:System.Single.MaxValue"/>].</remarks>
<userdoc>The step of a change of the value.</userdoc>
</member>
<member name="P:Stride.UI.Controls.Slider.TrackBackgroundImage">
<summary>
Gets or sets the image to display as Track background.
</summary>
<userdoc>The image to display as Track background.</userdoc>
</member>
<member name="P:Stride.UI.Controls.Slider.TrackForegroundImage">
<summary>
Gets or sets the image to display as Track foreground.
</summary>
<userdoc>The image to display as Track foreground.</userdoc>
</member>
<member name="P:Stride.UI.Controls.Slider.TrackStartingOffsets">
<summary>
Gets or sets the left/right offsets specifying where the track region starts.
</summary>
<userdoc>The left/right offsets specifying where the track region starts. </userdoc>
</member>
<member name="P:Stride.UI.Controls.Slider.ThumbImage">
<summary>
Gets or sets the image to display as slider thumb (button).
</summary>
<userdoc>The image to display as slider thumb (button).</userdoc>
</member>
<member name="P:Stride.UI.Controls.Slider.MouseOverThumbImage">
<summary>
Gets or sets the image to display as slider thumb (button) when the mouse is over the slider.
</summary>
<userdoc>The image to display as slider thumb (button) when the mouse is over the slider.</userdoc>
</member>
<member name="P:Stride.UI.Controls.Slider.TickImage">
<summary>
Gets or sets the image to display as tick.
</summary>
<userdoc>The image to display as tick.</userdoc>
</member>
<member name="P:Stride.UI.Controls.Slider.AreTicksDisplayed">
<summary>
Gets or sets the value indicating if the ticks should be displayed or not.
</summary>
<userdoc>True if the ticks should be displayed, false otherwise.</userdoc>
</member>
<member name="P:Stride.UI.Controls.Slider.TickFrequency">
<summary>
Gets or sets the frequency of the ticks on the slider track.
</summary>
<remarks>The value is coerced in the range [1, <see cref="F:System.Single.MaxValue"/>].</remarks>
<userdoc>The frequency of the ticks on the slider track.</userdoc>
</member>
<member name="P:Stride.UI.Controls.Slider.TickOffset">
<summary>
Gets or sets the offset in virtual pixels between the center of the track and center of the ticks (for an not-stretched slider).
</summary>
<remarks>The value is coerced in the range [0, <see cref="F:System.Single.MaxValue"/>].</remarks>
<userdoc>The offset in virtual pixels between the center of the track and center of the ticks (for an not-stretched slider).</userdoc>
</member>
<member name="P:Stride.UI.Controls.Slider.ShouldSnapToTicks">
<summary>
Gets or sets the value indicating if the slider <see cref="P:Stride.UI.Controls.Slider.Value"/> should be snapped to the ticks or not.
</summary>
<userdoc>True if the slider valuye should be snapped to the ticks, false otherwise.</userdoc>
</member>
<member name="P:Stride.UI.Controls.Slider.IsDirectionReversed">
<summary>
Gets or sets the value indicating if the default direction of the slider should reversed or not.
</summary>
<userdoc>True if the default direction of the slider should reversed, false otherwise.</userdoc>
</member>
<member name="P:Stride.UI.Controls.Slider.Orientation">
<summary>
Gets or sets the orientation of the slider.
</summary>
<userdoc>The orientation of the slider.</userdoc>
</member>
<member name="P:Stride.UI.Controls.Slider.IsTouchedDown">
<summary>
Gets a value that indicates whether the is currently touched down.
</summary>
</member>
<member name="M:Stride.UI.Controls.Slider.SnapToClosestTick">
<summary>
Snap the current <see cref="P:Stride.UI.Controls.Slider.Value"/> to the closest tick.
</summary>
</member>
<member name="M:Stride.UI.Controls.Slider.CalculateClosestTick(System.Single)">
<summary>
Calculate the value of the closest tick to the provided value.
</summary>