Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update VisualElement API Docs #20242

Merged
merged 2 commits into from Jan 30, 2024
Merged

Update VisualElement API Docs #20242

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bb2ec5d
Update VisualElement API Docs
jfversluis Jan 30, 2024
027871d
Undo unrelated change
jfversluis Jan 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
259 changes: 0 additions & 259 deletions ...rols/docs/Microsoft.Maui.Controls.PlatformConfiguration.AndroidSpecific/VisualElement.xml
View file
Open in desktop

This file was deleted.

1,372 changes: 0 additions & 1,372 deletions ...ntrols/docs/Microsoft.Maui.Controls.PlatformConfiguration.TizenSpecific/VisualElement.xml
View file
Open in desktop

This file was deleted.

968 changes: 0 additions & 968 deletions ...Controls/docs/Microsoft.Maui.Controls.PlatformConfiguration.iOSSpecific/VisualElement.xml
View file
Open in desktop

This file was deleted.

54 changes: 45 additions & 9 deletions src/Controls/src/Core/PlatformConfiguration/AndroidSpecific/VisualElement.cs
View file
Open in desktop
Expand Up @@ -3,7 +3,9 @@ namespace Microsoft.Maui.Controls.PlatformConfiguration.AndroidSpecific
{
using FormsElement = Maui.Controls.VisualElement;

/// <include file="../../../../docs/Microsoft.Maui.Controls.PlatformConfiguration.AndroidSpecific/VisualElement.xml" path="Type[@FullName='Microsoft.Maui.Controls.PlatformConfiguration.AndroidSpecific.VisualElement']/Docs/*" />
/// <summary>
/// Controls the legacy color mode and elevation for visual elements on the Android platform.
/// </summary>
public static class VisualElement
{
#region Elevation
Expand All @@ -13,25 +15,42 @@ public static class VisualElement
BindableProperty.Create("Elevation", typeof(float?),
typeof(FormsElement));

/// <include file="../../../../docs/Microsoft.Maui.Controls.PlatformConfiguration.AndroidSpecific/VisualElement.xml" path="//Member[@MemberName='GetElevation'][2]/Docs/*" />
/// <summary>
/// Gets the elevation for the element.
/// </summary>
/// <param name="element">The visual element on the Android platform whose elevation to get.</param>
/// <returns>The elevation for the element.</returns>
public static float? GetElevation(FormsElement element)
{
return (float?)element.GetValue(ElevationProperty);
}

/// <include file="../../../../docs/Microsoft.Maui.Controls.PlatformConfiguration.AndroidSpecific/VisualElement.xml" path="//Member[@MemberName='SetElevation'][2]/Docs/*" />
/// <summary>
/// Sets the elevation for the visual element.
/// </summary>
/// <param name="element"></param>
/// <param name="value">The new elevation value.</param>
public static void SetElevation(FormsElement element, float? value)
{
element.SetValue(ElevationProperty, value);
}

/// <include file="../../../../docs/Microsoft.Maui.Controls.PlatformConfiguration.AndroidSpecific/VisualElement.xml" path="//Member[@MemberName='GetElevation'][1]/Docs/*" />
/// <summary>
/// Gets the elevation for the element.
/// </summary>
/// <param name="config">The platform configuration for the visual element on the Android platform whose elevation to get.</param>
/// <returns>The elevation for the element.</returns>
public static float? GetElevation(this IPlatformElementConfiguration<Android, FormsElement> config)
{
return GetElevation(config.Element);
}

/// <include file="../../../../docs/Microsoft.Maui.Controls.PlatformConfiguration.AndroidSpecific/VisualElement.xml" path="//Member[@MemberName='SetElevation'][1]/Docs/*" />
/// <summary>
/// Sets the elevation for the visual element.
/// </summary>
/// <param name="config">The visual element on the Android platform whose elevation to set.</param>
/// <param name="value">The new elevation value.</param>
/// <returns></returns>
public static IPlatformElementConfiguration<Android, FormsElement> SetElevation(this IPlatformElementConfiguration<Android, FormsElement> config, float? value)
{
SetElevation(config.Element, value);
Expand All @@ -47,25 +66,42 @@ public static void SetElevation(FormsElement element, float? value)
BindableProperty.CreateAttached("IsLegacyColorModeEnabled", typeof(bool),
typeof(FormsElement), true);

/// <include file="../../../../docs/Microsoft.Maui.Controls.PlatformConfiguration.AndroidSpecific/VisualElement.xml" path="//Member[@MemberName='GetIsLegacyColorModeEnabled'][1]/Docs/*" />
/// <summary>
/// Gets whether or not the legacy color mode for this element is enabled.
/// </summary>
/// <param name="element">The element on the Android platform whose legacy color mode status to get.</param>
/// <returns><see langword="true"/> if legacy color mode is enabled for this element, otherwise <see langword="false"/>.</returns>
public static bool GetIsLegacyColorModeEnabled(BindableObject element)
{
return (bool)element.GetValue(IsLegacyColorModeEnabledProperty);
}

/// <include file="../../../../docs/Microsoft.Maui.Controls.PlatformConfiguration.AndroidSpecific/VisualElement.xml" path="//Member[@MemberName='SetIsLegacyColorModeEnabled'][1]/Docs/*" />
/// <summary>
/// Sets whether or not the legacy color mode for this element is enabled.
/// </summary>
/// <param name="element">The platform configuration for the visual element on the Android platform whose legacy color mode status to set.</param>
/// <param name="value"><see langword="true" /> to enable legacy color mode. Otherwise, <see langword="false" />.</param>
public static void SetIsLegacyColorModeEnabled(BindableObject element, bool value)
{
element.SetValue(IsLegacyColorModeEnabledProperty, value);
}

/// <include file="../../../../docs/Microsoft.Maui.Controls.PlatformConfiguration.AndroidSpecific/VisualElement.xml" path="//Member[@MemberName='GetIsLegacyColorModeEnabled'][2]/Docs/*" />
/// <summary>
/// Gets whether or not the legacy color mode for this element is enabled.
/// </summary>
/// <param name="config">The platform configuration for the visual element on the Android platform whose legacy color mode status to get.</param>
/// <returns><see langword="true"/> if legacy color mode is enabled for this element, otherwise <see langword="false"/>.</returns>
public static bool GetIsLegacyColorModeEnabled(this IPlatformElementConfiguration<Android, FormsElement> config)
{
return (bool)config.Element.GetValue(IsLegacyColorModeEnabledProperty);
}

/// <include file="../../../../docs/Microsoft.Maui.Controls.PlatformConfiguration.AndroidSpecific/VisualElement.xml" path="//Member[@MemberName='SetIsLegacyColorModeEnabled'][2]/Docs/*" />
/// <summary>
/// Sets whether or not the legacy color mode for this element is enabled.
/// </summary>
/// <param name="config">The platform configuration for the visual element on the Android platform whose legacy color mode status to set.</param>
/// <param name="value"><see langword="true" /> to enable legacy color mode. Otherwise, <see langword="false" />.</param>
/// <returns>A fluent object on which the developer may make further method calls.</returns>
public static IPlatformElementConfiguration<Android, FormsElement> SetIsLegacyColorModeEnabled(
this IPlatformElementConfiguration<Android, FormsElement> config, bool value)
{
Expand Down