diff --git a/src/Controls/docs/Microsoft.Maui.Controls.PlatformConfiguration.WindowsSpecific/Page.xml b/src/Controls/docs/Microsoft.Maui.Controls.PlatformConfiguration.WindowsSpecific/Page.xml
deleted file mode 100644
index 688b903263e0..000000000000
--- a/src/Controls/docs/Microsoft.Maui.Controls.PlatformConfiguration.WindowsSpecific/Page.xml
+++ /dev/null
@@ -1,252 +0,0 @@
-
-
-
-
-
-
- Microsoft.Maui.Controls.Core
- 0.0.0.0
- 2.0.0.0
-
-
- System.Object
-
-
-
- The page instance that Microsoft.Maui.Controls created on the Windows platform.
- To be added.
-
-
-
-
-
-
-
- Method
-
- Microsoft.Maui.Controls.Core
- 2.0.0.0
-
-
- System.Boolean
-
-
-
-
-
- To be added.
- To be added.
- To be added.
- To be added.
-
-
-
-
-
-
-
- Method
-
- Microsoft.Maui.Controls.Core
- 2.0.0.0
-
-
- System.Boolean
-
-
-
-
-
- To be added.
- To be added.
- To be added.
- To be added.
-
-
-
-
-
-
-
- Method
-
- 0.0.0.0
- 2.0.0.0
- Microsoft.Maui.Controls.Core
-
-
- Microsoft.Maui.Controls.PlatformConfiguration.WindowsSpecific.ToolbarPlacement
-
-
-
-
-
- The platform specific element on which to perform the operation.
- Returns a value that controls the placement of the toolbar.
- A value that controls the placement of the toolbar.
- To be added.
-
-
-
-
-
-
-
- Method
-
- 0.0.0.0
- 2.0.0.0
- Microsoft.Maui.Controls.Core
-
-
- Microsoft.Maui.Controls.PlatformConfiguration.WindowsSpecific.ToolbarPlacement
-
-
-
-
-
- The platform specific configuration that contains the element on which to perform the operation.
- Returns a value that controls the placement of the toolbar.
- A value that controls the placement of the toolbar.
- To be added.
-
-
-
-
-
-
-
- Method
-
- Microsoft.Maui.Controls.Core
- 2.0.0.0
-
-
- System.Void
-
-
-
-
-
-
- To be added.
- To be added.
- To be added.
- To be added.
-
-
-
-
-
-
-
- Method
-
- Microsoft.Maui.Controls.Core
- 2.0.0.0
-
-
- Microsoft.Maui.Controls.IPlatformElementConfiguration<Microsoft.Maui.Controls.PlatformConfiguration.Windows,Microsoft.Maui.Controls.Page>
-
-
-
-
-
-
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
-
-
-
-
-
-
-
- Method
-
- 0.0.0.0
- 2.0.0.0
- Microsoft.Maui.Controls.Core
-
-
- System.Void
-
-
-
-
-
-
- The platform specific element on which to perform the operation.
- The new toolbar placement.
- Sets a value that controls the placement of the toolbar.
- To be added.
-
-
-
-
-
-
-
- Method
-
- 0.0.0.0
- 2.0.0.0
- Microsoft.Maui.Controls.Core
-
-
- Microsoft.Maui.Controls.IPlatformElementConfiguration<Microsoft.Maui.Controls.PlatformConfiguration.Windows,Microsoft.Maui.Controls.Page>
-
-
-
-
-
-
- The platform specific configuration that contains the element on which to perform the operation.
- The new property value to assign.
- Sets a value that controls the placement of the toolbar.
- The updated configuration object on which developers can make successive method calls.
- To be added.
-
-
-
-
-
-
-
- Field
-
- Microsoft.Maui.Controls.Core
- 2.0.0.0
-
-
- Microsoft.Maui.Controls.BindableProperty
-
-
- To be added.
- To be added.
-
-
-
-
-
-
-
- Field
-
- 0.0.0.0
- 2.0.0.0
- Microsoft.Maui.Controls.Core
-
-
- Microsoft.Maui.Controls.BindableProperty
-
-
- Backing store for the attached property that controls the placement of the toolbar.
- To be added.
-
-
-
-
diff --git a/src/Controls/docs/Microsoft.Maui.Controls.PlatformConfiguration.iOSSpecific/Page.xml b/src/Controls/docs/Microsoft.Maui.Controls.PlatformConfiguration.iOSSpecific/Page.xml
deleted file mode 100644
index eb4a21a68de2..000000000000
--- a/src/Controls/docs/Microsoft.Maui.Controls.PlatformConfiguration.iOSSpecific/Page.xml
+++ /dev/null
@@ -1,797 +0,0 @@
-
-
-
-
-
-
- Microsoft.Maui.Controls.Core
- 0.0.0.0
- 2.0.0.0
-
-
- System.Object
-
-
-
- The page instance that Microsoft.Maui.Controls created on the iOS platform.
- To be added.
-
-
-
-
-
-
-
- Method
-
- 0.0.0.0
- 2.0.0.0
- Microsoft.Maui.Controls.Core
-
-
- Microsoft.Maui.Controls.PlatformConfiguration.iOSSpecific.LargeTitleDisplayMode
-
-
-
-
-
- The element whose large title display preferences to get.
- Returns the large title display preferences for .
- The large title display preferences for .
- To be added.
-
-
-
-
-
-
-
- Method
-
- Microsoft.Maui.Controls.Core
- 2.0.0.0
-
-
- Microsoft.Maui.Controls.PlatformConfiguration.iOSSpecific.UIModalPresentationStyle
-
-
-
-
-
- The whose modal presentation style is being retrieved.
- Gets the for .
- To be added.
- To be added.
-
-
-
-
-
-
-
- Method
-
- 0.0.0.0
- 2.0.0.0
- Microsoft.Maui.Controls.Core
-
-
- Microsoft.Maui.Controls.PlatformConfiguration.iOSSpecific.UIStatusBarAnimation
-
-
-
-
-
- The platform specific element on which to perform the operation.
- Returns a value that tells whether the preferred animation style to use when updating the status bar is None, Slide, or Fade.
- A value that tells whether the preferred animation style to use when updating the status bar is None, Slide, or Fade.
- To be added.
-
-
-
-
-
-
-
- Method
-
- Microsoft.Maui.Controls.Core
- 2.0.0.0
-
-
- System.Boolean
-
-
-
-
-
- To be added.
- To be added.
- To be added.
- To be added.
-
-
-
-
-
-
-
- Method
-
- 0.0.0.0
- 2.0.0.0
- Microsoft.Maui.Controls.Core
-
-
- Microsoft.Maui.Controls.PlatformConfiguration.iOSSpecific.StatusBarHiddenMode
-
-
-
-
-
- The platform specific element on which to perform the operation.
- Returns a value that tells whether it is preferred that the status bar is shown, hidden, or relies on the system default.
- A value that tells whether it is preferred that the status bar is shown, hidden, or relies on the system default.
- To be added.
-
-
-
-
-
-
-
- Method
-
- 0.0.0.0
- 2.0.0.0
- Microsoft.Maui.Controls.Core
-
-
- Microsoft.Maui.Thickness
-
-
-
-
-
- The element whose safe area insets to get.
- Returns the safe area insets for .
- The safe area insets for .
- To be added.
-
-
-
-
-
-
-
- Method
-
- 0.0.0.0
- 2.0.0.0
- Microsoft.Maui.Controls.Core
-
-
- System.Boolean
-
-
-
-
-
- The element whose safe area behavior to get.
- Gets a Boolean value that tells whether padding values are overridden with values that conform to the safe area on the device.
- To be added.
- To be added.
-
-
-
-
-
-
-
- Method
-
- 0.0.0.0
- 2.0.0.0
- Microsoft.Maui.Controls.Core
-
-
- Microsoft.Maui.Controls.PlatformConfiguration.iOSSpecific.LargeTitleDisplayMode
-
-
-
-
-
- The element whose large title preferences to return.
- Returns a value that describes the large title behavior preference of .
- A value that describes the large title behavior preference of .
- To be added.
-
-
-
-
-
-
-
- Field
-
- 0.0.0.0
- 2.0.0.0
- Microsoft.Maui.Controls.Core
-
-
- Microsoft.Maui.Controls.BindableProperty
-
-
- Backing store for the attached property that defines the large title preferences of the page.
- To be added.
-
-
-
-
-
-
-
- Method
-
- Microsoft.Maui.Controls.Core
- 2.0.0.0
-
-
- Microsoft.Maui.Controls.PlatformConfiguration.iOSSpecific.UIModalPresentationStyle
-
-
-
-
-
-
- this
- .
- Gets the modal presentation style of this.
- To be added.
- To be added.
-
-
-
-
-
-
-
- Field
-
- Microsoft.Maui.Controls.Core
- 2.0.0.0
-
-
- Microsoft.Maui.Controls.BindableProperty
-
-
- The associated with the modal presentation style.
- To be added.
-
-
-
-
-
-
-
- Method
-
- 0.0.0.0
- 2.0.0.0
- Microsoft.Maui.Controls.Core
-
-
- Microsoft.Maui.Controls.PlatformConfiguration.iOSSpecific.UIStatusBarAnimation
-
-
-
-
-
- The platform specific configuration that contains the element on which to perform the operation.
- Returns a value that tells whether the preferred animation style to use when updating the status bar is None, Slide, or Fade.
- A value that tells whether the preferred animation style to use when updating the status bar is None, Slide, or Fade.
- To be added.
-
-
-
-
-
-
-
- Field
-
- 0.0.0.0
- 2.0.0.0
- Microsoft.Maui.Controls.Core
-
-
- Microsoft.Maui.Controls.BindableProperty
-
-
- Backing store for the attached property that controls whether the preferred animation style to use when updating the status bar is None, Slide, or Fade.
- To be added.
-
-
-
-
-
-
-
- Method
-
- Microsoft.Maui.Controls.Core
- 2.0.0.0
-
-
- System.Boolean
-
-
-
-
-
- To be added.
- To be added.
- To be added.
- To be added.
-
-
-
-
-
-
-
- Field
-
- Microsoft.Maui.Controls.Core
- 2.0.0.0
-
-
- Microsoft.Maui.Controls.BindableProperty
-
-
- The backing store for the field.
- To be added.
-
-
-
-
-
-
-
- Method
-
- 0.0.0.0
- 2.0.0.0
- Microsoft.Maui.Controls.Core
-
-
- Microsoft.Maui.Controls.PlatformConfiguration.iOSSpecific.StatusBarHiddenMode
-
-
-
-
-
- The platform specific configuration that contains the element on which to perform the operation.
- Sets a value that controls whether it is preferred that the status bar is shown, hidden, or relies on the system default.
- A value that controls whether it is preferred that the status bar is shown, hidden, or relies on the system default.
- To be added.
-
-
-
-
-
-
-
- Field
-
- 0.0.0.0
- 2.0.0.0
- Microsoft.Maui.Controls.Core
-
-
- Microsoft.Maui.Controls.BindableProperty
-
-
- Sets a value that controls whether it is preferred that the status bar is shown, hidden, or relies on the system default.
- To be added.
-
-
-
-
-
-
-
- Method
-
- 0.0.0.0
- 2.0.0.0
- Microsoft.Maui.Controls.Core
-
-
- Microsoft.Maui.Thickness
-
-
-
-
-
- The element whose safe area insets to return.
- Returns a object that represents the safe area insets.
- A object that represents the safe area insets.
- To be added.
-
-
-
-
-
-
-
- Field
-
- 0.0.0.0
- 2.0.0.0
- Microsoft.Maui.Controls.Core
-
-
- Microsoft.Maui.Controls.BindableProperty
-
-
- Backing store for the attached property that represents the safe area insets.
- To be added.
-
-
-
-
-
-
-
- Method
-
- 0.0.0.0
- 2.0.0.0
- Microsoft.Maui.Controls.Core
-
-
- System.Void
-
-
-
-
-
-
- The element whose large title display preference to set.
- The new large title display preferences.
- Sets the large title display preferences of to .
- To be added.
-
-
-
-
-
-
-
- Method
-
- 0.0.0.0
- 2.0.0.0
- Microsoft.Maui.Controls.Core
-
-
- Microsoft.Maui.Controls.IPlatformElementConfiguration<Microsoft.Maui.Controls.PlatformConfiguration.iOS,Microsoft.Maui.Controls.Page>
-
-
-
-
-
-
- The element whose large title display preference to set.
- The new large title display preferences.
- Sets the large title display preferences of to .
- The updated configuration object on which developers can make successive method calls.
- To be added.
-
-
-
-
-
-
-
- Method
-
- Microsoft.Maui.Controls.Core
- 2.0.0.0
-
-
- Microsoft.Maui.Controls.IPlatformElementConfiguration<Microsoft.Maui.Controls.PlatformConfiguration.iOS,Microsoft.Maui.Controls.Page>
-
-
-
-
-
-
-
- this
-
- The desired .
- Sets the modal presentation style to .
- To be added.
- To be added.
-
-
-
-
-
-
-
- Method
-
- 0.0.0.0
- 2.0.0.0
- Microsoft.Maui.Controls.Core
-
-
- System.Void
-
-
-
-
-
-
- The platform specific element on which to perform the operation.
- The new property value to assign.
- Sets a value that controls whether the preferred animation style to use when updating the status bar is None, Slide, or Fade.
- To be added.
-
-
-
-
-
-
-
- Method
-
- 0.0.0.0
- 2.0.0.0
- Microsoft.Maui.Controls.Core
-
-
- Microsoft.Maui.Controls.IPlatformElementConfiguration<Microsoft.Maui.Controls.PlatformConfiguration.iOS,Microsoft.Maui.Controls.Page>
-
-
-
-
-
-
- The platform specific configuration that contains the element on which to perform the operation.
- The new property value to assign.
- Sets a value that controls whether the preferred animation style to use when updating the status bar is None, Slide, or Fade.
- The updated configuration object on which developers can make successive method calls.
- To be added.
-
-
-
-
-
-
-
- Method
-
- Microsoft.Maui.Controls.Core
- 2.0.0.0
-
-
- System.Void
-
-
-
-
-
-
- To be added.
- To be added.
- To be added.
- To be added.
-
-
-
-
-
-
-
- Method
-
- Microsoft.Maui.Controls.Core
- 2.0.0.0
-
-
- Microsoft.Maui.Controls.IPlatformElementConfiguration<Microsoft.Maui.Controls.PlatformConfiguration.iOS,Microsoft.Maui.Controls.Page>
-
-
-
-
-
-
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
-
-
-
-
-
-
-
- Method
-
- 0.0.0.0
- 2.0.0.0
- Microsoft.Maui.Controls.Core
-
-
- System.Void
-
-
-
-
-
-
- The platform specific element on which to perform the operation.
- The new property value to assign.
- Sets a value that controls whether it is preferred that the status bar is shown, hidden, or relies on the system default.
- To be added.
-
-
-
-
-
-
-
- Method
-
- 0.0.0.0
- 2.0.0.0
- Microsoft.Maui.Controls.Core
-
-
- Microsoft.Maui.Controls.IPlatformElementConfiguration<Microsoft.Maui.Controls.PlatformConfiguration.iOS,Microsoft.Maui.Controls.Page>
-
-
-
-
-
-
- The platform specific configuration that contains the element on which to perform the operation.
- The new property value to assign.
- Sets a value that controls whether it is preferred that the status bar is shown, hidden, or relies on the system default.
- The updated configuration object on which developers can make successive method calls.
- To be added.
-
-
-
-
-
-
-
- Method
-
- 0.0.0.0
- 2.0.0.0
- Microsoft.Maui.Controls.Core
-
-
-
- System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)
-
-
-
- Microsoft.Maui.Controls.IPlatformElementConfiguration<Microsoft.Maui.Controls.PlatformConfiguration.iOS,Microsoft.Maui.Controls.Page>
-
-
-
-
-
-
- The element whose safe area insets to set.
- The new safe area insets.
- Sets the safe area insets of to
- The updated configuration object on which developers can make successive method calls.
- To be added.
-
-
-
-
-
-
-
- Method
-
- 0.0.0.0
- 2.0.0.0
- Microsoft.Maui.Controls.Core
-
-
- System.Void
-
-
-
-
-
-
- The element whose safe area use behavior to set.
- The new safe area inset behavior.
- Sets a value that controls whether padding values are overridden with the safe area insets.
- To be added.
-
-
-
-
-
-
-
- Method
-
- 0.0.0.0
- 2.0.0.0
- Microsoft.Maui.Controls.Core
-
-
- Microsoft.Maui.Controls.IPlatformElementConfiguration<Microsoft.Maui.Controls.PlatformConfiguration.iOS,Microsoft.Maui.Controls.Page>
-
-
-
-
-
-
- The element whose safe area use behavior to set.
- The new safe area inset behavior.
- Sets a value that controls whether padding values are overridden with the safe area insets.
- The updated configuration object on which developers can make successive method calls.
- To be added.
-
-
-
-
-
-
-
- Field
-
- 0.0.0.0
- 2.0.0.0
- Microsoft.Maui.Controls.Core
-
-
- Microsoft.Maui.Controls.BindableProperty
-
-
- Backing store for the attached property that controls whether the padding is overridden with the safe area.
- To be added.
-
-
-
-
-
-
-
- Method
-
- 0.0.0.0
- 2.0.0.0
- Microsoft.Maui.Controls.Core
-
-
- System.Boolean
-
-
-
-
-
- The element whose safe area behavior to get.
- Returns a Boolean value that tells whether the padding is overridden with the safe area.
- A Boolean value that tells whether the padding is overridden with the safe area.
- To be added.
-
-
-
-
diff --git a/src/Controls/src/Core/PlatformConfiguration/WindowsSpecific/Page.cs b/src/Controls/src/Core/PlatformConfiguration/WindowsSpecific/Page.cs
index ebb18abd7b41..dd29459aadb4 100644
--- a/src/Controls/src/Core/PlatformConfiguration/WindowsSpecific/Page.cs
+++ b/src/Controls/src/Core/PlatformConfiguration/WindowsSpecific/Page.cs
@@ -9,35 +9,56 @@ namespace Microsoft.Maui.Controls.PlatformConfiguration.WindowsSpecific
{
using FormsElement = Maui.Controls.Page;
- ///
+ ///
+ /// Provides the Page Windows Platform-Specific Functionality.
+ ///
public static class Page
{
#region ToolbarPlacement
- /// Bindable property for .
+ ///
+ /// Backing store for the attached property that controls the placement of the toolbar.
+ ///
public static readonly BindableProperty ToolbarPlacementProperty =
BindableProperty.CreateAttached("ToolbarPlacement", typeof(ToolbarPlacement),
typeof(FormsElement), ToolbarPlacement.Default);
- ///
+ ///
+ /// Returns a value that controls the placement of the toolbar.
+ ///
+ /// The platform specific element on which to perform the operation.
+ /// A value that controls the placement of the toolbar.
public static ToolbarPlacement GetToolbarPlacement(BindableObject element)
{
return (ToolbarPlacement)element.GetValue(ToolbarPlacementProperty);
}
- ///
+ ///
+ /// Sets a value that controls the placement of the toolbar.
+ ///
+ /// The platform specific element on which to perform the operation.
+ /// The new toolbar placement.
public static void SetToolbarPlacement(BindableObject element, ToolbarPlacement toolbarPlacement)
{
element.SetValue(ToolbarPlacementProperty, toolbarPlacement);
}
- ///
+ ///
+ /// Returns a value that controls the placement of the toolbar.
+ ///
+ /// The platform specific configuration that contains the element on which to perform the operation.
+ /// A value that controls the placement of the toolbar.
public static ToolbarPlacement GetToolbarPlacement(this IPlatformElementConfiguration config)
{
return (ToolbarPlacement)config.Element.GetValue(ToolbarPlacementProperty);
}
- ///
+ ///
+ /// Sets a value that controls the placement of the toolbar.
+ ///
+ /// The platform specific configuration that contains the element on which to perform the operation.
+ /// The new property value to assign.
+ /// The updated configuration object on which developers can make successive method calls.
public static IPlatformElementConfiguration SetToolbarPlacement(
this IPlatformElementConfiguration config, ToolbarPlacement value)
{
@@ -49,30 +70,49 @@ public static ToolbarPlacement GetToolbarPlacement(this IPlatformElementConfigur
#region ToolbarDynamicOverflowEnabled
- /// Bindable property for attached property ToolbarDynamicOverflowEnabled.
+ ///
+ /// Indicates whether toolbar items automatically move to the overflow menu when space is limited.
+ ///
public static readonly BindableProperty ToolbarDynamicOverflowEnabledProperty =
BindableProperty.CreateAttached("ToolbarDynamicOverflowEnabled", typeof(bool),
typeof(FormsElement), true);
- ///
+ ///
+ /// Gets a value that indicates whether toolbar items automatically move to the overflow menu when space is limited.
+ ///
+ /// A page, the that occupies the entire screen.
+ /// if toolbar items automatically move to the overflow menu when space is limited; otherwise, .
public static bool GetToolbarDynamicOverflowEnabled(BindableObject element)
{
return (bool)element.GetValue(ToolbarDynamicOverflowEnabledProperty);
}
- ///
+ ///
+ /// Sets a value that indicates whether toolbar items automatically move to the overflow menu when space is limited.
+ ///
+ /// A page, the that occupies the entire screen.
+ /// A value that indicates whether toolbar items automatically move to the overflow menu when space is limited
public static void SetToolbarDynamicOverflowEnabled(BindableObject element, bool value)
{
element.SetValue(ToolbarDynamicOverflowEnabledProperty, value);
}
- ///
+ ///
+ /// Gets a value that indicates whether toolbar items automatically move to the overflow menu when space is limited.
+ ///
+ /// The platform specific configuration that contains the element on which to perform the operation.
+ /// if toolbar items automatically move to the overflow menu when space is limited; otherwise, .
public static bool GetToolbarDynamicOverflowEnabled(this IPlatformElementConfiguration config)
{
return (bool)config.Element.GetValue(ToolbarDynamicOverflowEnabledProperty);
}
- ///
+ ///
+ /// Sets a value that indicates whether toolbar items automatically move to the overflow menu when space is limited.
+ ///
+ /// The platform specific configuration that contains the element on which to perform the operation.
+ /// A value that indicates whether toolbar items automatically move to the overflow menu when space is limited
+ /// The updated configuration object on which developers can make successive method calls.
public static IPlatformElementConfiguration SetToolbarDynamicOverflowEnabled(
this IPlatformElementConfiguration config, bool value)
{
diff --git a/src/Controls/src/Core/PlatformConfiguration/iOSSpecific/Page.cs b/src/Controls/src/Core/PlatformConfiguration/iOSSpecific/Page.cs
index 79b0ce75e475..42ac918124a7 100644
--- a/src/Controls/src/Core/PlatformConfiguration/iOSSpecific/Page.cs
+++ b/src/Controls/src/Core/PlatformConfiguration/iOSSpecific/Page.cs
@@ -5,49 +5,80 @@ namespace Microsoft.Maui.Controls.PlatformConfiguration.iOSSpecific
{
using FormsElement = Maui.Controls.Page;
- ///
+ ///
+ /// The page instance that Microsoft.Maui.Controls created on the iOS platform.
+ ///
public static class Page
{
- /// Bindable property for .
+ ///
+ /// Sets a value that controls whether it is preferred that the status bar is shown, hidden, or relies on the system default.
+ ///
public static readonly BindableProperty PrefersStatusBarHiddenProperty =
BindableProperty.Create("PrefersStatusBarHidden", typeof(StatusBarHiddenMode), typeof(Page), StatusBarHiddenMode.Default);
- ///
+ ///
+ /// Returns a value that tells whether it is preferred that the status bar is shown, hidden, or relies on the system default.
+ ///
+ /// The platform specific element on which to perform the operation.
+ /// A value that tells whether it is preferred that the status bar is shown, hidden, or relies on the system default.
public static StatusBarHiddenMode GetPrefersStatusBarHidden(BindableObject element)
{
return (StatusBarHiddenMode)element.GetValue(PrefersStatusBarHiddenProperty);
}
- ///
+ ///
+ /// Sets a value that controls whether it is preferred that the status bar is shown, hidden, or relies on the system default.
+ ///
+ /// The platform specific element on which to perform the operation.
+ /// The new property value to assign.
public static void SetPrefersStatusBarHidden(BindableObject element, StatusBarHiddenMode value)
{
element.SetValue(PrefersStatusBarHiddenProperty, value);
}
- ///
+ ///
+ /// Sets a value that controls whether it is preferred that the status bar is shown, hidden, or relies on the system default.
+ ///
+ /// The platform specific configuration that contains the element on which to perform the operation.
+ /// A value that controls whether it is preferred that the status bar is shown, hidden, or relies on the system default.
public static StatusBarHiddenMode PrefersStatusBarHidden(this IPlatformElementConfiguration config)
{
return GetPrefersStatusBarHidden(config.Element);
}
- ///
+ ///
+ /// Sets a value that controls whether it is preferred that the status bar is shown, hidden, or relies on the system default.
+ ///
+ /// The platform specific configuration that contains the element on which to perform the operation.
+ /// The new property value to assign.
+ /// The updated configuration object on which developers can make successive method calls.
public static IPlatformElementConfiguration SetPrefersStatusBarHidden(this IPlatformElementConfiguration config, StatusBarHiddenMode value)
{
SetPrefersStatusBarHidden(config.Element, value);
return config;
}
- /// Bindable property for .
+ ///
+ /// Backing store for the attached property that controls whether the preferred animation style to use when updating the status bar is None, Slide, or Fade.
+ ///
public static readonly BindableProperty PreferredStatusBarUpdateAnimationProperty =
BindableProperty.Create("PreferredStatusBarUpdateAnimation", typeof(UIStatusBarAnimation), typeof(Page), UIStatusBarAnimation.None);
- ///
+ ///
+ /// Returns a value that tells whether the preferred animation style to use when updating the status bar is None, Slide, or Fade.
+ ///
+ /// The platform specific element on which to perform the operation.
+ /// A value that tells whether the preferred animation style to use when updating the status bar is None, Slide, or Fade.
public static UIStatusBarAnimation GetPreferredStatusBarUpdateAnimation(BindableObject element)
{
return (UIStatusBarAnimation)element.GetValue(PreferredStatusBarUpdateAnimationProperty);
}
- ///
+ ///
+ /// Sets a value that controls whether the preferred animation style to use when updating the status bar is None, Slide, or Fade.
+ ///
+ /// The platform specific element on which to perform the operation.
+ /// The new property value to assign.
public static void SetPreferredStatusBarUpdateAnimation(BindableObject element, UIStatusBarAnimation value)
{
if (value == UIStatusBarAnimation.Fade)
@@ -58,46 +89,74 @@ public static void SetPreferredStatusBarUpdateAnimation(BindableObject element,
element.SetValue(PreferredStatusBarUpdateAnimationProperty, value);
}
- ///
+ ///
+ /// Returns a value that tells whether the preferred animation style to use when updating the status bar is None, Slide, or Fade.
+ ///
+ /// The platform specific configuration that contains the element on which to perform the operation.
+ /// A value that tells whether the preferred animation style to use when updating the status bar is None, Slide, or Fade.
public static UIStatusBarAnimation PreferredStatusBarUpdateAnimation(this IPlatformElementConfiguration config)
{
return GetPreferredStatusBarUpdateAnimation(config.Element);
}
- ///
+ ///
+ /// Sets a value that controls whether the preferred animation style to use when updating the status bar is None, Slide, or Fade.
+ ///
+ /// The platform specific configuration that contains the element on which to perform the operation.
+ /// The new property value to assign.
+ /// The updated configuration object on which developers can make successive method calls.
public static IPlatformElementConfiguration SetPreferredStatusBarUpdateAnimation(this IPlatformElementConfiguration config, UIStatusBarAnimation value)
{
SetPreferredStatusBarUpdateAnimation(config.Element, value);
return config;
}
- /// Bindable property for attached property UseSafeArea.
+ ///
+ /// This iOS platform-specific controls whether padding values are overridden with the safe area insets.
+ ///
#if MACCATALYST
public static readonly BindableProperty UseSafeAreaProperty = BindableProperty.Create("UseSafeArea", typeof(bool), typeof(Page), true);
#else
public static readonly BindableProperty UseSafeAreaProperty = BindableProperty.Create("UseSafeArea", typeof(bool), typeof(Page), false);
#endif
- ///
+ ///
+ /// Gets a value that indicates whether padding values are overridden with values that conform to the safe area on the device.
+ ///
+ /// The element to get the safe area behavior from.
+ /// if the padding values are overridden; otherwise, .
public static bool GetUseSafeArea(BindableObject element)
{
return (bool)element.GetValue(UseSafeAreaProperty);
}
- ///
+ ///
+ /// Sets a value that controls whether padding values are overridden with the safe area insets.
+ ///
+ /// The element whose safe area use behavior to set.
+ /// to use the safe area inset behavior; otherwise, .
public static void SetUseSafeArea(BindableObject element, bool value)
{
element.SetValue(UseSafeAreaProperty, value);
}
- ///
+ ///
+ /// Sets a value that controls whether padding values are overridden with the safe area insets.
+ ///
+ /// The element whose safe area behavior to get.
+ /// to use the safe area inset behavior; otherwise, .
+ /// The updated configuration object on which developers can make successive method calls.
public static IPlatformElementConfiguration SetUseSafeArea(this IPlatformElementConfiguration config, bool value)
{
SetUseSafeArea(config.Element, value);
return config;
}
- ///
+ ///
+ /// Gets a value that represents whether the padding is overridden with the safe area.
+ ///
+ /// The element whose safe area behavior to get.
+ /// if the padding is overridden with the safe area; otherwise, .
public static bool UsingSafeArea(this IPlatformElementConfiguration config)
{
return GetUseSafeArea(config.Element);
@@ -106,25 +165,42 @@ public static bool UsingSafeArea(this IPlatformElementConfigurationBindable property for .
public static readonly BindableProperty LargeTitleDisplayProperty = BindableProperty.Create(nameof(LargeTitleDisplay), typeof(LargeTitleDisplayMode), typeof(Page), LargeTitleDisplayMode.Automatic);
- ///
+ ///
+ /// Returns the large title display preferences for .
+ ///
+ /// The element whose large title display preferences to get.
+ /// The large title display preferences for .
public static LargeTitleDisplayMode GetLargeTitleDisplay(BindableObject element)
{
return (LargeTitleDisplayMode)element.GetValue(LargeTitleDisplayProperty);
}
- ///
+ ///
+ /// Sets the large title display preferences of to .
+ ///
+ /// The element whose large title display preference to set.
+ /// The new large title display preferences.
public static void SetLargeTitleDisplay(BindableObject element, LargeTitleDisplayMode value)
{
element.SetValue(LargeTitleDisplayProperty, value);
}
- ///
+ ///
+ /// Returns a value that describes the large title behavior preference of .
+ ///
+ /// The element whose large title preferences to return.
+ /// A value that describes the large title behavior preference of .
public static LargeTitleDisplayMode LargeTitleDisplay(this IPlatformElementConfiguration config)
{
return GetLargeTitleDisplay(config.Element);
}
- ///
+ ///
+ /// Sets the large title display preferences of to .
+ ///
+ /// The element whose large title display preference to set.
+ /// The new large title display preferences.
+ /// The updated configuration object on which developers can make successive method calls.
public static IPlatformElementConfiguration SetLargeTitleDisplay(this IPlatformElementConfiguration config, LargeTitleDisplayMode value)
{
SetLargeTitleDisplay(config.Element, value);
@@ -133,10 +209,16 @@ public static LargeTitleDisplayMode LargeTitleDisplay(this IPlatformElementConfi
static readonly BindablePropertyKey SafeAreaInsetsPropertyKey = BindableProperty.CreateReadOnly(nameof(SafeAreaInsets), typeof(Thickness), typeof(Page), default(Thickness));
- /// Bindable property for .
+ ///
+ /// Backing store for the attached property that represents the safe area insets.
+ ///
public static readonly BindableProperty SafeAreaInsetsProperty = SafeAreaInsetsPropertyKey.BindableProperty;
- ///
+ ///
+ /// Returns the safe area insets for .
+ ///
+ /// The element whose safe area insets to get.
+ /// The safe area insets for .
public static Thickness GetSafeAreaInsets(BindableObject element)
{
return (Thickness)element.GetValue(SafeAreaInsetsProperty);
@@ -147,13 +229,22 @@ static void SetSafeAreaInsets(BindableObject element, Thickness value)
element.SetValue(SafeAreaInsetsPropertyKey, value);
}
- ///
+ ///
+ /// Returns a object that represents the safe area insets.
+ ///
+ /// The element whose safe area insets to return.
+ /// A object that represents the safe area insets.
public static Thickness SafeAreaInsets(this IPlatformElementConfiguration config)
{
return GetSafeAreaInsets(config.Element);
}
- ///
+ ///
+ /// Sets the safe area insets of to .
+ ///
+ /// The element whose safe area insets to set.
+ /// The new safe area insets.
+ /// The updated configuration object on which developers can make successive method calls.
[EditorBrowsable(EditorBrowsableState.Never)]
public static IPlatformElementConfiguration SetSafeAreaInsets(this IPlatformElementConfiguration config, Thickness value)
{
@@ -161,29 +252,49 @@ public static Thickness SafeAreaInsets(this IPlatformElementConfigurationBindable property for .
+ ///
+ /// Defines the modal presentation style of the .
+ ///
public static readonly BindableProperty ModalPresentationStyleProperty =
BindableProperty.Create(nameof(ModalPresentationStyle), typeof(UIModalPresentationStyle), typeof(Page), UIModalPresentationStyle.FullScreen);
- ///
+ ///
+ /// Gets the modal presentation style of the .
+ ///
+ /// The platform specific configuration that contains the element on which to perform the operation.
+ /// The modal presentation style.
public static UIModalPresentationStyle ModalPresentationStyle(this IPlatformElementConfiguration config)
{
return GetModalPresentationStyle(config.Element);
}
- ///
+ ///
+ /// Sets the modal presentation style of the .
+ ///
+ /// The platform specific configuration that contains the element on which to perform the operation.
+ /// The modal presentation style.
+ /// The platform specific configuration that contains the element on which to perform the operation.
public static IPlatformElementConfiguration SetModalPresentationStyle(this IPlatformElementConfiguration config, UIModalPresentationStyle value)
{
SetModalPresentationStyle(config.Element, value);
return config;
}
- ///
+ ///
+ /// Gets the current value of the enumeration that's applied to the .
+ ///
+ /// The whose modal presentation style is being retrieved.
+ /// The current value of the enumeration that's applied to the .
public static UIModalPresentationStyle GetModalPresentationStyle(BindableObject element)
{
return (UIModalPresentationStyle)element.GetValue(ModalPresentationStyleProperty);
}
+ ///
+ /// Sets the modal presentation style on a .
+ ///
+ /// A page, the VisualElement that occupies the entire screen.
+ /// The modal presentation style.
static void SetModalPresentationStyle(BindableObject element, UIModalPresentationStyle value)
{
element.SetValue(ModalPresentationStyleProperty, value);
@@ -193,29 +304,46 @@ static void SetModalPresentationStyle(BindableObject element, UIModalPresentatio
public static readonly BindableProperty PrefersHomeIndicatorAutoHiddenProperty =
BindableProperty.Create(nameof(PrefersHomeIndicatorAutoHidden), typeof(bool), typeof(Page), false);
- ///
+ ///
+ /// Gets a value that indicates whether the visual indicator should hide upon returning to the home screen.
+ ///
+ /// A page, the VisualElement that occupies the entire screen.
+ /// if the home visual indicator is hidden; otherwise, .
public static bool GetPrefersHomeIndicatorAutoHidden(BindableObject element)
{
return (bool)element.GetValue(PrefersHomeIndicatorAutoHiddenProperty);
}
- ///
+ ///
+ /// Sets a value that indicates whether the visual indicator should hide upon returning to the home screen.
+ ///
+ /// A page, the VisualElement that occupies the entire screen.
+ /// if hide the home indicator; otherwise, .
public static void SetPrefersHomeIndicatorAutoHidden(BindableObject element, bool value)
{
element.SetValue(PrefersHomeIndicatorAutoHiddenProperty, value);
}
- ///
+ ///
+ /// Gets a Boolean that indicates whether is allowed to hide the visual indicator for returning to the Home Screen.
+ ///
+ /// The platform specific configuration that contains the element on which to perform the operation.
+ /// if hide the home indicator; otherwise, .
public static bool PrefersHomeIndicatorAutoHidden(this IPlatformElementConfiguration config)
{
return GetPrefersHomeIndicatorAutoHidden(config.Element);
}
- ///
+ ///
+ /// Sets a Boolean that indicates whether is allowed to hide the visual indicator for returning to the Home Screen.
+ ///
+ /// The platform specific configuration that contains the element on which to perform the operation.
+ /// if hide the home indicator; otherwise, .
+ /// The updated configuration object on which developers can make successive method calls.
public static IPlatformElementConfiguration SetPrefersHomeIndicatorAutoHidden(this IPlatformElementConfiguration config, bool value)
{
SetPrefersHomeIndicatorAutoHidden(config.Element, value);
return config;
}
}
-}
+}
\ No newline at end of file