Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Update All (most) BindableProperty XML docs (Backport #14704) #15208

Merged
merged 1 commit into from
May 23, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/Controls/Foldable/src/SpanModeStateTrigger.cs
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ public TwoPaneViewMode SpanMode
set => SetValue(SpanModeProperty, value);
}

/// <summary>Bindable property for <see cref="SpanMode"/>.</summary>
public static readonly BindableProperty SpanModeProperty =
BindableProperty.Create(nameof(SpanMode), typeof(TwoPaneViewMode), typeof(SpanModeStateTrigger), default(TwoPaneViewMode),
propertyChanged: OnSpanModeChanged);
Expand Down
10 changes: 10 additions & 0 deletions src/Controls/Foldable/src/TwoPaneView.cs
Original file line number Diff line number Diff line change
Expand Up @@ -47,35 +47,45 @@ enum ViewMode
double _previousWidth = -1;
double _previousHeight = -1;

/// <summary>Bindable property for <see cref="TallModeConfiguration"/>.</summary>
public static readonly BindableProperty TallModeConfigurationProperty
= BindableProperty.Create("TallModeConfiguration", typeof(TwoPaneViewTallModeConfiguration), typeof(TwoPaneView), defaultValue: TwoPaneViewTallModeConfiguration.TopBottom, propertyChanged: TwoPaneViewLayoutPropertyChanged);

/// <summary>Bindable property for <see cref="WideModeConfiguration"/>.</summary>
public static readonly BindableProperty WideModeConfigurationProperty
= BindableProperty.Create("WideModeConfiguration", typeof(TwoPaneViewWideModeConfiguration), typeof(TwoPaneView), defaultValue: TwoPaneViewWideModeConfiguration.LeftRight, propertyChanged: TwoPaneViewLayoutPropertyChanged);

/// <summary>Bindable property for <see cref="Pane1"/>.</summary>
public static readonly BindableProperty Pane1Property
= BindableProperty.Create("Pane1", typeof(View), typeof(TwoPaneView), propertyChanged: (b, o, n) => OnPanePropertyChanged(b, o, n, 0));

/// <summary>Bindable property for <see cref="Pane2"/>.</summary>
public static readonly BindableProperty Pane2Property
= BindableProperty.Create("Pane2", typeof(View), typeof(TwoPaneView), propertyChanged: (b, o, n) => OnPanePropertyChanged(b, o, n, 1));

static readonly BindablePropertyKey ModePropertyKey
= BindableProperty.CreateReadOnly("Mode", typeof(TwoPaneViewMode), typeof(TwoPaneView), defaultValue: TwoPaneViewMode.SinglePane, propertyChanged: OnModePropertyChanged);

/// <summary>Bindable property for <see cref="Mode"/>.</summary>
public static readonly BindableProperty ModeProperty = ModePropertyKey.BindableProperty;

/// <summary>Bindable property for <see cref="PanePriority"/>.</summary>
public static readonly BindableProperty PanePriorityProperty
= BindableProperty.Create("PanePriority", typeof(TwoPaneViewPriority), typeof(TwoPaneView), defaultValue: TwoPaneViewPriority.Pane1, propertyChanged: TwoPaneViewLayoutPropertyChanged);

/// <summary>Bindable property for <see cref="MinTallModeHeight"/>.</summary>
public static readonly BindableProperty MinTallModeHeightProperty
= BindableProperty.Create("MinTallModeHeight", typeof(double), typeof(TwoPaneView), defaultValueCreator: OnMinModePropertyCreate, propertyChanged: TwoPaneViewLayoutPropertyChanged);

/// <summary>Bindable property for <see cref="MinWideModeWidth"/>.</summary>
public static readonly BindableProperty MinWideModeWidthProperty
= BindableProperty.Create("MinWideModeWidth", typeof(double), typeof(TwoPaneView), defaultValueCreator: OnMinModePropertyCreate, propertyChanged: TwoPaneViewLayoutPropertyChanged);

/// <summary>Bindable property for <see cref="Pane1Length"/>.</summary>
public static readonly BindableProperty Pane1LengthProperty
= BindableProperty.Create("Pane1Length", typeof(GridLength), typeof(TwoPaneView), defaultValue: GridLength.Star, propertyChanged: TwoPaneViewLayoutPropertyChanged);

/// <summary>Bindable property for <see cref="Pane2Length"/>.</summary>
public static readonly BindableProperty Pane2LengthProperty
= BindableProperty.Create("Pane2Length", typeof(GridLength), typeof(TwoPaneView), defaultValue: GridLength.Star, propertyChanged: TwoPaneViewLayoutPropertyChanged);

Expand Down
1 change: 1 addition & 0 deletions src/Controls/Foldable/src/WindowSpanModeStateTrigger.cs
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ public TwoPaneViewMode SpanMode
set => SetValue(SpanModeProperty, value);
}

/// <summary>Bindable property for <see cref="SpanMode"/>.</summary>
public static readonly BindableProperty SpanModeProperty =
BindableProperty.Create(nameof(SpanMode), typeof(TwoPaneViewMode), typeof(WindowSpanModeStateTrigger), default(TwoPaneViewMode),
propertyChanged: OnSpanModeChanged);
Expand Down
5 changes: 4 additions & 1 deletion src/Controls/Maps/src/Circle.cs
Original file line number Diff line number Diff line change
@@ -1,23 +1,26 @@
using Microsoft.Maui.Devices.Sensors;
using Microsoft.Maui.Devices.Sensors;
using Microsoft.Maui.Graphics;
using Microsoft.Maui.Maps;

namespace Microsoft.Maui.Controls.Maps
{
public partial class Circle : MapElement
{
/// <summary>Bindable property for <see cref="Center"/>.</summary>
public static readonly BindableProperty CenterProperty = BindableProperty.Create(
nameof(Center),
typeof(Location),
typeof(Circle),
default(Location));

/// <summary>Bindable property for <see cref="Radius"/>.</summary>
public static readonly BindableProperty RadiusProperty = BindableProperty.Create(
nameof(Radius),
typeof(Distance),
typeof(Circle),
default(Distance));

/// <summary>Bindable property for <see cref="FillColor"/>.</summary>
public static readonly BindableProperty FillColorProperty = BindableProperty.Create(
nameof(FillColor),
typeof(Color),
Expand Down
8 changes: 8 additions & 0 deletions src/Controls/Maps/src/Map.cs
Original file line number Diff line number Diff line change
Expand Up @@ -12,22 +12,30 @@ namespace Microsoft.Maui.Controls.Maps
{
public partial class Map : View
{
/// <summary>Bindable property for <see cref="MapType"/>.</summary>
public static readonly BindableProperty MapTypeProperty = BindableProperty.Create(nameof(MapType), typeof(MapType), typeof(Map), default(MapType));

/// <summary>Bindable property for <see cref="IsShowingUser"/>.</summary>
public static readonly BindableProperty IsShowingUserProperty = BindableProperty.Create(nameof(IsShowingUser), typeof(bool), typeof(Map), default(bool));

/// <summary>Bindable property for <see cref="IsTrafficEnabled"/>.</summary>
public static readonly BindableProperty IsTrafficEnabledProperty = BindableProperty.Create(nameof(IsTrafficEnabled), typeof(bool), typeof(Map), default(bool));

/// <summary>Bindable property for <see cref="IsScrollEnabled"/>.</summary>
public static readonly BindableProperty IsScrollEnabledProperty = BindableProperty.Create(nameof(IsScrollEnabled), typeof(bool), typeof(Map), true);

/// <summary>Bindable property for <see cref="IsZoomEnabled"/>.</summary>
public static readonly BindableProperty IsZoomEnabledProperty = BindableProperty.Create(nameof(IsZoomEnabled), typeof(bool), typeof(Map), true);

/// <summary>Bindable property for <see cref="ItemsSource"/>.</summary>
public static readonly BindableProperty ItemsSourceProperty = BindableProperty.Create(nameof(ItemsSource), typeof(IEnumerable), typeof(Map), default(IEnumerable),
propertyChanged: (b, o, n) => ((Map)b).OnItemsSourcePropertyChanged((IEnumerable)o, (IEnumerable)n));

/// <summary>Bindable property for <see cref="ItemTemplate"/>.</summary>
public static readonly BindableProperty ItemTemplateProperty = BindableProperty.Create(nameof(ItemTemplate), typeof(DataTemplate), typeof(Map), default(DataTemplate),
propertyChanged: (b, o, n) => ((Map)b).OnItemTemplatePropertyChanged((DataTemplate)o, (DataTemplate)n));

/// <summary>Bindable property for <see cref="ItemTemplateSelector"/>.</summary>
public static readonly BindableProperty ItemTemplateSelectorProperty = BindableProperty.Create(nameof(ItemTemplateSelector), typeof(DataTemplateSelector), typeof(Map), default(DataTemplateSelector),
propertyChanged: (b, o, n) => ((Map)b).OnItemTemplateSelectorPropertyChanged());

Expand Down
4 changes: 3 additions & 1 deletion src/Controls/Maps/src/MapElement.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
using System;
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Text;
Expand All @@ -9,12 +9,14 @@ namespace Microsoft.Maui.Controls.Maps
{
public partial class MapElement : Element
{
/// <summary>Bindable property for <see cref="StrokeColor"/>.</summary>
public static readonly BindableProperty StrokeColorProperty = BindableProperty.Create(
nameof(StrokeColor),
typeof(Color),
typeof(MapElement),
null);

/// <summary>Bindable property for <see cref="StrokeWidth"/>.</summary>
public static readonly BindableProperty StrokeWidthProperty = BindableProperty.Create(
nameof(StrokeWidth),
typeof(float),
Expand Down
4 changes: 4 additions & 0 deletions src/Controls/Maps/src/Pin.cs
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,16 @@ namespace Microsoft.Maui.Controls.Maps
{
public partial class Pin : Element
{
/// <summary>Bindable property for <see cref="Type"/>.</summary>
public static readonly BindableProperty TypeProperty = BindableProperty.Create(nameof(Type), typeof(PinType), typeof(Pin), default(PinType));

/// <summary>Bindable property for <see cref="Location"/>.</summary>
public static readonly BindableProperty LocationProperty = BindableProperty.Create(nameof(Location), typeof(Location), typeof(Pin), default(Location));

/// <summary>Bindable property for <see cref="Address"/>.</summary>
public static readonly BindableProperty AddressProperty = BindableProperty.Create(nameof(Address), typeof(string), typeof(Pin), default(string));

/// <summary>Bindable property for <see cref="Label"/>.</summary>
public static readonly BindableProperty LabelProperty = BindableProperty.Create(nameof(Label), typeof(string), typeof(Pin), default(string));
private object? _markerId;

Expand Down
1 change: 1 addition & 0 deletions src/Controls/Maps/src/Polygon.cs
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ namespace Microsoft.Maui.Controls.Maps
{
public partial class Polygon : MapElement
{
/// <summary>Bindable property for <see cref="FillColor"/>.</summary>
public static readonly BindableProperty FillColorProperty = BindableProperty.Create(
nameof(FillColor),
typeof(Color),
Expand Down
4 changes: 2 additions & 2 deletions src/Controls/src/Core/ActivityIndicator.cs
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ namespace Microsoft.Maui.Controls
/// <include file="../../docs/Microsoft.Maui.Controls/ActivityIndicator.xml" path="Type[@FullName='Microsoft.Maui.Controls.ActivityIndicator']/Docs/*" />
public partial class ActivityIndicator : View, IColorElement, IElementConfiguration<ActivityIndicator>
{
/// <include file="../../docs/Microsoft.Maui.Controls/ActivityIndicator.xml" path="//Member[@MemberName='IsRunningProperty']/Docs/*" />
/// <summary>Bindable property for <see cref="IsRunning"/>.</summary>
public static readonly BindableProperty IsRunningProperty = BindableProperty.Create("IsRunning", typeof(bool), typeof(ActivityIndicator), default(bool));

/// <include file="../../docs/Microsoft.Maui.Controls/ActivityIndicator.xml" path="//Member[@MemberName='ColorProperty']/Docs/*" />
/// <summary>Bindable property for <see cref="Color"/>.</summary>
public static readonly BindableProperty ColorProperty = ColorElement.ColorProperty;

readonly Lazy<PlatformConfigurationRegistry<ActivityIndicator>> _platformConfigurationRegistry;
Expand Down
4 changes: 2 additions & 2 deletions src/Controls/src/Core/AdaptiveTrigger.cs
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ public double MinWindowHeight
set => SetValue(MinWindowHeightProperty, value);
}

/// <include file="../../docs/Microsoft.Maui.Controls/AdaptiveTrigger.xml" path="//Member[@MemberName='MinWindowHeightProperty']/Docs/*" />
/// <summary>Bindable property for <see cref="MinWindowHeight"/>.</summary>
public static readonly BindableProperty MinWindowHeightProperty =
BindableProperty.Create(nameof(MinWindowHeight), typeof(double), typeof(AdaptiveTrigger), -1d,
propertyChanged: OnMinWindowDimensionChanged);
Expand All @@ -35,7 +35,7 @@ public double MinWindowWidth
set => SetValue(MinWindowWidthProperty, value);
}

/// <include file="../../docs/Microsoft.Maui.Controls/AdaptiveTrigger.xml" path="//Member[@MemberName='MinWindowWidthProperty']/Docs/*" />
/// <summary>Bindable property for <see cref="MinWindowWidth"/>.</summary>
public static readonly BindableProperty MinWindowWidthProperty =
BindableProperty.Create(nameof(MinWindowWidth), typeof(double), typeof(AdaptiveTrigger), -1d,
propertyChanged: OnMinWindowDimensionChanged);
Expand Down
10 changes: 5 additions & 5 deletions src/Controls/src/Core/AppLinkEntry.cs
Original file line number Diff line number Diff line change
Expand Up @@ -14,19 +14,19 @@ public AppLinkEntry()
keyValues = new Dictionary<string, string>();
}

/// <include file="../../docs/Microsoft.Maui.Controls/AppLinkEntry.xml" path="//Member[@MemberName='TitleProperty']/Docs/*" />
/// <summary>Bindable property for <see cref="Title"/>.</summary>
public static readonly BindableProperty TitleProperty = BindableProperty.Create(nameof(Title), typeof(string), typeof(AppLinkEntry), default(string));

/// <include file="../../docs/Microsoft.Maui.Controls/AppLinkEntry.xml" path="//Member[@MemberName='DescriptionProperty']/Docs/*" />
/// <summary>Bindable property for <see cref="Description"/>.</summary>
public static readonly BindableProperty DescriptionProperty = BindableProperty.Create(nameof(Description), typeof(string), typeof(AppLinkEntry), default(string));

/// <include file="../../docs/Microsoft.Maui.Controls/AppLinkEntry.xml" path="//Member[@MemberName='ThumbnailProperty']/Docs/*" />
/// <summary>Bindable property for <see cref="Thumbnail"/>.</summary>
public static readonly BindableProperty ThumbnailProperty = BindableProperty.Create(nameof(Thumbnail), typeof(ImageSource), typeof(AppLinkEntry), default(ImageSource));

/// <include file="../../docs/Microsoft.Maui.Controls/AppLinkEntry.xml" path="//Member[@MemberName='AppLinkUriProperty']/Docs/*" />
/// <summary>Bindable property for <see cref="AppLinkUri"/>.</summary>
public static readonly BindableProperty AppLinkUriProperty = BindableProperty.Create(nameof(AppLinkUri), typeof(Uri), typeof(AppLinkEntry), null);

/// <include file="../../docs/Microsoft.Maui.Controls/AppLinkEntry.xml" path="//Member[@MemberName='IsLinkActiveProperty']/Docs/*" />
/// <summary>Bindable property for <see cref="IsLinkActive"/>.</summary>
public static readonly BindableProperty IsLinkActiveProperty = BindableProperty.Create(nameof(IsLinkActive), typeof(bool), typeof(AppLinkEntry), false);

/// <include file="../../docs/Microsoft.Maui.Controls/AppLinkEntry.xml" path="//Member[@MemberName='AppLinkUri']/Docs/*" />
Expand Down
9 changes: 5 additions & 4 deletions src/Controls/src/Core/AutomationProperties.cs
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,19 @@ namespace Microsoft.Maui.Controls
/// <include file="../../docs/Microsoft.Maui.Controls/AutomationProperties.xml" path="Type[@FullName='Microsoft.Maui.Controls.AutomationProperties']/Docs/*" />
public class AutomationProperties
{
/// <include file="../../docs/Microsoft.Maui.Controls/AutomationProperties.xml" path="//Member[@MemberName='HelpTextProperty']/Docs/*" />
/// <summary>Bindable property for <c>HelpText</c>.</summary>
public static readonly BindableProperty HelpTextProperty = BindableProperty.Create("HelpText", typeof(string), typeof(AutomationProperties), default(string));

/// <include file="../../docs/Microsoft.Maui.Controls/AutomationProperties.xml" path="//Member[@MemberName='IsInAccessibleTreeProperty']/Docs/*" />
/// <summary>Bindable property for <c>IsInAccessibleTree</c>.</summary>
public static readonly BindableProperty IsInAccessibleTreeProperty = BindableProperty.Create("IsInAccessibleTree", typeof(bool?), typeof(AutomationProperties), null);

/// <summary>Bindable property for <c>ExcludedWithChildren</c>.</summary>
public static readonly BindableProperty ExcludedWithChildrenProperty = BindableProperty.Create("ExcludedWithChildren", typeof(bool?), typeof(AutomationProperties), null);

/// <include file="../../docs/Microsoft.Maui.Controls/AutomationProperties.xml" path="//Member[@MemberName='LabeledByProperty']/Docs/*" />
/// <summary>Bindable property for <c>LabeledBy</c>.</summary>
public static readonly BindableProperty LabeledByProperty = BindableProperty.Create("LabeledBy", typeof(VisualElement), typeof(AutomationProperties), default(VisualElement));

/// <include file="../../docs/Microsoft.Maui.Controls/AutomationProperties.xml" path="//Member[@MemberName='NameProperty']/Docs/*" />
/// <summary>Bindable property for <c>Name</c>.</summary>
public static readonly BindableProperty NameProperty = BindableProperty.Create("Name", typeof(string), typeof(AutomationProperties), default(string));

/// <include file="../../docs/Microsoft.Maui.Controls/AutomationProperties.xml" path="//Member[@MemberName='GetHelpText']/Docs/*" />
Expand Down
3 changes: 3 additions & 0 deletions src/Controls/src/Core/BarElement.cs
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,15 @@ namespace Microsoft.Maui.Controls
{
static class BarElement
{
/// <summary>Bindable property for <see cref="IBarElement.BarBackgroundColor"/>.</summary>
public static readonly BindableProperty BarBackgroundColorProperty =
BindableProperty.Create(nameof(IBarElement.BarBackgroundColor), typeof(Color), typeof(IBarElement), default(Color));

/// <summary>Bindable property for <see cref="IBarElement.BarBackground"/>.</summary>
public static readonly BindableProperty BarBackgroundProperty =
BindableProperty.Create(nameof(IBarElement.BarBackground), typeof(Brush), typeof(IBarElement), default(Brush));

/// <summary>Bindable property for <see cref="IBarElement.BarTextColor"/>.</summary>
public static readonly BindableProperty BarTextColorProperty =
BindableProperty.Create(nameof(IBarElement.BarTextColor), typeof(Color), typeof(IBarElement), default(Color));
}
Expand Down
10 changes: 5 additions & 5 deletions src/Controls/src/Core/BindableLayout.cs
Original file line number Diff line number Diff line change
Expand Up @@ -17,17 +17,17 @@ public interface IBindableLayout
/// <include file="../../docs/Microsoft.Maui.Controls/BindableLayout.xml" path="Type[@FullName='Microsoft.Maui.Controls.BindableLayout']/Docs/*" />
public static class BindableLayout
{
/// <include file="../../docs/Microsoft.Maui.Controls/BindableLayout.xml" path="//Member[@MemberName='ItemsSourceProperty']/Docs/*" />
/// <summary>Bindable property for attached property <c>ItemsSource</c>.</summary>
public static readonly BindableProperty ItemsSourceProperty =
BindableProperty.CreateAttached("ItemsSource", typeof(IEnumerable), typeof(IBindableLayout), default(IEnumerable),
propertyChanged: (b, o, n) => { GetBindableLayoutController(b).ItemsSource = (IEnumerable)n; });

/// <include file="../../docs/Microsoft.Maui.Controls/BindableLayout.xml" path="//Member[@MemberName='ItemTemplateProperty']/Docs/*" />
/// <summary>Bindable property for attached property <c>ItemTemplate</c>.</summary>
public static readonly BindableProperty ItemTemplateProperty =
BindableProperty.CreateAttached("ItemTemplate", typeof(DataTemplate), typeof(IBindableLayout), default(DataTemplate),
propertyChanged: (b, o, n) => { GetBindableLayoutController(b).ItemTemplate = (DataTemplate)n; });

/// <include file="../../docs/Microsoft.Maui.Controls/BindableLayout.xml" path="//Member[@MemberName='ItemTemplateSelectorProperty']/Docs/*" />
/// <summary>Bindable property for attached property <c>ItemTemplateSelector</c>.</summary>
public static readonly BindableProperty ItemTemplateSelectorProperty =
BindableProperty.CreateAttached("ItemTemplateSelector", typeof(DataTemplateSelector), typeof(IBindableLayout), default(DataTemplateSelector),
propertyChanged: (b, o, n) => { GetBindableLayoutController(b).ItemTemplateSelector = (DataTemplateSelector)n; });
Expand All @@ -37,11 +37,11 @@ public static class BindableLayout
defaultValueCreator: (b) => new BindableLayoutController((IBindableLayout)b),
propertyChanged: (b, o, n) => OnControllerChanged(b, (BindableLayoutController)o, (BindableLayoutController)n));

/// <include file="../../docs/Microsoft.Maui.Controls/BindableLayout.xml" path="//Member[@MemberName='EmptyViewProperty']/Docs/*" />
/// <summary>Bindable property for attached property <c>EmptyView</c>.</summary>
public static readonly BindableProperty EmptyViewProperty =
BindableProperty.Create("EmptyView", typeof(object), typeof(IBindableLayout), null, propertyChanged: (b, o, n) => { GetBindableLayoutController(b).EmptyView = n; });

/// <include file="../../docs/Microsoft.Maui.Controls/BindableLayout.xml" path="//Member[@MemberName='EmptyViewTemplateProperty']/Docs/*" />
/// <summary>Bindable property for attached property <c>EmptyViewTemplate</c>.</summary>
public static readonly BindableProperty EmptyViewTemplateProperty =
BindableProperty.Create("EmptyViewTemplate", typeof(DataTemplate), typeof(IBindableLayout), null, propertyChanged: (b, o, n) => { GetBindableLayoutController(b).EmptyViewTemplate = (DataTemplate)n; });

Expand Down
Loading