diff --git a/src/Controls/docs/Microsoft.Maui.Controls/BackButtonBehavior.xml b/src/Controls/docs/Microsoft.Maui.Controls/BackButtonBehavior.xml deleted file mode 100644 index 191c7a82b7a2..000000000000 --- a/src/Controls/docs/Microsoft.Maui.Controls/BackButtonBehavior.xml +++ /dev/null @@ -1,197 +0,0 @@ - - - - - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.BindableObject - - - - A specifying the behavior associated with the back button in a Shell application. - - - - - - - Constructor - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Windows.Input.ICommand - - - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Object - - - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.BindableProperty - - - The backing store for the field. - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.BindableProperty - - - The backing store for the field. - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.ImageSource - - - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.BindableProperty - - - The backing store for the field. - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Boolean - - - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.BindableProperty - - - The backing store for the field. - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.String - - - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.BindableProperty - - - The backing store for the field. - - - - diff --git a/src/Controls/docs/Microsoft.Maui.Controls/BaseShellItem.xml b/src/Controls/docs/Microsoft.Maui.Controls/BaseShellItem.xml deleted file mode 100644 index 0ac8c7d1075c..000000000000 --- a/src/Controls/docs/Microsoft.Maui.Controls/BaseShellItem.xml +++ /dev/null @@ -1,523 +0,0 @@ - - - - - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.NavigableElement - - - - Microsoft.Maui.Controls.ITabStopElement - - - - - System.Diagnostics.DebuggerDisplay("Title = {Title}, Route = {Route}") - - - - A that is the base class for and . - - - - - - - Constructor - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - - Creates a new with default values. - - - - - - - - Event - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.EventHandler - - - - - - - - - - Event - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.EventHandler - - - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.ImageSource - - - The icon to use for the item. If this property is unset, it will fallback to using the property value. - A that represents an icon. - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.BindableProperty - - - The backing store for the field. - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.ImageSource - - - Defines the icon to display in parts of the chrome that are not the flyout. - A that represents an icon. - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.BindableProperty - - - The backing store for the field. - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Boolean - - - Defines if the item is currently highlighted in the flyout. - - if the item is currently highlighted. - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.BindableProperty - - - The backing store for the field. - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Boolean - - - Defines if the item is selectable in the chrome. - - if the item is selectable in the chrome. - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.BindableProperty - - - The backing store for the field. - - - - - - - - Property - - P:Microsoft.Maui.Controls.ITabStopElement.IsTabStop - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Boolean - - - Indicates whether a FlyoutItem is included in tab navigation. - Default value is ; when , the FlyoutItem is ignored by the tab-navigation infrastructure, irrespective if a TabIndex is set. - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.BindableProperty - - - The backing store for the field. - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Boolean - - - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.BindableProperty - - - - - - - - - - Method - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Void - - - - - - - - - - - Method - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Void - - - - - - - - - - - Method - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Void - - - - - - System.Runtime.CompilerServices.CallerMemberName - - - - - - The name of the changed property. - Called whenever a property changes. - - - - - - - - Method - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Void - - - - - - - Old TabIndex. - New TabIndex. - Called whenever the TabIndex property changes. - - - - - - - - Method - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Void - - - - - - - Old IsTabStop value. - New IsTabStop value. - Called whenever the IsTabStop property changes. - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.String - - - The string used to address the item. - A unique string that identifies the item. - - - - - - - - Property - - P:Microsoft.Maui.Controls.ITabStopElement.TabIndex - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Int32 - - - Indicates the order in which FlyoutItem objects receive focus when the user navigates through items by pressing the Tab key. - Defaults to 0. - - - - - - - - Method - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Int32 - - - - Called to set the default value of the TabIndex property.. - Defaults to 0. - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.BindableProperty - - - The backing store for the field. - - - - - - - - Method - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Boolean - - - - Called to set the default value of the TabStop property. - - if TabStop. - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.String - - - Title to display in the UI. - Title to display in the UI. - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.BindableProperty - - - The backing store for the field. - - - - diff --git a/src/Controls/docs/Microsoft.Maui.Controls/FlyoutDisplayOptions.xml b/src/Controls/docs/Microsoft.Maui.Controls/FlyoutDisplayOptions.xml deleted file mode 100644 index 669dba21da4c..000000000000 --- a/src/Controls/docs/Microsoft.Maui.Controls/FlyoutDisplayOptions.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Enum - - - Enumerates display modes for the flyout in a Shell appication. - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.FlyoutDisplayOptions - - 1 - - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.FlyoutDisplayOptions - - 0 - - - - - diff --git a/src/Controls/docs/Microsoft.Maui.Controls/FlyoutHeaderBehavior.xml b/src/Controls/docs/Microsoft.Maui.Controls/FlyoutHeaderBehavior.xml deleted file mode 100644 index bfc44af5d5b0..000000000000 --- a/src/Controls/docs/Microsoft.Maui.Controls/FlyoutHeaderBehavior.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Enum - - - Enumeration of modes followed by the . - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.FlyoutHeaderBehavior - - 3 - - Collapses the flyout header when scrolling occurs. - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.FlyoutHeaderBehavior - - 0 - - The default behavior is to remain fixed in the flyout while the content below may scroll. - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.FlyoutHeaderBehavior - - 1 - - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.FlyoutHeaderBehavior - - 2 - - - - - diff --git a/src/Controls/docs/Microsoft.Maui.Controls/FlyoutItem.xml b/src/Controls/docs/Microsoft.Maui.Controls/FlyoutItem.xml deleted file mode 100644 index 9b3d6783fbc9..000000000000 --- a/src/Controls/docs/Microsoft.Maui.Controls/FlyoutItem.xml +++ /dev/null @@ -1,146 +0,0 @@ - - - - - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.ShellItem - - - - - System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always) - - - - A that has a collection of objects. - - - - - - - Constructor - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - - - - - - - - - Method - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Boolean - - - - - - To be added. - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.String - - - StyleClass set on the Image of each Flyout Item. This const is set to "FlyoutItemImageStyle". - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.BindableProperty - - - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.String - - - StyleClass set on the Label of each Flyout Item. This const is set to "FlyoutItemLabelStyle". - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.String - - - StyleClass set on the Label of every Flyout Item. This const is set to "FlyoutItemLayoutStyle". - - - - - - - - Method - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Void - - - - - - - To be added. - To be added. - - - - diff --git a/src/Controls/docs/Microsoft.Maui.Controls/MenuItemCollection.xml b/src/Controls/docs/Microsoft.Maui.Controls/MenuItemCollection.xml deleted file mode 100644 index 2c10a2a149a5..000000000000 --- a/src/Controls/docs/Microsoft.Maui.Controls/MenuItemCollection.xml +++ /dev/null @@ -1,359 +0,0 @@ - - - - - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Object - - - - System.Collections.Generic.ICollection<T> - - - System.Collections.Generic.ICollection<Microsoft.Maui.Controls.MenuItem> - - - System.Collections.Generic.IEnumerable<T> - - - System.Collections.Generic.IEnumerable<Microsoft.Maui.Controls.MenuItem> - - - System.Collections.Generic.IList<Microsoft.Maui.Controls.MenuItem> - - - System.Collections.IEnumerable - - - System.Collections.Specialized.INotifyCollectionChanged - - - - A group of related objects. - - - - - - - Constructor - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - - - - - - - - - Method - - M:System.Collections.Generic.ICollection`1.Add(`0) - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Void - - - - - - To be added. - - - - - - - - Method - - M:System.Collections.Generic.ICollection`1.Clear - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Void - - - - - - - - - - - Method - - M:System.Collections.Generic.ICollection`1.Contains(`0) - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Boolean - - - - - - To be added. - - - - - - - - Method - - M:System.Collections.Generic.ICollection`1.CopyTo(`0[],System.Int32) - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Void - - - - - - - To be added. - To be added. - - - - - - - - Property - - P:System.Collections.Generic.ICollection`1.Count - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Int32 - - - - - - - - - - Method - - M:System.Collections.Generic.IEnumerable`1.GetEnumerator - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Collections.Generic.IEnumerator<Microsoft.Maui.Controls.MenuItem> - - - - - - - - - - - Method - - M:System.Collections.Generic.IList`1.IndexOf(`0) - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Int32 - - - - - - To be added. - - - - - - - - Method - - M:System.Collections.Generic.IList`1.Insert(System.Int32,`0) - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Void - - - - - - - To be added. - To be added. - - - - - - - - Property - - P:System.Collections.Generic.ICollection`1.IsReadOnly - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Boolean - - - - - - - - - - Property - - P:System.Collections.Generic.IList`1.Item(System.Int32) - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.MenuItem - - - - - - To be added. - - - - - - - - Method - - M:System.Collections.Generic.ICollection`1.Remove(`0) - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Boolean - - - - - - To be added. - - - - - - - - Method - - M:System.Collections.Generic.IList`1.RemoveAt(System.Int32) - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Void - - - - - - To be added. - - - - - - - - Method - - M:System.Collections.IEnumerable.GetEnumerator - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Collections.IEnumerator - - - - - - - - - - - Event - - E:System.Collections.Specialized.INotifyCollectionChanged.CollectionChanged - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Collections.Specialized.NotifyCollectionChangedEventHandler - - - - - - diff --git a/src/Controls/docs/Microsoft.Maui.Controls/PresentationMode.xml b/src/Controls/docs/Microsoft.Maui.Controls/PresentationMode.xml deleted file mode 100644 index 73c23b4669f9..000000000000 --- a/src/Controls/docs/Microsoft.Maui.Controls/PresentationMode.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Enum - - - - System.Flags - - - - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.PresentationMode - - 2 - - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.PresentationMode - - 4 - - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.PresentationMode - - 6 - - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.PresentationMode - - 5 - - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.PresentationMode - - 1 - - - - - diff --git a/src/Controls/docs/Microsoft.Maui.Controls/QueryPropertyAttribute.xml b/src/Controls/docs/Microsoft.Maui.Controls/QueryPropertyAttribute.xml deleted file mode 100644 index ebcc7a7582a1..000000000000 --- a/src/Controls/docs/Microsoft.Maui.Controls/QueryPropertyAttribute.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Attribute - - - - - System.AttributeUsage(System.AttributeTargets.Class, AllowMultiple=true) - - - - - - - - - - - Constructor - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - - - - - To be added. - To be added. - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.String - - - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.String - - - - - - diff --git a/src/Controls/docs/Microsoft.Maui.Controls/SearchHandler.xml b/src/Controls/docs/Microsoft.Maui.Controls/SearchHandler.xml deleted file mode 100644 index 2cc34e3519e8..000000000000 --- a/src/Controls/docs/Microsoft.Maui.Controls/SearchHandler.xml +++ /dev/null @@ -1,1821 +0,0 @@ - - - - - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.BindableObject - - - - Microsoft.Maui.Controls.Internals.IFontElement - - - Microsoft.Maui.Controls.ISearchHandlerController - - - - Default implementation of . - - - - - - - Constructor - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Graphics.Color - - - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.BindableProperty - - - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Graphics.Color - - - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.BindableProperty - - - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Double - - - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.BindableProperty - - - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.ImageSource - - - The icon displayed to clear the contents of the search box. - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.String - - - The accessible help text for the clear icon. - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.BindableProperty - - - The backing store for the field. - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.String - - - The name of the clear icon for use with screen readers. - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.BindableProperty - - - The backing store for the field. - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.BindableProperty - - - The backing store for the field. - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Windows.Input.ICommand - - - ICommand executed when the is tapped. - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Object - - - The parameter passed to the . - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.BindableProperty - - - The backing store for the field. - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.BindableProperty - - - The backing store for the field. - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Boolean - - - Whether the can be executed. - The default value is `true`. - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.BindableProperty - - - The backing store for the field. - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.String - - - The accessible help text for the . - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.BindableProperty - - - The backing store for the field. - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.ImageSource - - - The clear placeholder icon displayed when the search box is empty. - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.BindableProperty - - - The backing store for the field. - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.String - - - The name of the clear placeholder icon for use with screen readers. - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.BindableProperty - - - The backing store for the field. - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Windows.Input.ICommand - - - Gets or sets the ICommand executed when the search query is confirmed. - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Object - - - Gets or sets the parameter of the , which is executed when the search query is confirmed. - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.BindableProperty - - - The backing store for the field. - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.BindableProperty - - - The backing store for the field. - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.String - - - The name or path of the property that is displayed for each item of data in the collection. - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.BindableProperty - - - The backing store for the field. - - - - - - - - Method - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Boolean - - - - - - - - - - - Event - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - - System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never) - - - - System.EventHandler<Microsoft.Maui.Controls.VisualElement+FocusRequestArgs> - - - - - - - - - - Event - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.EventHandler<System.EventArgs> - - - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.FontAttributes - - - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.BindableProperty - - - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.String - - - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.BindableProperty - - - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - - System.ComponentModel.TypeConverter(typeof(Microsoft.Maui.Controls.FontSizeConverter)) - - - - System.Double - - - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.BindableProperty - - - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.TextAlignment - - - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.BindableProperty - - - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Boolean - - - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.BindableProperty - - - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - - System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never) - - - - Microsoft.Maui.Controls.BindablePropertyKey - - - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Boolean - - - Gets or sets whether the search box is enabled. - The default value is `true`. - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.BindableProperty - - - The backing store for the field. - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Collections.IEnumerable - - - The collection of items to be displayed in the suggestion area. Default is . - The default value is `null`. - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.BindableProperty - - - The backing store for the field. - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.DataTemplate - - - The to apply to each item in . - - For example, to create the style shown here: , developers could use either the following XAML or C#: - - - - - - - - - - - - - - - - - - ... -]]> - - - - { - Grid grid = new Grid { Padding = 10 }; - grid.ColumnDefinitions.Add(new ColumnDefinition { Width = new GridLength(0.15, GridUnitType.Star) }); - grid.ColumnDefinitions.Add(new ColumnDefinition { Width = new GridLength(0.85, GridUnitType.Star) }); - - Image image = new Image { Aspect = Aspect.AspectFill, HeightRequest = 40, WidthRequest = 40 }; - image.SetBinding(Image.SourceProperty, "ImageUrl"); - Label nameLabel = new Label { FontAttributes = FontAttributes.Bold }; - nameLabel.SetBinding(Label.TextProperty, "Name"); - - grid.Add(image); - grid.Add(nameLabel, 1, 0); - return grid; - }) -});]]> - - - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.BindableProperty - - - The backing store for the field. - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Keyboard - - - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.BindableProperty - - - - - - - - - - Method - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Void - - - - Developers may override this method to respond to the being tapped. - - - - - - - - Method - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Void - - - - - - - - - - - Method - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Void - - - - - - To be added. - Developers may override this method to respond to a search result being selected by the user. - - Typically, developers will override this method to navigate to a destination specified by : - - - - - - - - - - - - Method - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Void - - - - - - - To be added. - To be added. - Developers may override this method to respond to the being modified. - - A common use-case is modifying the set of suggestions as the user enters data: - - monkey.Name.ToLower().Contains(newValue.ToLower())) - .ToList(); - } -} - ]]> - - - - - - - - - - Method - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Void - - - - Developers may override this method to respond to the user entering or confirming their query in the search box. - - - - - - - - Method - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Void - - - - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.String - - - The text to display when the search box is empty. - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Graphics.Color - - - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.BindableProperty - - - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.BindableProperty - - - The backing store for the field. - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.String - - - Gets or sets the text of the search box. - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.ImageSource - - - The icon used to indicate that search is available. - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.String - - - The accessible help text for the . - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.BindableProperty - - - The backing store for the field. - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.String - - - The name of the for use with screen readers. - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.BindableProperty - - - The backing store for the field. - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.BindableProperty - - - The backing store for the field. - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.BindableProperty - - - The backing store for the field. - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.SearchBoxVisibility - - - Gets or sets whether the search box is visible. - The default is (visible and expanded). - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.BindableProperty - - - The backing store for the field. - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Object - - - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.BindableProperty - - - The backing store for the field. - - - - - - - - Method - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - - System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never) - - - - System.Void - - - - - - To be added. - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Boolean - - - Gets or sets whether search results should be expected in the suggestion area on text entry. - The default value is `false`. - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.BindableProperty - - - The backing store for the field. - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Graphics.Color - - - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.BindableProperty - - - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.TextTransform - - - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.BindableProperty - - - - - - - - - - Method - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Void - - - - - - - - - - - Event - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.EventHandler<System.EventArgs> - - - - - - - - - - Method - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.String - - - - - - - To be added. - To be added. - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.TextAlignment - - - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.BindableProperty - - - - - - - - - - Method - - M:Microsoft.Maui.Controls.Internals.IFontElement.FontSizeDefaultValueCreator - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Double - - - - - - - - - - - Method - - M:Microsoft.Maui.Controls.Internals.IFontElement.OnFontAttributesChanged(Microsoft.Maui.Controls.FontAttributes,Microsoft.Maui.Controls.FontAttributes) - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Void - - - - - - - To be added. - To be added. - - - - - - - - Method - - M:Microsoft.Maui.Controls.Internals.IFontElement.OnFontChanged(Microsoft.Maui.Controls.Font,Microsoft.Maui.Controls.Font) - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Void - - - - - - - To be added. - To be added. - - - - - - - - Method - - M:Microsoft.Maui.Controls.Internals.IFontElement.OnFontFamilyChanged(System.String,System.String) - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Void - - - - - - - To be added. - To be added. - - - - - - - - Method - - M:Microsoft.Maui.Controls.Internals.IFontElement.OnFontSizeChanged(System.Double,System.Double) - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Void - - - - - - - To be added. - To be added. - - - - - - - - Method - - M:Microsoft.Maui.Controls.ISearchHandlerController.ClearPlaceholderClicked - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Void - - - - - - - - - - - Method - - M:Microsoft.Maui.Controls.ISearchHandlerController.ItemSelected(System.Object) - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Void - - - - - - To be added. - - - - - - - - Property - - P:Microsoft.Maui.Controls.ISearchHandlerController.ListProxy - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Collections.Generic.IReadOnlyList<System.Object> - - - - - - - - - - Event - - E:Microsoft.Maui.Controls.ISearchHandlerController.ListProxyChanged - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.EventHandler<Microsoft.Maui.Controls.ListProxyChangedEventArgs> - - - - - - - - - - Method - - M:Microsoft.Maui.Controls.ISearchHandlerController.QueryConfirmed - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Void - - - - - - - diff --git a/src/Controls/docs/Microsoft.Maui.Controls/Shell.xml b/src/Controls/docs/Microsoft.Maui.Controls/Shell.xml deleted file mode 100644 index a9b0421820b5..000000000000 --- a/src/Controls/docs/Microsoft.Maui.Controls/Shell.xml +++ /dev/null @@ -1,735 +0,0 @@ - - - - - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.Page - - - - Microsoft.Maui.Controls.IElementController - - - Microsoft.Maui.Controls.IPageContainer<Microsoft.Maui.Controls.Page> - - - Microsoft.Maui.Controls.IPageController - - - Microsoft.Maui.Controls.IShellController - - - Microsoft.Maui.Controls.IVisualElementController - - - - - Microsoft.Maui.Controls.ContentProperty("Items") - - - - A that provides fundamental UI features that most applications require, leaving you to focus on the application's core workload. - - - - - - - Constructor - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - - Creates a new element with default values. - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.Shell - - - Static property providing access to the current . - - This is a typecast alias for Microsoft.Maui.Controls.Application.Current.MainPage. - - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.ShellNavigationState - - - The current navigation state of the . - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.BindableProperty - - - The backing store for the field. - - - - - - - - Method - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Threading.Tasks.Task - - - - - - To be added. - - - - - - - - Method - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Threading.Tasks.Task - - - - - - - To be added. - To be added. - Asynchronously navigates to , optionally animating. - - Note that has implicit conversions from and , so developers may write code such as the following, with no explicit instantiation of the : - - - - - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Collections.Generic.IList<Microsoft.Maui.Controls.ShellItem> - - - The collection of objects managed by this. - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.BindableProperty - - - The backing store for the field. - - - - - - - - Event - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.EventHandler<Microsoft.Maui.Controls.ShellNavigatedEventArgs> - - - The library raises this event after performing navigation. - - - - - - - - Event - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.EventHandler<Microsoft.Maui.Controls.ShellNavigatingEventArgs> - - - The library raises this event immediately prior to performing navigation. - - - - - - - - Method - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Boolean - - - - Returns if the was popped in response to a press of the back button. - - if is not and is not the only item in the navigation stack. - - This method may return prior to the navigation having completed. (See .) - - - - - - - - - Method - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Void - - - - Developers may override this method to customize behavior in response to the binding context changing. - - Developers should call base.OnBindingContextChanged() at the beginning of their overriding method. - - - - - - - - - Method - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Void - - - - - - To be added. - Developers may override this method to customize behavior on navigation. - - Developers should call base.OnNavigated() at the end of their overriding method or must raise the event themselves. - - - - - - - - - Method - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Void - - - - - - To be added. - Developers may override this method to customize behavior prior to navigation. - - Developers should call base.OnNavigating() at the end of their overriding method or must raise the event themselves. - - - - - - - - - Method - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - - System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never) - - - - System.Void - - - - - - - System.Runtime.CompilerServices.CallerMemberName - - - - - - To be added. - To be added. - - - - - - - - Method - - M:Microsoft.Maui.Controls.IShellController.AddAppearanceObserver(Microsoft.Maui.Controls.IAppearanceObserver,Microsoft.Maui.Controls.Element) - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Void - - - - - - - To be added. - To be added. - For internal use by the Microsoft.Maui.Controls platform. - - - - - - - - Method - - M:Microsoft.Maui.Controls.IShellController.AddFlyoutBehaviorObserver(Microsoft.Maui.Controls.IFlyoutBehaviorObserver) - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Void - - - - - - To be added. - For internal use by the Microsoft.Maui.Controls platform. - - - - - - - - Method - - M:Microsoft.Maui.Controls.IShellController.AppearanceChanged(Microsoft.Maui.Controls.Element,System.Boolean) - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Void - - - - - - - To be added. - To be added. - For internal use by the Microsoft.Maui.Controls platform. - - - - - - - - Property - - P:Microsoft.Maui.Controls.IShellController.FlyoutHeader - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.View - - - For internal use by the Microsoft.Maui.Controls platform. - - - - - - - - Method - - M:Microsoft.Maui.Controls.IShellController.GenerateFlyoutGrouping - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Collections.Generic.List<System.Collections.Generic.List<Microsoft.Maui.Controls.Element>> - - - - For internal use by the Microsoft.Maui.Controls platform. - - - - - - - - Method - - M:Microsoft.Maui.Controls.IShellController.GetFlyoutItemDataTemplate(Microsoft.Maui.Controls.BindableObject) - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.DataTemplate - - - - - - To be added. - - - - - - - - Method - - M:Microsoft.Maui.Controls.IShellController.GetItems - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Collections.ObjectModel.ReadOnlyCollection<Microsoft.Maui.Controls.ShellItem> - - - - - - - - - - - Method - - M:Microsoft.Maui.Controls.IShellController.GetNavigationState(Microsoft.Maui.Controls.ShellItem,Microsoft.Maui.Controls.ShellSection,Microsoft.Maui.Controls.ShellContent,System.Boolean) - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.ShellNavigationState - - - - - - - - - To be added. - To be added. - To be added. - To be added. - For internal use by the Microsoft.Maui.Controls platform. - - - - - - - - Event - - E:Microsoft.Maui.Controls.IShellController.ItemsCollectionChanged - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Collections.Specialized.NotifyCollectionChangedEventHandler - - - - - - - - - - Method - - M:Microsoft.Maui.Controls.IShellController.OnFlyoutItemSelected(Microsoft.Maui.Controls.Element) - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Void - - - - - - To be added. - For internal use by the Microsoft.Maui.Controls platform. - - - - - - - - Method - - M:Microsoft.Maui.Controls.IShellController.OnFlyoutItemSelectedAsync(Microsoft.Maui.Controls.Element) - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Threading.Tasks.Task - - - - - - To be added. - For internal use by the Microsoft.Maui.Controls platform. - - - - - - - - Method - - M:Microsoft.Maui.Controls.IShellController.ProposeNavigation(Microsoft.Maui.Controls.ShellNavigationSource,Microsoft.Maui.Controls.ShellItem,Microsoft.Maui.Controls.ShellSection,Microsoft.Maui.Controls.ShellContent,System.Collections.Generic.IReadOnlyList{Microsoft.Maui.Controls.Page},System.Boolean) - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Boolean - - - - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - For internal use by the Microsoft.Maui.Controls platform. - - - - - - - - Method - - M:Microsoft.Maui.Controls.IShellController.RemoveAppearanceObserver(Microsoft.Maui.Controls.IAppearanceObserver) - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Boolean - - - - - - To be added. - For internal use by the Microsoft.Maui.Controls platform. - - - - - - - - Method - - M:Microsoft.Maui.Controls.IShellController.RemoveFlyoutBehaviorObserver(Microsoft.Maui.Controls.IFlyoutBehaviorObserver) - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Boolean - - - - - - To be added. - For internal use by the Microsoft.Maui.Controls platform. - - - - - - - - Event - - E:Microsoft.Maui.Controls.IShellController.StructureChanged - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.EventHandler - - - For internal use by the Microsoft.Maui.Controls platform. - - - - - - - - Method - - M:Microsoft.Maui.Controls.IShellController.UpdateCurrentState(Microsoft.Maui.Controls.ShellNavigationSource) - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Void - - - - - - To be added. - For internal use by the Microsoft.Maui.Controls platform. - - - - diff --git a/src/Controls/docs/Microsoft.Maui.Controls/ShellAppearance.xml b/src/Controls/docs/Microsoft.Maui.Controls/ShellAppearance.xml deleted file mode 100644 index ba390648fca5..000000000000 --- a/src/Controls/docs/Microsoft.Maui.Controls/ShellAppearance.xml +++ /dev/null @@ -1,416 +0,0 @@ - - - - - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Object - - - - Microsoft.Maui.Controls.IShellAppearanceElement - - - - - System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never) - - - - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Graphics.Color - - - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Graphics.Color - - - - - - - - - - Method - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Boolean - - - - - - To be added. - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.Brush - - - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Graphics.Color - - - - - - - - - - Method - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Int32 - - - - - - - - - - - Method - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Boolean - - - - - - To be added. - - - - - - - - Method - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Void - - - - - - - - - - - Method - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Boolean - - - - - - - To be added. - To be added. - - - - - - - - Method - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Boolean - - - - - - - To be added. - To be added. - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Graphics.Color - - - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Graphics.Color - - - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Graphics.Color - - - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Graphics.Color - - - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Graphics.Color - - - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Graphics.Color - - - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Graphics.Color - - - - - - - - - - Property - - P:Microsoft.Maui.Controls.IShellAppearanceElement.EffectiveTabBarBackgroundColor - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Graphics.Color - - - - - - - - - - Property - - P:Microsoft.Maui.Controls.IShellAppearanceElement.EffectiveTabBarDisabledColor - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Graphics.Color - - - - - - - - - - Property - - P:Microsoft.Maui.Controls.IShellAppearanceElement.EffectiveTabBarForegroundColor - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Graphics.Color - - - - - - - - - - Property - - P:Microsoft.Maui.Controls.IShellAppearanceElement.EffectiveTabBarTitleColor - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Graphics.Color - - - - - - - - - - Property - - P:Microsoft.Maui.Controls.IShellAppearanceElement.EffectiveTabBarUnselectedColor - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Graphics.Color - - - - - - diff --git a/src/Controls/docs/Microsoft.Maui.Controls/ShellContent.xml b/src/Controls/docs/Microsoft.Maui.Controls/ShellContent.xml deleted file mode 100644 index bb0684250b90..000000000000 --- a/src/Controls/docs/Microsoft.Maui.Controls/ShellContent.xml +++ /dev/null @@ -1,319 +0,0 @@ - - - - - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.BaseShellItem - - - - Microsoft.Maui.Controls.IElementController - - - Microsoft.Maui.Controls.IShellContentController - - - - - Microsoft.Maui.Controls.ContentProperty("Content") - - - - Corresponds to a contained in a . - - - - - - - Constructor - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Object - - - Gets or sets the . - Using this property will cause performance issues. Please use instead. - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.BindableProperty - - - The backing store for the field. - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.DataTemplate - - - Gets or sets a data template to create when ShellContent becomes active. - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.BindableProperty - - - The backing store for the field. - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.MenuItemCollection - - - Add instances to flyout. - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.BindableProperty - - - The backing store for the field. - - - - - - - - Method - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Void - - - - - - To be added. - - - - - - - - Method - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - - System.Obsolete("OnChildRemoved(Element) is obsolete as of version 4.8.0. Please use OnChildRemoved(Element, int) instead.") - - - - System.Void - - - - - - To be added. - - - - - - - - Method - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Void - - - - - - - To be added. - To be added. - - - - - - - - Method - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.ShellContent - - - - - - To be added. - Used primarily by XAML to implicitly wrap a page in with a . - - - - - - - - Method - - M:Microsoft.Maui.Controls.IShellContentController.GetOrCreateContent - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.Page - - - - For internal use by the Microsoft.Maui.Controls platform. - - - - - - - - Event - - E:Microsoft.Maui.Controls.IShellContentController.IsPageVisibleChanged - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.EventHandler - - - - - - - - - - Property - - P:Microsoft.Maui.Controls.IShellContentController.Page - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.Page - - - For internal use by the Microsoft.Maui.Controls platform. - - - - - - - - Method - - M:Microsoft.Maui.Controls.IShellContentController.RecyclePage(Microsoft.Maui.Controls.Page) - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Void - - - - - - To be added. - For internal use by the Microsoft.Maui.Controls platform. - - - - diff --git a/src/Controls/docs/Microsoft.Maui.Controls/ShellGroupItem.xml b/src/Controls/docs/Microsoft.Maui.Controls/ShellGroupItem.xml deleted file mode 100644 index ca66540ba626..000000000000 --- a/src/Controls/docs/Microsoft.Maui.Controls/ShellGroupItem.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.BaseShellItem - - - - A that has . Base class for and . - - - - - - - Constructor - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.FlyoutDisplayOptions - - - AsSingleItem (default) will only display the title of this item in the flyout. AsMultipleItems will create a separate flyout option for each child and . - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.BindableProperty - - - The backing store for the field. - - - - diff --git a/src/Controls/docs/Microsoft.Maui.Controls/ShellItem.xml b/src/Controls/docs/Microsoft.Maui.Controls/ShellItem.xml deleted file mode 100644 index 67e5cd8c8ae5..000000000000 --- a/src/Controls/docs/Microsoft.Maui.Controls/ShellItem.xml +++ /dev/null @@ -1,389 +0,0 @@ - - - - - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.ShellGroupItem - - - - Microsoft.Maui.Controls.IElementConfiguration<Microsoft.Maui.Controls.ShellItem> - - - Microsoft.Maui.Controls.IElementController - - - Microsoft.Maui.Controls.IShellItemController - - - - - System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never) - - - Microsoft.Maui.Controls.ContentProperty("Items") - - - - One or more items in the flyout. Contained within a . - - - - - - - Constructor - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.ShellSection - - - The currently selected or . - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.BindableProperty - - - The backing store for the field. - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Collections.Generic.IList<Microsoft.Maui.Controls.ShellSection> - - - The collection of objects managed by this. - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.BindableProperty - - - The backing store for the field. - - - - - - - - Method - - M:Microsoft.Maui.Controls.IElementConfiguration`1.On``1 - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.IPlatformElementConfiguration<T,Microsoft.Maui.Controls.ShellItem> - - - - - Microsoft.Maui.Controls.IConfigPlatform - - - - - - To be added. - - - - - - - - Method - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Void - - - - - - To be added. - Developers may override this method to customize behavior when a new is added. - - Developers should call base.OnChildAdded() at the beginning of their overriding method. - - - - - - - - - Method - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - - System.Obsolete("OnChildRemoved(Element) is obsolete as of version 4.8.0. Please use OnChildRemoved(Element, int) instead.") - - - - System.Void - - - - - - To be added. - Developers may override this method to customize behavior when a child is removed. - - Developers should call base.OnChildRemoved() at the beginning of their overriding method. - - - - - - - - - Method - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Void - - - - - - - To be added. - To be added. - - - - - - - - Method - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.ShellItem - - - - - - To be added. - Used primarily by XAML to implicitly create a from a . - - - - - - - - Method - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.ShellItem - - - - - - To be added. - Used primarily by XAML to implicitly create a from a . - - - - - - - - Method - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.ShellItem - - - - - - To be added. - Used primarily by XAML to implicitly create a from a . - - - - - - - - Method - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.ShellItem - - - - - - To be added. - Used primarily by XAML to implicitly create a from a . - - - - - - - - Method - - M:Microsoft.Maui.Controls.IShellItemController.GetItems - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Collections.ObjectModel.ReadOnlyCollection<Microsoft.Maui.Controls.ShellSection> - - - - - - - - - - - Event - - E:Microsoft.Maui.Controls.IShellItemController.ItemsCollectionChanged - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Collections.Specialized.NotifyCollectionChangedEventHandler - - - - - - - - - - Method - - M:Microsoft.Maui.Controls.IShellItemController.ProposeSection(Microsoft.Maui.Controls.ShellSection,System.Boolean) - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Boolean - - - - - - - To be added. - To be added. - For internal use by the Microsoft.Maui.Controls platform. - - - - - - - - Property - - P:Microsoft.Maui.Controls.IShellItemController.ShowTabs - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Boolean - - - - - - diff --git a/src/Controls/docs/Microsoft.Maui.Controls/ShellNavigatedEventArgs.xml b/src/Controls/docs/Microsoft.Maui.Controls/ShellNavigatedEventArgs.xml deleted file mode 100644 index 1f525727ff5a..000000000000 --- a/src/Controls/docs/Microsoft.Maui.Controls/ShellNavigatedEventArgs.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.EventArgs - - - - Arguments for the event. - - - - - - - - Constructor - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - - - - - - To be added. - To be added. - To be added. - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.ShellNavigationState - - - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.ShellNavigationState - - - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.ShellNavigationSource - - - - - - diff --git a/src/Controls/docs/Microsoft.Maui.Controls/ShellNavigatingDeferral.xml b/src/Controls/docs/Microsoft.Maui.Controls/ShellNavigatingDeferral.xml deleted file mode 100644 index 514b3a8b5f42..000000000000 --- a/src/Controls/docs/Microsoft.Maui.Controls/ShellNavigatingDeferral.xml +++ /dev/null @@ -1,35 +0,0 @@ - - - - - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Object - - - - - - - - - - - Method - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Void - - - - - - - diff --git a/src/Controls/docs/Microsoft.Maui.Controls/ShellNavigatingEventArgs.xml b/src/Controls/docs/Microsoft.Maui.Controls/ShellNavigatingEventArgs.xml deleted file mode 100644 index e660e0b26a47..000000000000 --- a/src/Controls/docs/Microsoft.Maui.Controls/ShellNavigatingEventArgs.xml +++ /dev/null @@ -1,156 +0,0 @@ - - - - - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.EventArgs - - - - Arguments for the event. - - - - - - - - Constructor - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - - - - - - - To be added. - To be added. - To be added. - To be added. - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Boolean - - - - - - - - - - Method - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Boolean - - - - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Boolean - - - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.ShellNavigationState - - - - - - - - - - Method - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.ShellNavigatingDeferral - - - - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.ShellNavigationSource - - - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.ShellNavigationState - - - - - - diff --git a/src/Controls/docs/Microsoft.Maui.Controls/ShellNavigationSource.xml b/src/Controls/docs/Microsoft.Maui.Controls/ShellNavigationSource.xml deleted file mode 100644 index f538073492c8..000000000000 --- a/src/Controls/docs/Microsoft.Maui.Controls/ShellNavigationSource.xml +++ /dev/null @@ -1,171 +0,0 @@ - - - - - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Enum - - - Enumerates reasons for a navigation event in Shell applications. - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.ShellNavigationSource - - 4 - - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.ShellNavigationSource - - 2 - - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.ShellNavigationSource - - 3 - - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.ShellNavigationSource - - 1 - - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.ShellNavigationSource - - 5 - - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.ShellNavigationSource - - 8 - - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.ShellNavigationSource - - 6 - - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.ShellNavigationSource - - 7 - - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.ShellNavigationSource - - 0 - - - - - diff --git a/src/Controls/docs/Microsoft.Maui.Controls/ShellNavigationState.xml b/src/Controls/docs/Microsoft.Maui.Controls/ShellNavigationState.xml deleted file mode 100644 index 8b22da12e73c..000000000000 --- a/src/Controls/docs/Microsoft.Maui.Controls/ShellNavigationState.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Object - - - - - System.Diagnostics.DebuggerDisplay("Location = {Location}") - - - - A URI representing either the current page or a destination for navigation in a Shell application. - - - - - - - Constructor - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - - - - - - - - - Constructor - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - - - - To be added. - - - - - - - - Constructor - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - - - - To be added. - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Uri - - - - - - - - - - Method - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.ShellNavigationState - - - - - - To be added. - - - - - - - - Method - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.ShellNavigationState - - - - - - To be added. - - - - diff --git a/src/Controls/docs/Microsoft.Maui.Controls/ShellSection.xml b/src/Controls/docs/Microsoft.Maui.Controls/ShellSection.xml deleted file mode 100644 index 9264f8ee595c..000000000000 --- a/src/Controls/docs/Microsoft.Maui.Controls/ShellSection.xml +++ /dev/null @@ -1,723 +0,0 @@ - - - - - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.ShellGroupItem - - - - Microsoft.Maui.Controls.IElementController - - - Microsoft.Maui.Controls.IShellSectionController - - - - - System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never) - - - Microsoft.Maui.Controls.ContentProperty("Items") - - - - Grouped content in a Shell application, navigable by bottom tabs. - - - - - - - Constructor - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.ShellContent - - - The currently selected . - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.BindableProperty - - - The backing store for the field. - - - - - - - - Method - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Collections.Generic.IReadOnlyList<Microsoft.Maui.Controls.Page> - - - - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Collections.Generic.IList<Microsoft.Maui.Controls.ShellContent> - - - The collection of objects managed by this. - - - - - - - - Field - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.BindableProperty - - - The backing store for the field. - - - - - - - - Method - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Void - - - - - - - - - - - Method - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Void - - - - - - To be added. - Developers may override this method to customize behavior when a new is added. - - Developers should call base.OnChildAdded() at the beginning of their overriding method. - - - - - - - - - Method - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - - System.Obsolete("OnChildRemoved(Element) is obsolete as of version 4.8.0. Please use OnChildRemoved(Element, int) instead.") - - - - System.Void - - - - - - To be added. - Developers may override this method to customize behavior when a child is removed. - - Developers should call base.OnChildRemoved() at the beginning of their overriding method. - - - - - - - - - Method - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Void - - - - - - - To be added. - To be added. - - - - - - - - Method - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Void - - - - - - - To be added. - To be added. - - - - - - - - Method - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Threading.Tasks.Task<Microsoft.Maui.Controls.Page> - - - - - - To be added. - - - - - - - - Method - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Threading.Tasks.Task - - - - - - To be added. - - - - - - - - Method - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Threading.Tasks.Task - - - - - - - To be added. - To be added. - - - - - - - - Method - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Void - - - - - - To be added. - - - - - - - - Method - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.ShellSection - - - - - - To be added. - - - - - - - - Method - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.ShellSection - - - - - - To be added. - - - - - - - - Property - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Collections.Generic.IReadOnlyList<Microsoft.Maui.Controls.Page> - - - - - - - - - - Method - - M:Microsoft.Maui.Controls.IShellSectionController.AddContentInsetObserver(Microsoft.Maui.Controls.IShellContentInsetObserver) - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Void - - - - - - To be added. - For internal use by the Microsoft.Maui.Controls platform. - - - - - - - - Method - - M:Microsoft.Maui.Controls.IShellSectionController.AddDisplayedPageObserver(System.Object,System.Action{Microsoft.Maui.Controls.Page}) - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Void - - - - - - - To be added. - To be added. - For internal use by the Microsoft.Maui.Controls platform. - - - - - - - - Method - - M:Microsoft.Maui.Controls.IShellSectionController.GetItems - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Collections.ObjectModel.ReadOnlyCollection<Microsoft.Maui.Controls.ShellContent> - - - - - - - - - - - Event - - E:Microsoft.Maui.Controls.IShellSectionController.ItemsCollectionChanged - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Collections.Specialized.NotifyCollectionChangedEventHandler - - - - - - - - - - Event - - E:Microsoft.Maui.Controls.IShellSectionController.NavigationRequested - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.EventHandler<Microsoft.Maui.Controls.Internals.NavigationRequestedEventArgs> - - - - - - - - - - Property - - P:Microsoft.Maui.Controls.IShellSectionController.PresentedPage - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.Page - - - For internal use by the Microsoft.Maui.Controls platform. - - - - - - - - Method - - M:Microsoft.Maui.Controls.IShellSectionController.RemoveContentInsetObserver(Microsoft.Maui.Controls.IShellContentInsetObserver) - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Boolean - - - - - - To be added. - For internal use by the Microsoft.Maui.Controls platform. - - - - - - - - Method - - M:Microsoft.Maui.Controls.IShellSectionController.RemoveDisplayedPageObserver(System.Object) - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Boolean - - - - - - To be added. - For internal use by the Microsoft.Maui.Controls platform. - - - - - - - - Method - - M:Microsoft.Maui.Controls.IShellSectionController.SendInsetChanged(Microsoft.Maui.Thickness,System.Double) - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Void - - - - - - - To be added. - To be added. - For internal use by the Microsoft.Maui.Controls platform. - - - - - - - - Method - - M:Microsoft.Maui.Controls.IShellSectionController.SendPopped - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - - System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never) - - - System.Obsolete - - - - System.Void - - - - For internal use by the Microsoft.Maui.Controls platform. - - - - - - - - Method - - M:Microsoft.Maui.Controls.IShellSectionController.SendPopped(Microsoft.Maui.Controls.Page) - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - - System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never) - - - System.Obsolete - - - - System.Void - - - - - - To be added. - - - - - - - - Method - - M:Microsoft.Maui.Controls.IShellSectionController.SendPopping(System.Threading.Tasks.Task) - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Void - - - - - - To be added. - - - - - - - - Method - - M:Microsoft.Maui.Controls.IShellSectionController.SendPopping(Microsoft.Maui.Controls.Page) - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - - System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never) - - - System.Obsolete - - - - System.Void - - - - - - To be added. - - - - - - - - Method - - M:Microsoft.Maui.Controls.IShellSectionController.SendPoppingToRoot(System.Threading.Tasks.Task) - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - System.Void - - - - - - To be added. - - - - diff --git a/src/Controls/docs/Microsoft.Maui.Controls/Tab.xml b/src/Controls/docs/Microsoft.Maui.Controls/Tab.xml deleted file mode 100644 index b3d298d661a3..000000000000 --- a/src/Controls/docs/Microsoft.Maui.Controls/Tab.xml +++ /dev/null @@ -1,36 +0,0 @@ - - - - - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.ShellSection - - - - - System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always) - - - - - - - - - - Constructor - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - - - - - diff --git a/src/Controls/docs/Microsoft.Maui.Controls/TabBar.xml b/src/Controls/docs/Microsoft.Maui.Controls/TabBar.xml deleted file mode 100644 index 68061457ea03..000000000000 --- a/src/Controls/docs/Microsoft.Maui.Controls/TabBar.xml +++ /dev/null @@ -1,36 +0,0 @@ - - - - - - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - Microsoft.Maui.Controls.ShellItem - - - - - System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always) - - - - - - - - - - Constructor - - Microsoft.Maui.Controls.Core - 2.0.0.0 - - - - - - - diff --git a/src/Controls/src/Core/Shell/BackButtonBehavior.cs b/src/Controls/src/Core/Shell/BackButtonBehavior.cs index 00cda2e1b393..b75a45c308fa 100644 --- a/src/Controls/src/Core/Shell/BackButtonBehavior.cs +++ b/src/Controls/src/Core/Shell/BackButtonBehavior.cs @@ -4,7 +4,9 @@ namespace Microsoft.Maui.Controls { - /// + /// + /// Customizes the appearance and behavior of the back button in a application. + /// public class BackButtonBehavior : BindableObject { /// Bindable property for . @@ -33,41 +35,54 @@ public class BackButtonBehavior : BindableObject public static readonly BindableProperty TextOverrideProperty = BindableProperty.Create(nameof(TextOverride), typeof(string), typeof(BackButtonBehavior), null, BindingMode.OneTime); - /// + /// + /// Gets or sets the command to execute when the back button is pressed. This is a bindable property. + /// public ICommand Command { get { return (ICommand)GetValue(CommandProperty); } set { SetValue(CommandProperty, value); } } - /// + /// + /// Gets or sets the parameter to pass to the . This is a bindable property. + /// public object CommandParameter { get { return GetValue(CommandParameterProperty); } set { SetValue(CommandParameterProperty, value); } } - /// + /// + /// Gets or sets the icon to use instead of the default back button icon. This is a bindable property. + /// public ImageSource IconOverride { get { return (ImageSource)GetValue(IconOverrideProperty); } set { SetValue(IconOverrideProperty, value); } } - /// + /// + /// Gets or sets a value indicating whether the back button is enabled. This is a bindable property. + /// public bool IsEnabled { get { return (bool)GetValue(IsEnabledProperty); } set { SetValue(IsEnabledProperty, value); } } + /// + /// Gets or sets a value indicating whether the back button is visible. This is a bindable property. + /// public bool IsVisible { get { return (bool)GetValue(IsVisibleProperty); } set { SetValue(IsVisibleProperty, value); } } - /// + /// + /// Gets or sets the text to display instead of the default back button text. This is a bindable property. + /// public string TextOverride { get { return (string)GetValue(TextOverrideProperty); } diff --git a/src/Controls/src/Core/Shell/BaseShellItem.cs b/src/Controls/src/Core/Shell/BaseShellItem.cs index 74f003f0dba3..332640961c57 100644 --- a/src/Controls/src/Core/Shell/BaseShellItem.cs +++ b/src/Controls/src/Core/Shell/BaseShellItem.cs @@ -12,7 +12,9 @@ namespace Microsoft.Maui.Controls { - /// + /// + /// Base class for Shell navigation items providing common properties like Title, Icon, and Route. + /// [DebuggerDisplay("Title = {Title}, Route = {Route}")] [DebuggerTypeProxy(typeof(BaseShellItemDebugView))] public class BaseShellItem : NavigableElement, IPropertyPropagationController, IVisualController, IFlowDirectionController, IWindowController @@ -75,52 +77,68 @@ public BaseShellItem() }; } - /// + /// + /// Gets or sets the icon displayed for this item in the flyout. This is a bindable property. + /// public ImageSource FlyoutIcon { get { return (ImageSource)GetValue(FlyoutIconProperty); } set { SetValue(FlyoutIconProperty, value); } } - /// + /// + /// Gets or sets the icon displayed for this item in the tab bar. This is a bindable property. + /// public ImageSource Icon { get { return (ImageSource)GetValue(IconProperty); } set { SetValue(IconProperty, value); } } - /// + /// + /// Gets a value indicating whether this item is currently selected. This is a bindable property. + /// public bool IsChecked => (bool)GetValue(IsCheckedProperty); - /// + /// + /// Gets or sets a value indicating whether this item is enabled. This is a bindable property. + /// public bool IsEnabled { get { return (bool)GetValue(IsEnabledProperty); } set { SetValue(IsEnabledProperty, value); } } - /// + /// + /// Gets or sets the route used for URI-based Shell navigation. + /// public string Route { get { return Routing.GetRoute(this); } set { Routing.SetRoute(this, value); } } - /// + /// + /// Gets or sets the title displayed in the UI for this item. This is a bindable property. + /// public string Title { get { return (string)GetValue(TitleProperty); } set { SetValue(TitleProperty, value); } } - /// + /// + /// Gets or sets a value indicating whether this item is visible in the Shell UI. This is a bindable property. + /// public bool IsVisible { get => (bool)GetValue(IsVisibleProperty); set => SetValue(IsVisibleProperty, value); } - /// + /// + /// Gets or sets a value indicating whether this item is visible in the flyout menu. This is a bindable property. + /// public bool FlyoutItemIsVisible { get => (bool)GetValue(FlyoutItemIsVisibleProperty); diff --git a/src/Controls/src/Core/Shell/FlyoutDisplayOptions.cs b/src/Controls/src/Core/Shell/FlyoutDisplayOptions.cs index ae7d30ca2461..71bc41a2f9b6 100644 --- a/src/Controls/src/Core/Shell/FlyoutDisplayOptions.cs +++ b/src/Controls/src/Core/Shell/FlyoutDisplayOptions.cs @@ -1,11 +1,11 @@ namespace Microsoft.Maui.Controls { - /// + /// Specifies how items are displayed in the flyout. public enum FlyoutDisplayOptions { - /// + /// The item appears as a single entry in the flyout. AsSingleItem, - /// + /// The item's children appear as separate entries in the flyout. AsMultipleItems, } } \ No newline at end of file diff --git a/src/Controls/src/Core/Shell/FlyoutHeaderBehavior.cs b/src/Controls/src/Core/Shell/FlyoutHeaderBehavior.cs index 7de807db3729..1b29f175691a 100644 --- a/src/Controls/src/Core/Shell/FlyoutHeaderBehavior.cs +++ b/src/Controls/src/Core/Shell/FlyoutHeaderBehavior.cs @@ -1,15 +1,15 @@ namespace Microsoft.Maui.Controls { - /// + /// Specifies how the flyout header behaves when scrolling. public enum FlyoutHeaderBehavior { - /// + /// Header uses platform-specific default scroll behavior. Default, - /// + /// Header remains fixed and does not scroll. Fixed, - /// + /// Header scrolls with the flyout content. Scroll, - /// + /// Header collapses as the user scrolls down. CollapseOnScroll, } } \ No newline at end of file diff --git a/src/Controls/src/Core/Shell/MenuItemCollection.cs b/src/Controls/src/Core/Shell/MenuItemCollection.cs index 01f1bbb7d8d9..8cfd14f9022a 100644 --- a/src/Controls/src/Core/Shell/MenuItemCollection.cs +++ b/src/Controls/src/Core/Shell/MenuItemCollection.cs @@ -6,7 +6,7 @@ namespace Microsoft.Maui.Controls { - /// + /// A collection of objects used in Shell. public sealed class MenuItemCollection : IEnumerable, IList, INotifyCollectionChanged { ObservableCollection _inner = new ObservableCollection(); @@ -17,10 +17,10 @@ event NotifyCollectionChangedEventHandler INotifyCollectionChanged.CollectionCha remove { ((INotifyCollectionChanged)_inner).CollectionChanged -= value; } } - /// + /// Gets the number of menu items in the collection. public int Count => _inner.Count; - /// + /// Gets a value indicating whether the collection is read-only. public bool IsReadOnly => ((IList)_inner).IsReadOnly; public MenuItem this[int index] @@ -29,31 +29,31 @@ public MenuItem this[int index] set => _inner[index] = value; } - /// + /// Adds a menu item to the collection. public void Add(MenuItem item) => _inner.Add(item); - /// + /// Removes all menu items from the collection. public void Clear() => _inner.Clear(); - /// + /// Determines whether the collection contains a specific menu item. public bool Contains(MenuItem item) => _inner.Contains(item); - /// + /// Copies the menu items to an array, starting at the specified index. public void CopyTo(MenuItem[] array, int arrayIndex) => _inner.CopyTo(array, arrayIndex); - /// + /// Returns an enumerator that iterates through the collection. public IEnumerator GetEnumerator() => _inner.GetEnumerator(); - /// + /// Returns the index of the specified menu item. public int IndexOf(MenuItem item) => _inner.IndexOf(item); - /// + /// Inserts a menu item at the specified index. public void Insert(int index, MenuItem item) => _inner.Insert(index, item); - /// + /// Removes the specified menu item from the collection. public bool Remove(MenuItem item) => _inner.Remove(item); - /// + /// Removes the menu item at the specified index. public void RemoveAt(int index) => _inner.RemoveAt(index); IEnumerator IEnumerable.GetEnumerator() => ((IEnumerable)_inner).GetEnumerator(); diff --git a/src/Controls/src/Core/Shell/PresentationMode.cs b/src/Controls/src/Core/Shell/PresentationMode.cs index 85590e009d15..c3263b85ce90 100644 --- a/src/Controls/src/Core/Shell/PresentationMode.cs +++ b/src/Controls/src/Core/Shell/PresentationMode.cs @@ -1,22 +1,20 @@ using System; -using System.Collections.Generic; -using System.Text; namespace Microsoft.Maui.Controls { - /// + /// Specifies how pages are presented during navigation. [Flags] public enum PresentationMode { - /// + /// Navigation occurs without animation. NotAnimated = 1, - /// + /// Navigation occurs with animation. Animated = 1 << 1, - /// + /// Page is presented modally. Modal = 1 << 2, - /// + /// Page is presented modally with animation. ModalAnimated = PresentationMode.Animated | PresentationMode.Modal, - /// + /// Page is presented modally without animation. ModalNotAnimated = PresentationMode.NotAnimated | PresentationMode.Modal } } diff --git a/src/Controls/src/Core/Shell/QueryPropertyAttribute.cs b/src/Controls/src/Core/Shell/QueryPropertyAttribute.cs index 191cb3af6e6d..b3df2717c34d 100644 --- a/src/Controls/src/Core/Shell/QueryPropertyAttribute.cs +++ b/src/Controls/src/Core/Shell/QueryPropertyAttribute.cs @@ -4,17 +4,19 @@ namespace Microsoft.Maui.Controls { - /// + /// Maps a query parameter from a URI to a property on the target page or view model during Shell navigation. [AttributeUsage(AttributeTargets.Class, AllowMultiple = true)] [RequiresUnreferencedCode(TrimmerConstants.QueryPropertyAttributeWarning, Url = TrimmerConstants.QueryPropertyDocsUrl)] public class QueryPropertyAttribute : Attribute { - /// + /// Gets the name of the property that will receive the query parameter value. public string Name { get; } - /// + /// Gets the query parameter name from the URI. public string QueryId { get; } - /// + /// Creates a new that maps a query parameter to a property. + /// The name of the property to set. + /// The query parameter name in the URI. public QueryPropertyAttribute(string name, string queryId) { Name = name; diff --git a/src/Controls/src/Core/Shell/SearchHandler.cs b/src/Controls/src/Core/Shell/SearchHandler.cs index 0788e13052db..958be4bd455f 100644 --- a/src/Controls/src/Core/Shell/SearchHandler.cs +++ b/src/Controls/src/Core/Shell/SearchHandler.cs @@ -10,10 +10,12 @@ namespace Microsoft.Maui.Controls { - /// + /// + /// Provides search functionality in a application. + /// public class SearchHandler : BindableObject, ISearchHandlerController, IPlaceholderElement, IFontElement, ITextElement, ITextAlignmentElement { - /// + /// Bindable property key for . [EditorBrowsable(EditorBrowsableState.Never)] public static readonly BindablePropertyKey IsFocusedPropertyKey = BindableProperty.CreateReadOnly(nameof(IsFocused), typeof(bool), typeof(VisualElement), default(bool), propertyChanged: OnIsFocusedPropertyChanged); @@ -27,7 +29,7 @@ public class SearchHandler : BindableObject, ISearchHandlerController, IPlacehol /// Bindable property for . public static readonly BindableProperty IsFocusedProperty = IsFocusedPropertyKey.BindableProperty; - /// + /// Gets a value indicating whether this search handler currently has focus. This is a bindable property. public bool IsFocused { get { return (bool)GetValue(IsFocusedProperty); } @@ -55,7 +57,7 @@ static void OnIsFocusedPropertyChanged(BindableObject bindable, object oldvalue, } } - /// + /// Sets the value of the property. For internal use by platform renderers. [EditorBrowsable(EditorBrowsableState.Never)] public void SetIsFocused(bool value) { @@ -64,7 +66,8 @@ public void SetIsFocused(bool value) [EditorBrowsable(EditorBrowsableState.Never)] public event EventHandler FocusChangeRequested; - /// + /// Sets focus to the search handler, causing the input field to become the current focus. + /// if the search handler gained focus; otherwise, . public bool Focus() { if (IsFocused) @@ -78,7 +81,7 @@ public bool Focus() return arg.Result; } - /// + /// Removes focus from the search handler. public void Unfocus() { if (!IsFocused) @@ -110,7 +113,7 @@ protected virtual void OnUnfocus() /// Bindable property for . public static readonly BindableProperty KeyboardProperty = BindableProperty.Create(nameof(Keyboard), typeof(Keyboard), typeof(SearchHandler), Keyboard.Default, coerceValue: (o, v) => (Keyboard)v ?? Keyboard.Default); - /// + /// Gets or sets the keyboard type for the search input. This is a bindable property. public Keyboard Keyboard { get { return (Keyboard)GetValue(KeyboardProperty); } @@ -127,14 +130,14 @@ void ITextAlignmentElement.OnHorizontalTextAlignmentPropertyChanged(TextAlignmen { } - /// + /// Gets or sets the horizontal alignment of the search text. This is a bindable property. public TextAlignment HorizontalTextAlignment { get { return (TextAlignment)GetValue(TextAlignmentElement.HorizontalTextAlignmentProperty); } set { SetValue(TextAlignmentElement.HorizontalTextAlignmentProperty, value); } } - /// + /// Gets or sets the vertical alignment of the search text. This is a bindable property. public TextAlignment VerticalTextAlignment { get { return (TextAlignment)GetValue(TextAlignmentElement.VerticalTextAlignmentProperty); } @@ -147,7 +150,7 @@ public TextAlignment VerticalTextAlignment /// Bindable property for . public static readonly BindableProperty CharacterSpacingProperty = TextElement.CharacterSpacingProperty; - /// + /// Gets or sets the color of the search text. This is a bindable property. public Color TextColor { get { return (Color)GetValue(TextElement.TextColorProperty); } @@ -178,7 +181,7 @@ public Color TextColor /// Bindable property for . public static readonly BindableProperty TextTransformProperty = TextElement.TextTransformProperty; - /// + /// Gets or sets the text transformation applied to the search text. This is a bindable property. public TextTransform TextTransform { get => (TextTransform)GetValue(TextTransformProperty); @@ -189,11 +192,11 @@ void ITextElement.OnTextTransformChanged(TextTransform oldValue, TextTransform n { } - /// + /// Returns the transformed text using the specified . public virtual string UpdateFormsText(string source, TextTransform textTransform) => TextTransformUtilities.GetTransformedText(source, textTransform); - /// + /// Gets or sets the color of the cancel button. This is a bindable property. public Color CancelButtonColor { get { return (Color)GetValue(CancelButtonColorProperty); } @@ -201,28 +204,28 @@ public Color CancelButtonColor } - /// + /// Gets or sets the font attributes for the search text. This is a bindable property. public FontAttributes FontAttributes { get { return (FontAttributes)GetValue(FontAttributesProperty); } set { SetValue(FontAttributesProperty, value); } } - /// + /// Gets or sets the font family for the search text. This is a bindable property. public string FontFamily { get { return (string)GetValue(FontFamilyProperty); } set { SetValue(FontFamilyProperty, value); } } - /// + /// Gets or sets the character spacing for the search text. This is a bindable property. public double CharacterSpacing { get { return (double)GetValue(TextElement.CharacterSpacingProperty); } set { SetValue(TextElement.CharacterSpacingProperty, value); } } - /// + /// Gets or sets the font size for the search text. This is a bindable property. [System.ComponentModel.TypeConverter(typeof(FontSizeConverter))] public double FontSize { @@ -255,14 +258,14 @@ void IFontElement.OnFontAttributesChanged(FontAttributes oldValue, FontAttribute { } - /// + /// Gets or sets the color of the placeholder text. This is a bindable property. public Color PlaceholderColor { get => (Color)GetValue(PlaceholderElement.PlaceholderColorProperty); set => SetValue(PlaceholderElement.PlaceholderColorProperty, value); } - /// + /// Gets or sets the text displayed when the search box is empty. This is a bindable property. public string Placeholder { get => (string)GetValue(PlaceholderElement.PlaceholderProperty); @@ -272,7 +275,7 @@ public string Placeholder /// Bindable property for . public static readonly BindableProperty BackgroundColorProperty = BindableProperty.Create(nameof(BackgroundColor), typeof(Color), typeof(SearchHandler), null); - /// + /// Gets or sets the background color of the search box. This is a bindable property. public Color BackgroundColor { get { return (Color)GetValue(BackgroundColorProperty); } @@ -420,7 +423,7 @@ void ISearchHandlerController.QueryConfirmed() static readonly BindablePropertyKey SelectedItemPropertyKey = BindableProperty.CreateReadOnly(nameof(SelectedItem), typeof(object), typeof(SearchHandler), null, BindingMode.OneWayToSource); - /// + /// Bindable property for . public static BindableProperty SelectedItemProperty = SelectedItemPropertyKey.BindableProperty; /// Bindable property for . @@ -435,84 +438,84 @@ public string AutomationId set { SetValue(AutomationIdProperty, value); } } - /// + /// Gets or sets the icon displayed for the clear button. This is a bindable property. public ImageSource ClearIcon { get { return (ImageSource)GetValue(ClearIconProperty); } set { SetValue(ClearIconProperty, value); } } - /// + /// Gets or sets the accessibility help text for the clear icon. This is a bindable property. public string ClearIconHelpText { get { return (string)GetValue(ClearIconHelpTextProperty); } set { SetValue(ClearIconHelpTextProperty, value); } } - /// + /// Gets or sets the accessibility name for the clear icon. This is a bindable property. public string ClearIconName { get { return (string)GetValue(ClearIconNameProperty); } set { SetValue(ClearIconNameProperty, value); } } - /// + /// Gets or sets the command invoked when the clear placeholder button is pressed. This is a bindable property. public ICommand ClearPlaceholderCommand { get { return (ICommand)GetValue(ClearPlaceholderCommandProperty); } set { SetValue(ClearPlaceholderCommandProperty, value); } } - /// + /// Gets or sets the parameter passed to . This is a bindable property. public object ClearPlaceholderCommandParameter { get { return GetValue(ClearPlaceholderCommandParameterProperty); } set { SetValue(ClearPlaceholderCommandParameterProperty, value); } } - /// + /// Gets or sets a value indicating whether the clear placeholder button is enabled. This is a bindable property. public bool ClearPlaceholderEnabled { get { return (bool)GetValue(ClearPlaceholderEnabledProperty); } set { SetValue(ClearPlaceholderEnabledProperty, value); } } - /// + /// Gets or sets the accessibility help text for the clear placeholder icon. This is a bindable property. public string ClearPlaceholderHelpText { get { return (string)GetValue(ClearPlaceholderHelpTextProperty); } set { SetValue(ClearPlaceholderHelpTextProperty, value); } } - /// + /// Gets or sets the icon displayed for the clear placeholder button. This is a bindable property. public ImageSource ClearPlaceholderIcon { get { return (ImageSource)GetValue(ClearPlaceholderIconProperty); } set { SetValue(ClearPlaceholderIconProperty, value); } } - /// + /// Gets or sets the accessibility name for the clear placeholder icon. This is a bindable property. public string ClearPlaceholderName { get { return (string)GetValue(ClearPlaceholderNameProperty); } set { SetValue(ClearPlaceholderNameProperty, value); } } - /// + /// Gets or sets the command invoked when the search query is confirmed. This is a bindable property. public ICommand Command { get { return (ICommand)GetValue(CommandProperty); } set { SetValue(CommandProperty, value); } } - /// + /// Gets or sets the parameter passed to . This is a bindable property. public object CommandParameter { get { return (object)GetValue(CommandParameterProperty); } set { SetValue(CommandParameterProperty, value); } } - /// + /// Gets or sets the name of the property to display for search results. This is a bindable property. [Obsolete("Use ItemTemplate instead.")] public string DisplayMemberName { @@ -520,66 +523,66 @@ public string DisplayMemberName set { SetValue(DisplayMemberNameProperty, value); } } - /// + /// Gets or sets a value indicating whether search is enabled. This is a bindable property. public bool IsSearchEnabled { get { return (bool)GetValue(IsSearchEnabledProperty); } set { SetValue(IsSearchEnabledProperty, value); } } - /// + /// Gets or sets the collection of items to display as search suggestions. This is a bindable property. public IEnumerable ItemsSource { get { return (IEnumerable)GetValue(ItemsSourceProperty); } set { SetValue(ItemsSourceProperty, value); } } - /// + /// Gets or sets the template for displaying search result items. This is a bindable property. public DataTemplate ItemTemplate { get { return (DataTemplate)GetValue(ItemTemplateProperty); } set { SetValue(ItemTemplateProperty, value); } } - /// + /// Gets or sets the current search query text. This is a bindable property. public string Query { get { return (string)GetValue(QueryProperty); } set { SetValue(QueryProperty, value); } } - /// + /// Gets or sets the icon displayed for the search query. This is a bindable property. public ImageSource QueryIcon { get { return (ImageSource)GetValue(QueryIconProperty); } set { SetValue(QueryIconProperty, value); } } - /// + /// Gets or sets the accessibility help text for the query icon. This is a bindable property. public string QueryIconHelpText { get { return (string)GetValue(QueryIconHelpTextProperty); } set { SetValue(QueryIconHelpTextProperty, value); } } - /// + /// Gets or sets the accessibility name for the query icon. This is a bindable property. public string QueryIconName { get { return (string)GetValue(QueryIconNameProperty); } set { SetValue(QueryIconNameProperty, value); } } - /// + /// Gets or sets the visibility mode of the search box. This is a bindable property. public SearchBoxVisibility SearchBoxVisibility { get { return (SearchBoxVisibility)GetValue(SearchBoxVisibilityProperty); } set { SetValue(SearchBoxVisibilityProperty, value); } } - /// + /// Gets the currently selected search result item. This is a bindable property. public object SelectedItem => GetValue(SelectedItemProperty); - /// + /// Gets or sets a value indicating whether search results are displayed. This is a bindable property. public bool ShowsResults { get { return (bool)GetValue(ShowsResultsProperty); } diff --git a/src/Controls/src/Core/Shell/Shell.cs b/src/Controls/src/Core/Shell/Shell.cs index 4284b3137c06..8be8a6fcacd9 100644 --- a/src/Controls/src/Core/Shell/Shell.cs +++ b/src/Controls/src/Core/Shell/Shell.cs @@ -20,7 +20,9 @@ namespace Microsoft.Maui.Controls { - /// + /// + /// The main navigation container for .NET MAUI apps, providing flyout and tab-based navigation. + /// [ContentProperty(nameof(Items))] [DebuggerTypeProxy(typeof(ShellDebugView))] public partial class Shell : Page, IShellController, IPropertyPropagationController, IPageContainer, IFlyoutView @@ -193,7 +195,11 @@ static void OnFlyoutItemIsVisibleChanged(BindableObject bindable, object oldValu /// The applied to Item objects. public static void SetItemTemplate(BindableObject obj, DataTemplate itemTemplate) => obj.SetValue(ItemTemplateProperty, itemTemplate); - /// + /// + /// Gets the for the specified . + /// + /// The object from which to get the back button behavior. + /// The back button behavior for the object. public static BackButtonBehavior GetBackButtonBehavior(BindableObject obj) => (BackButtonBehavior)obj.GetValue(BackButtonBehaviorProperty); /// @@ -972,7 +978,9 @@ event NotifyCollectionChangedEventHandler IShellController.ItemsCollectionChange remove { ((ShellItemCollection)Items).VisibleItemsChanged -= value; } } - /// + /// + /// Gets the current instance from the active application window. + /// public static Shell Current { get @@ -1026,13 +1034,19 @@ public static Shell Current } internal ShellNavigationManager NavigationManager => _navigationManager; - /// + + /// Asynchronously navigates to the specified . + /// The shell navigation state to navigate to. + /// A task that represents the asynchronous navigation operation. public Task GoToAsync(ShellNavigationState state) { return _navigationManager.GoToAsync(state, null, false); } - /// + /// Asynchronously navigates to the specified with animation control. + /// The shell navigation state to navigate to. + /// Whether to animate the navigation transition. + /// A task that represents the asynchronous navigation operation. public Task GoToAsync(ShellNavigationState state, bool animate) { return _navigationManager.GoToAsync(state, animate, false); @@ -1179,7 +1193,7 @@ public Task GoToAsync(ShellNavigationState state, bool animate, ShellNavigationQ ShellFlyoutItemsManager _flyoutManager; Page _previousPage; - /// + /// Initializes a new instance of the class. public Shell() { Toolbar = new ShellToolbar(this); @@ -1337,7 +1351,7 @@ public ShellItem CurrentItem internal ShellContent CurrentContent => CurrentItem?.CurrentItem?.CurrentItem; internal ShellSection CurrentSection => CurrentItem?.CurrentItem; - /// + /// Gets the current navigation state of the Shell. This is a bindable property. public ShellNavigationState CurrentState => (ShellNavigationState)GetValue(CurrentStateProperty); /// @@ -1470,7 +1484,7 @@ public bool FlyoutIsPresented set => SetValue(FlyoutIsPresentedProperty, value); } - /// + /// Gets the collection of objects in the Shell. This is a bindable property. public IList Items => (IList)GetValue(ItemsProperty); /// diff --git a/src/Controls/src/Core/Shell/ShellAppearance.cs b/src/Controls/src/Core/Shell/ShellAppearance.cs index 7bd3ff8b466e..224e2700f17f 100644 --- a/src/Controls/src/Core/Shell/ShellAppearance.cs +++ b/src/Controls/src/Core/Shell/ShellAppearance.cs @@ -6,7 +6,7 @@ namespace Microsoft.Maui.Controls { - /// + /// Stores the appearance values for a Shell, including colors for background, foreground, tab bar, and title. [EditorBrowsable(EditorBrowsableState.Never)] public class ShellAppearance : IShellAppearanceElement { @@ -39,37 +39,37 @@ public class ShellAppearance : IShellAppearanceElement Brush[] _brushArray = new Brush[s_ingestBrushArray.Length]; double[] _doubleArray = new double[s_ingestDoubleArray.Length]; - /// + /// Gets the background color of the Shell. public Color BackgroundColor => _colorArray[0]; - /// + /// Gets the color for disabled items in the Shell. public Color DisabledColor => _colorArray[1]; - /// + /// Gets the foreground color of the Shell. public Color ForegroundColor => _colorArray[2]; - /// + /// Gets the background color of the tab bar. public Color TabBarBackgroundColor => _colorArray[3]; - /// + /// Gets the color for disabled items in the tab bar. public Color TabBarDisabledColor => _colorArray[4]; - /// + /// Gets the foreground color of the tab bar. public Color TabBarForegroundColor => _colorArray[5]; - /// + /// Gets the title color of the tab bar. public Color TabBarTitleColor => _colorArray[6]; - /// + /// Gets the color for unselected items in the tab bar. public Color TabBarUnselectedColor => _colorArray[7]; - /// + /// Gets the title color of the Shell. public Color TitleColor => _colorArray[8]; - /// + /// Gets the color for unselected items in the Shell. public Color UnselectedColor => _colorArray[9]; - /// + /// Gets the backdrop brush for the Shell flyout. public Brush FlyoutBackdrop => _brushArray[0]; public double FlyoutWidth => _doubleArray[0]; public double FlyoutHeight => _doubleArray[1]; @@ -98,7 +98,7 @@ internal ShellAppearance() _doubleArray[i] = -1; } - /// + /// public override bool Equals(object obj) { if (!(obj is ShellAppearance appearance)) @@ -125,7 +125,7 @@ public override bool Equals(object obj) return true; } - /// + /// public override int GetHashCode() { var hashCode = -1988429770; @@ -141,7 +141,9 @@ public override int GetHashCode() return hashCode; } - /// + /// Ingests appearance values from the specified element into this instance. + /// The element to read appearance values from. + /// if any values were ingested; otherwise, . public bool Ingest(Element pivot) { bool anySet = false; @@ -179,7 +181,7 @@ public bool Ingest(Element pivot) return anySet; } - /// + /// Marks the appearance as complete by filling any remaining null values. public void MakeComplete() { for (int i = 0; i < s_ingestArray.Length; i++) diff --git a/src/Controls/src/Core/Shell/ShellContent.cs b/src/Controls/src/Core/Shell/ShellContent.cs index 0149d6a29d7a..68c3f10a8ceb 100644 --- a/src/Controls/src/Core/Shell/ShellContent.cs +++ b/src/Controls/src/Core/Shell/ShellContent.cs @@ -9,7 +9,9 @@ namespace Microsoft.Maui.Controls { - /// + /// + /// Represents the content displayed within a tab. + /// [ContentProperty(nameof(Content))] [TypeConverter(typeof(ShellContentConverter))] public class ShellContent : BaseShellItem, IShellContentController, IVisualTreeElement @@ -32,17 +34,23 @@ public class ShellContent : BaseShellItem, IShellContentController, IVisualTreeE internal static readonly BindableProperty QueryAttributesProperty = BindableProperty.CreateAttached("QueryAttributes", typeof(ShellRouteParameters), typeof(ShellContent), defaultValue: null, propertyChanged: OnQueryAttributesPropertyChanged); - /// + /// + /// Gets the collection of menu items associated with this content. This is a bindable property. + /// public MenuItemCollection MenuItems => (MenuItemCollection)GetValue(MenuItemsProperty); - /// + /// + /// Gets or sets the page content to display. This is a bindable property. + /// public object Content { get => GetValue(ContentProperty); set => SetValue(ContentProperty, value); } - /// + /// + /// Gets or sets a template used to create the content page. This is a bindable property. + /// public DataTemplate ContentTemplate { get => (DataTemplate)GetValue(ContentTemplateProperty); @@ -116,7 +124,9 @@ void IShellContentController.RecyclePage(Page page) Page _contentCache; - /// + /// + /// Initializes a new instance of the class. + /// public ShellContent() { ((INotifyCollectionChanged)MenuItems).CollectionChanged += MenuItemsCollectionChanged; diff --git a/src/Controls/src/Core/Shell/ShellGroupItem.cs b/src/Controls/src/Core/Shell/ShellGroupItem.cs index 5b216002fb72..e4a8ef7b60ff 100644 --- a/src/Controls/src/Core/Shell/ShellGroupItem.cs +++ b/src/Controls/src/Core/Shell/ShellGroupItem.cs @@ -3,7 +3,9 @@ namespace Microsoft.Maui.Controls { - /// + /// + /// Base class for grouping Shell items such as and . + /// public class ShellGroupItem : BaseShellItem { /// Bindable property for . @@ -15,7 +17,9 @@ static void OnFlyoutDisplayOptionsPropertyChanged(BindableObject bindable, objec ((Element)bindable).FindParentOfType()?.SendFlyoutItemsChanged(); } - /// + /// + /// Gets or sets how this item is displayed in the flyout. This is a bindable property. + /// public FlyoutDisplayOptions FlyoutDisplayOptions { get { return (FlyoutDisplayOptions)GetValue(FlyoutDisplayOptionsProperty); } diff --git a/src/Controls/src/Core/Shell/ShellItem.cs b/src/Controls/src/Core/Shell/ShellItem.cs index 27618634b027..f78b8d535c26 100644 --- a/src/Controls/src/Core/Shell/ShellItem.cs +++ b/src/Controls/src/Core/Shell/ShellItem.cs @@ -12,43 +12,53 @@ namespace Microsoft.Maui.Controls { - /// + /// + /// Represents a flyout menu item in a application. + /// [EditorBrowsable(EditorBrowsableState.Always)] public class FlyoutItem : ShellItem { - /// + /// The style class for flyout item labels. public const string LabelStyle = "FlyoutItemLabelStyle"; - /// + /// The style class for flyout item images. public const string ImageStyle = "FlyoutItemImageStyle"; - /// + /// The style class for flyout item layouts. public const string LayoutStyle = "FlyoutItemLayoutStyle"; - /// + /// Initializes a new instance of the class. public FlyoutItem() { } - /// + /// Bindable property for attached property IsVisible. This is a bindable property. public static readonly new BindableProperty IsVisibleProperty = BaseShellItem.IsVisibleProperty; - /// + /// Gets the value of the attached IsVisible property for the specified . + /// The object from which to read the property value. + /// if the object is visible; otherwise, . public static bool GetIsVisible(BindableObject obj) => (bool)obj.GetValue(IsVisibleProperty); - /// + /// Sets the value of the attached IsVisible property on the specified . + /// The object on which to set the property value. + /// The visibility value to set. public static void SetIsVisible(BindableObject obj, bool isVisible) => obj.SetValue(IsVisibleProperty, isVisible); } - /// + /// + /// Represents the bottom tab bar in a application. + /// [EditorBrowsable(EditorBrowsableState.Always)] public class TabBar : ShellItem { - /// + /// Initializes a new instance of the class. public TabBar() { } } - /// + /// + /// Represents a top-level navigation item in a . Contains one or more items. + /// [ContentProperty(nameof(Items))] [EditorBrowsable(EditorBrowsableState.Never)] [TypeConverter(typeof(ShellItemConverter))] @@ -150,7 +160,7 @@ void IPropertyPropagationController.PropagatePropertyChanged(string propertyName public static readonly BindableProperty ItemsProperty = ItemsPropertyKey.BindableProperty; Lazy> _platformConfigurationRegistry; - /// + /// Initializes a new instance of the class. public ShellItem() { ((ShellElementCollection)Items).VisibleItemsChangedInternal += (_, args) => @@ -179,14 +189,14 @@ public ShellItem() _platformConfigurationRegistry = new Lazy>(() => new PlatformConfigurationRegistry(this)); } - /// + /// Gets or sets the currently selected . This is a bindable property. public ShellSection CurrentItem { get { return (ShellSection)GetValue(CurrentItemProperty); } set { SetValue(CurrentItemProperty, value); } } - /// + /// Gets the collection of items. This is a bindable property. public IList Items => (IList)GetValue(ItemsProperty); internal override ShellElementCollection ShellElementCollection => (ShellElementCollection)Items; diff --git a/src/Controls/src/Core/Shell/ShellNavigatedEventArgs.cs b/src/Controls/src/Core/Shell/ShellNavigatedEventArgs.cs index dda1d6036f3b..c0bc8d3c46a2 100644 --- a/src/Controls/src/Core/Shell/ShellNavigatedEventArgs.cs +++ b/src/Controls/src/Core/Shell/ShellNavigatedEventArgs.cs @@ -3,10 +3,13 @@ namespace Microsoft.Maui.Controls { - /// + /// Provides data for the event. public class ShellNavigatedEventArgs : EventArgs { - /// + /// Initializes a new instance of . + /// The navigation state before the navigation occurred. + /// The navigation state after the navigation occurred. + /// The source of the navigation event. public ShellNavigatedEventArgs(ShellNavigationState previous, ShellNavigationState current, ShellNavigationSource source) { Previous = previous; @@ -14,11 +17,13 @@ public ShellNavigatedEventArgs(ShellNavigationState previous, ShellNavigationSta Source = source; } - /// + /// Gets the navigation state after the navigation occurred. public ShellNavigationState Current { get; } - /// + + /// Gets the navigation state before the navigation occurred. public ShellNavigationState Previous { get; } - /// + + /// Gets the source of the navigation event. public ShellNavigationSource Source { get; } } } \ No newline at end of file diff --git a/src/Controls/src/Core/Shell/ShellNavigatingDeferral.cs b/src/Controls/src/Core/Shell/ShellNavigatingDeferral.cs index 69845176ccb1..3088474749da 100644 --- a/src/Controls/src/Core/Shell/ShellNavigatingDeferral.cs +++ b/src/Controls/src/Core/Shell/ShellNavigatingDeferral.cs @@ -5,7 +5,9 @@ namespace Microsoft.Maui.Controls { - /// + /// + /// Allows async operations to complete before Shell navigation finishes. + /// public class ShellNavigatingDeferral { Action _completed; @@ -15,7 +17,9 @@ internal ShellNavigatingDeferral(Action completed) _completed = completed; } - /// + /// + /// Signals that the deferred navigation can proceed. + /// public void Complete() { var taskToComplete = Interlocked.Exchange(ref _completed, null); diff --git a/src/Controls/src/Core/Shell/ShellNavigatingEventArgs.cs b/src/Controls/src/Core/Shell/ShellNavigatingEventArgs.cs index efd84fb24157..527a7ac522e4 100644 --- a/src/Controls/src/Core/Shell/ShellNavigatingEventArgs.cs +++ b/src/Controls/src/Core/Shell/ShellNavigatingEventArgs.cs @@ -6,7 +6,9 @@ namespace Microsoft.Maui.Controls { - /// + /// + /// Provides data for the event. + /// public class ShellNavigatingEventArgs : EventArgs { int _deferralCount; @@ -14,7 +16,13 @@ public class ShellNavigatingEventArgs : EventArgs TaskCompletionSource _deferredTaskCompletionSource; bool _deferralCompleted = false; - /// + /// + /// Initializes a new instance of the class. + /// + /// The current navigation state. + /// The target navigation state. + /// The source of the navigation. + /// Whether the navigation can be cancelled. public ShellNavigatingEventArgs(ShellNavigationState current, ShellNavigationState target, ShellNavigationSource source, bool canCancel) { @@ -26,19 +34,30 @@ public ShellNavigatingEventArgs(ShellNavigationState current, ShellNavigationSta Animate = true; } - /// + /// + /// Gets the current navigation state. + /// public ShellNavigationState Current { get; } - /// + /// + /// Gets the target navigation state. + /// public ShellNavigationState Target { get; } - /// + /// + /// Gets the source of the navigation. + /// public ShellNavigationSource Source { get; } - /// + /// + /// Gets a value indicating whether the navigation can be cancelled. + /// public bool CanCancel { get; } - /// + /// + /// Cancels the navigation if is . + /// + /// if the navigation was cancelled; otherwise, . public bool Cancel() { if (!CanCancel) @@ -48,10 +67,15 @@ public bool Cancel() return true; } - /// + /// + /// Gets a value indicating whether the navigation has been cancelled. + /// public bool Cancelled { get; private set; } - /// + /// + /// Gets a deferral to delay navigation until the deferral is completed. + /// + /// A object, or if is . public ShellNavigatingDeferral GetDeferral() { if (_deferralCompleted) diff --git a/src/Controls/src/Core/Shell/ShellNavigationSource.cs b/src/Controls/src/Core/Shell/ShellNavigationSource.cs index beb57b77a8bb..d3d379994467 100644 --- a/src/Controls/src/Core/Shell/ShellNavigationSource.cs +++ b/src/Controls/src/Core/Shell/ShellNavigationSource.cs @@ -1,27 +1,25 @@ -using System; - namespace Microsoft.Maui.Controls { - /// + /// Indicates how Shell navigation was initiated. public enum ShellNavigationSource { - /// + /// The navigation source is unknown. Unknown = 0, - /// + /// Navigation was initiated by pushing a page onto the stack. Push, - /// + /// Navigation was initiated by popping a page from the stack. Pop, - /// + /// Navigation was initiated by popping to the root page. PopToRoot, - /// + /// Navigation was initiated by inserting a page into the stack. Insert, - /// + /// Navigation was initiated by removing a page from the stack. Remove, - /// + /// Navigation was initiated by changing the active . ShellItemChanged, - /// + /// Navigation was initiated by changing the active . ShellSectionChanged, - /// + /// Navigation was initiated by changing the active . ShellContentChanged, } } \ No newline at end of file diff --git a/src/Controls/src/Core/Shell/ShellNavigationState.cs b/src/Controls/src/Core/Shell/ShellNavigationState.cs index 8cbd6506c1aa..c737eb9961fa 100644 --- a/src/Controls/src/Core/Shell/ShellNavigationState.cs +++ b/src/Controls/src/Core/Shell/ShellNavigationState.cs @@ -7,7 +7,9 @@ namespace Microsoft.Maui.Controls { - /// + /// + /// Represents the current navigation state of a , expressed as a URI. + /// [DebuggerDisplay("Location = {Location}")] [TypeConverter(typeof(ShellNavigationStateTypeConverter))] public class ShellNavigationState @@ -23,16 +25,23 @@ internal Uri FullLocation } } - /// + /// + /// Gets the URI representing the current navigation location in the Shell. + /// public Uri Location { get; private set; } - /// + /// + /// Initializes a new instance of the class. + /// public ShellNavigationState() { } - /// + /// + /// Initializes a new instance of the class with the specified location string. + /// + /// A string representing the navigation location URI. public ShellNavigationState(string location) : this(location, true) { } @@ -52,7 +61,10 @@ internal ShellNavigationState(string location, bool trimForUser) Location = FullLocation; } - /// + /// + /// Initializes a new instance of the class with the specified URI. + /// + /// A representing the navigation location. public ShellNavigationState(Uri location) { FullLocation = location; diff --git a/src/Controls/src/Core/Shell/ShellSection.cs b/src/Controls/src/Core/Shell/ShellSection.cs index 4fdd786025f2..2434e957bee2 100644 --- a/src/Controls/src/Core/Shell/ShellSection.cs +++ b/src/Controls/src/Core/Shell/ShellSection.cs @@ -13,13 +13,17 @@ namespace Microsoft.Maui.Controls { - /// + /// + /// Represents a group of items within a . This is an alias for . + /// [EditorBrowsable(EditorBrowsableState.Always)] public class Tab : ShellSection { } - /// + /// + /// Represents a group of tabs within a . Contains items. + /// [ContentProperty(nameof(Items))] [EditorBrowsable(EditorBrowsableState.Never)] [TypeConverter(typeof(ShellSectionTypeConverter))] @@ -214,7 +218,9 @@ void IPropertyPropagationController.PropagatePropertyChanged(string propertyName internal bool IsPushingModalStack { get; private set; } internal bool IsPoppingModalStack { get; private set; } - /// + /// + /// Creates a new instance. + /// public ShellSection() { ((ShellElementCollection)Items).VisibleItemsChangedInternal += (_, args) => @@ -241,18 +247,24 @@ public ShellSection() Navigation = new NavigationImpl(this); } - /// + /// + /// Gets or sets the currently selected . This is a bindable property. + /// public ShellContent CurrentItem { get { return (ShellContent)GetValue(CurrentItemProperty); } set { SetValue(CurrentItemProperty, value); } } - /// + /// + /// Gets the collection of items in this section. This is a bindable property. + /// public IList Items => (IList)GetValue(ItemsProperty); internal override ShellElementCollection ShellElementCollection => (ShellElementCollection)Items; - /// + /// + /// Gets the current navigation stack of pages in this section. + /// public IReadOnlyList Stack => _navStack; internal Page DisplayedPage