@@ -3,7 +3,9 @@ namespace Microsoft.Maui.Controls.PlatformConfiguration.AndroidSpecific
3
3
{
4
4
using FormsElement = Maui . Controls . VisualElement ;
5
5
6
- /// <include file="../../../../docs/Microsoft.Maui.Controls.PlatformConfiguration.AndroidSpecific/VisualElement.xml" path="Type[@FullName='Microsoft.Maui.Controls.PlatformConfiguration.AndroidSpecific.VisualElement']/Docs/*" />
6
+ /// <summary>
7
+ /// Controls the legacy color mode and elevation for visual elements on the Android platform.
8
+ /// </summary>
7
9
public static class VisualElement
8
10
{
9
11
#region Elevation
@@ -13,25 +15,42 @@ public static class VisualElement
13
15
BindableProperty . Create ( "Elevation" , typeof ( float ? ) ,
14
16
typeof ( FormsElement ) ) ;
15
17
16
- /// <include file="../../../../docs/Microsoft.Maui.Controls.PlatformConfiguration.AndroidSpecific/VisualElement.xml" path="//Member[@MemberName='GetElevation'][2]/Docs/*" />
18
+ /// <summary>
19
+ /// Gets the elevation for the element.
20
+ /// </summary>
21
+ /// <param name="element">The visual element on the Android platform whose elevation to get.</param>
22
+ /// <returns>The elevation for the element.</returns>
17
23
public static float ? GetElevation ( FormsElement element )
18
24
{
19
25
return ( float ? ) element . GetValue ( ElevationProperty ) ;
20
26
}
21
27
22
- /// <include file="../../../../docs/Microsoft.Maui.Controls.PlatformConfiguration.AndroidSpecific/VisualElement.xml" path="//Member[@MemberName='SetElevation'][2]/Docs/*" />
28
+ /// <summary>
29
+ /// Sets the elevation for the visual element.
30
+ /// </summary>
31
+ /// <param name="element"></param>
32
+ /// <param name="value">The new elevation value.</param>
23
33
public static void SetElevation ( FormsElement element , float ? value )
24
34
{
25
35
element . SetValue ( ElevationProperty , value ) ;
26
36
}
27
37
28
- /// <include file="../../../../docs/Microsoft.Maui.Controls.PlatformConfiguration.AndroidSpecific/VisualElement.xml" path="//Member[@MemberName='GetElevation'][1]/Docs/*" />
38
+ /// <summary>
39
+ /// Gets the elevation for the element.
40
+ /// </summary>
41
+ /// <param name="config">The platform configuration for the visual element on the Android platform whose elevation to get.</param>
42
+ /// <returns>The elevation for the element.</returns>
29
43
public static float ? GetElevation ( this IPlatformElementConfiguration < Android , FormsElement > config )
30
44
{
31
45
return GetElevation ( config . Element ) ;
32
46
}
33
47
34
- /// <include file="../../../../docs/Microsoft.Maui.Controls.PlatformConfiguration.AndroidSpecific/VisualElement.xml" path="//Member[@MemberName='SetElevation'][1]/Docs/*" />
48
+ /// <summary>
49
+ /// Sets the elevation for the visual element.
50
+ /// </summary>
51
+ /// <param name="config">The visual element on the Android platform whose elevation to set.</param>
52
+ /// <param name="value">The new elevation value.</param>
53
+ /// <returns></returns>
35
54
public static IPlatformElementConfiguration < Android , FormsElement > SetElevation ( this IPlatformElementConfiguration < Android , FormsElement > config , float ? value )
36
55
{
37
56
SetElevation ( config . Element , value ) ;
@@ -47,25 +66,42 @@ public static IPlatformElementConfiguration<Android, FormsElement> SetElevation(
47
66
BindableProperty . CreateAttached ( "IsLegacyColorModeEnabled" , typeof ( bool ) ,
48
67
typeof ( FormsElement ) , true ) ;
49
68
50
- /// <include file="../../../../docs/Microsoft.Maui.Controls.PlatformConfiguration.AndroidSpecific/VisualElement.xml" path="//Member[@MemberName='GetIsLegacyColorModeEnabled'][1]/Docs/*" />
69
+ /// <summary>
70
+ /// Gets whether or not the legacy color mode for this element is enabled.
71
+ /// </summary>
72
+ /// <param name="element">The element on the Android platform whose legacy color mode status to get.</param>
73
+ /// <returns><see langword="true"/> if legacy color mode is enabled for this element, otherwise <see langword="false"/>.</returns>
51
74
public static bool GetIsLegacyColorModeEnabled ( BindableObject element )
52
75
{
53
76
return ( bool ) element . GetValue ( IsLegacyColorModeEnabledProperty ) ;
54
77
}
55
78
56
- /// <include file="../../../../docs/Microsoft.Maui.Controls.PlatformConfiguration.AndroidSpecific/VisualElement.xml" path="//Member[@MemberName='SetIsLegacyColorModeEnabled'][1]/Docs/*" />
79
+ /// <summary>
80
+ /// Sets whether or not the legacy color mode for this element is enabled.
81
+ /// </summary>
82
+ /// <param name="element">The platform configuration for the visual element on the Android platform whose legacy color mode status to set.</param>
83
+ /// <param name="value"><see langword="true" /> to enable legacy color mode. Otherwise, <see langword="false" />.</param>
57
84
public static void SetIsLegacyColorModeEnabled ( BindableObject element , bool value )
58
85
{
59
86
element . SetValue ( IsLegacyColorModeEnabledProperty , value ) ;
60
87
}
61
88
62
- /// <include file="../../../../docs/Microsoft.Maui.Controls.PlatformConfiguration.AndroidSpecific/VisualElement.xml" path="//Member[@MemberName='GetIsLegacyColorModeEnabled'][2]/Docs/*" />
89
+ /// <summary>
90
+ /// Gets whether or not the legacy color mode for this element is enabled.
91
+ /// </summary>
92
+ /// <param name="config">The platform configuration for the visual element on the Android platform whose legacy color mode status to get.</param>
93
+ /// <returns><see langword="true"/> if legacy color mode is enabled for this element, otherwise <see langword="false"/>.</returns>
63
94
public static bool GetIsLegacyColorModeEnabled ( this IPlatformElementConfiguration < Android , FormsElement > config )
64
95
{
65
96
return ( bool ) config . Element . GetValue ( IsLegacyColorModeEnabledProperty ) ;
66
97
}
67
98
68
- /// <include file="../../../../docs/Microsoft.Maui.Controls.PlatformConfiguration.AndroidSpecific/VisualElement.xml" path="//Member[@MemberName='SetIsLegacyColorModeEnabled'][2]/Docs/*" />
99
+ /// <summary>
100
+ /// Sets whether or not the legacy color mode for this element is enabled.
101
+ /// </summary>
102
+ /// <param name="config">The platform configuration for the visual element on the Android platform whose legacy color mode status to set.</param>
103
+ /// <param name="value"><see langword="true" /> to enable legacy color mode. Otherwise, <see langword="false" />.</param>
104
+ /// <returns>A fluent object on which the developer may make further method calls.</returns>
69
105
public static IPlatformElementConfiguration < Android , FormsElement > SetIsLegacyColorModeEnabled (
70
106
this IPlatformElementConfiguration < Android , FormsElement > config , bool value )
71
107
{
0 commit comments