From f9c1989d0102866b6737a5924991490683d5f08b Mon Sep 17 00:00:00 2001 From: Mike Norman Date: Thu, 1 Jun 2017 12:21:50 -0500 Subject: Updated example code in API docs for first few types in core. (#955) * Updated example code in API docs for first few types in core, alphabetically. --- .../Xamarin.Forms/AbsoluteLayout.xml | 210 +++++++++------------ .../Xamarin.Forms/AppLinkEntry.xml | 6 +- .../Xamarin.Forms/Application.xml | 4 +- docs/Xamarin.Forms.Core/Xamarin.Forms/Behavior.xml | 1 + .../Xamarin.Forms/Behavior`1.xml | 1 + .../Xamarin.Forms/BindableProperty.xml | 64 +++---- 6 files changed, 125 insertions(+), 161 deletions(-) (limited to 'docs/Xamarin.Forms.Core') diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/AbsoluteLayout.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/AbsoluteLayout.xml index cbe63a58..28e09a8e 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms/AbsoluteLayout.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/AbsoluteLayout.xml @@ -25,153 +25,113 @@ The following example shows how to use an with proportional position arguments. + simpleLayout.Children.Add(topLeftLabel); + simpleLayout.Children.Add(centerLabel); + simpleLayout.Children.Add(bottomRightLabel); + ]]> The code sample below shows how to place two labels by specifying device-dependent units. + }]]> The following image shows the AbsoluteLayout demo from the FormsGallery sample. - + @@ -198,15 +158,15 @@ namespace AbsoluteLayoutDemo Application developers can use XAML to lay out elements with the class. The example below places a blue inside an : - - -]]> + HorizontalOptions="FillAndExpand"> + + + ]]> The class can lay its child elements out in proportional units, device units, or a combination of both. Application developers should remember the following points when specifying a structure that will define the layout bounds of a child element: - For elements whose height and width fit on the screen, proportional position dimensions in the range [0,1] represent elements that are completely on the screen, regardless of whether the height, width, or both are specified in device or proportional units.The above point means that, to specify an element in the lower right hand corner of the screen and that is half as wide and half as all as the screen, with a value of All, the application developer would specify "1.0, 1.0, 0.5, 0.5".The app developer can inadvertently cause child elements for which one or both size dimensions were specified proportionally to be displayed partially off the screen, or hidden altogether, by specifying device-unit positions that do not leave enough room for the calculated size of the child.Each part of the bounding structure is interpreted according to the value that controls it. A given rectangle might, for example, have an X-coordinate that is in device units, a Y-coordinate that is in proportional units, a height that is in proportional units, and a width that is in device units, or any other combination of device and proportional units. Rectangles that, when interpreted by using the current set on the child, represent bounding boxes that are partially or wholly off-screen—for example, by having a width that is larger than the screen width—may give unexpected results. + For elements whose height and width fit on the screen, proportional position dimensions in the range [0,1] represent elements that are completely on the screen, regardless of whether the height, width, or both are specified in device or proportional units.The above point means that, to specify an element in the lower right hand corner of the screen and that is half as wide and half as all as the screen, with a value of All, the application developer would specify "1.0, 1.0, 0.5, 0.5".The app developer can inadvertently cause child elements for which one or both size dimensions were specified proportionally to be displayed partially off the screen, or hidden altogether, by specifying device-unit positions that do not leave enough room for the calculated size of the child.Each part of the bounding structure is interpreted according to the value that controls it. A given rectangle might, for example, have an X-coordinate that is in device units, a Y-coordinate that is in proportional units, a height that is in proportional units, and a width that is in device units, or any other combination of device and proportional units. Rectangles that, when interpreted by using the current set on the child, represent bounding boxes that are partially or wholly off-screen—for example, by having a width that is larger than the screen width—may give unexpected results. diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/AppLinkEntry.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/AppLinkEntry.xml index ab50ffa9..3d816067 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms/AppLinkEntry.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/AppLinkEntry.xml @@ -15,8 +15,10 @@ A deep application link in an app link search index. - To be added. - Application Indexing and Deep Linking + + For information on setting up deep application linking on the Android platform (and on using deep linking in general), see Application Indexing and Deep Linking. + + Application Indexing and Deep Linking diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/Application.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/Application.xml index 318ebb15..0bb70fa3 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms/Application.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/Application.xml @@ -56,7 +56,7 @@ Gets the object that developers use to register or unregister application links. The object that developers use to register or unregister application links. It is not possible to unregister an app link on the Android platform. - Application Indexing and Deep Linking + Application Indexing and Deep Linking @@ -280,7 +280,7 @@ The URI for the request. App developers override this method to respond when the user initiates an app link request. To be added. - Application Indexing and Deep Linking + Application Indexing and Deep Linking diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/Behavior.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/Behavior.xml index 2649043a..123f2d0e 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms/Behavior.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/Behavior.xml @@ -17,6 +17,7 @@ Base class for generalized user-defined behaviors that can respond to arbitrary conditions and events. Application developers should specialize the generic class, instead of directly using . + Xamarin.Forms Behaviors diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/Behavior`1.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/Behavior`1.xml index b45d2110..e5a32feb 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms/Behavior`1.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/Behavior`1.xml @@ -24,6 +24,7 @@ The type of the objects with which this can be associated. Base generic class for generalized user-defined behaviors that can respond to arbitrary conditions and events. Application developers should specialize this generic class, instead of directly using . + Xamarin.Forms Behaviors diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/BindableProperty.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/BindableProperty.xml index 0f9f4210..7baddef0 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms/BindableProperty.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/BindableProperty.xml @@ -60,9 +60,9 @@ The type of the declaring object. The default value for the property. The BindingMode to use on SetBinding() if no BindingMode is given. This parameter is optional. Default is BindingMode.OneWay. - A delegate to be ran when a value is set. This parameter is optional. Default is null. - A delegate to be ran when the value has changed. This parameter is optional. Default is null. - A delegate to be ran when the value will change. This parameter is optional. Default is null. + A delegate to be run when a value is set. This parameter is optional. Default is null. + A delegate to be run when the value has changed. This parameter is optional. Default is null. + A delegate to be run when the value will change. This parameter is optional. Default is null. A delegate used to coerce the range of a value. This parameter is optional. Default is null. Creates a new instance of the BindableProperty class. A newly created BindableProperty. @@ -102,9 +102,9 @@ The type of the declaring object. The default value for the property. The BindingMode to use on SetBinding() if no BindingMode is given. This parameter is optional. Default is BindingMode.OneWay. - A delegate to be ran when a value is set. This parameter is optional. Default is null. - A delegate to be ran when the value has changed. This parameter is optional. Default is null. - A delegate to be ran when the value will change. This parameter is optional. Default is null. + A delegate to be run when a value is set. This parameter is optional. Default is null. + A delegate to be run when the value has changed. This parameter is optional. Default is null. + A delegate to be run when the value will change. This parameter is optional. Default is null. To be added. A Func used to initialize default value for reference types.. Creates a new instance of the BindableProperty class. @@ -147,7 +147,7 @@ An expression identifying the getter for the property using this BindableProperty as backing store. Default value for the BindableProperty. The BindingMode to use on SetBinding() if no BindingMode is given. This parameter is optional. Default is BindingMode.OneWay. - A delegate to be ran when a value is set. This parameter is optional. Default is null. + A delegate to be run when a value is set. This parameter is optional. Default is null. To be added. To be added. A delegate used to coerce the range of a value. This parameter is optional. Default is null. @@ -199,7 +199,7 @@ An expression identifying the getter for the property using this BindableProperty as backing store. Default value for the BindableProperty. The BindingMode to use on SetBinding() if no BindingMode is given. This parameter is optional. Default is BindingMode.OneWay. - A delegate to be ran when a value is set. This parameter is optional. Default is null. + A delegate to be run when a value is set. This parameter is optional. Default is null. To be added. To be added. To be added. @@ -237,9 +237,9 @@ The type of the declaring object. The default value for the property. The BindingMode to use on SetBinding() if no BindingMode is given. This parameter is optional. Default is BindingMode.OneWay. - A delegate to be ran when a value is set. This parameter is optional. Default is null. - A delegate to be ran when the value has changed. This parameter is optional. Default is null. - A delegate to be ran when the value will change. This parameter is optional. Default is null. + A delegate to be run when a value is set. This parameter is optional. Default is null. + A delegate to be run when the value has changed. This parameter is optional. Default is null. + A delegate to be run when the value will change. This parameter is optional. Default is null. A delegate used to coerce the range of a value. This parameter is optional. Default is null. Creates a new instance of the BindableProperty class for an attached property. A newly created attached BindableProperty. @@ -279,9 +279,9 @@ The type of the declaring object. The default value for the property. The BindingMode to use on SetBinding() if no BindingMode is given. This parameter is optional. Default is BindingMode.OneWay. - A delegate to be ran when a value is set. This parameter is optional. Default is null. - A delegate to be ran when the value has changed. This parameter is optional. Default is null. - A delegate to be ran when the value will change. This parameter is optional. Default is null. + A delegate to be run when a value is set. This parameter is optional. Default is null. + A delegate to be run when the value has changed. This parameter is optional. Default is null. + A delegate to be run when the value will change. This parameter is optional. Default is null. A delegate used to coerce the range of a value. This parameter is optional. Default is null. A Func used to initialize default value for reference types.. Creates a new instance of the BindableProperty class for an attached property. @@ -321,7 +321,7 @@ An expression identifying a static method returning the value of the property using this BindableProperty as backing store. Default value for the BindableProperty. The BindingMode to use on SetBinding() if no BindingMode is given. This parameter is optional. Default is BindingMode.OneWay. - A delegate to be ran when a value is set. This parameter is optional. Default is null. + A delegate to be run when a value is set. This parameter is optional. Default is null. To be added. To be added. A delegate used to coerce the range of a value. This parameter is optional. Default is null. @@ -371,7 +371,7 @@ An expression identifying a static method returning the value of the property using this BindableProperty as backing store. Default value for the BindableProperty. The BindingMode to use on SetBinding() if no BindingMode is given. This parameter is optional. Default is BindingMode.OneWay. - A delegate to be ran when a value is set. This parameter is optional. Default is null. + A delegate to be run when a value is set. This parameter is optional. Default is null. To be added. To be added. A delegate used to coerce the range of a value. This parameter is optional. Default is null. @@ -410,9 +410,9 @@ The type of the declaring object. The default value for the property. The BindingMode to use on SetBinding() if no BindingMode is given. This parameter is optional. Default is BindingMode.OneWay. - A delegate to be ran when a value is set. This parameter is optional. Default is null. - A delegate to be ran when the value has changed. This parameter is optional. Default is null. - A delegate to be ran when the value will change. This parameter is optional. Default is null. + A delegate to be run when a value is set. This parameter is optional. Default is null. + A delegate to be run when the value has changed. This parameter is optional. Default is null. + A delegate to be run when the value will change. This parameter is optional. Default is null. A delegate used to coerce the range of a value. This parameter is optional. Default is null. Creates a new instance of the BindableProperty class for attached read-only properties. A newly created attached read-only BindableProperty. @@ -453,9 +453,9 @@ The type of the declaring object. The default value for the property. The BindingMode to use on SetBinding() if no BindingMode is given. This parameter is optional. Default is BindingMode.OneWay. - A delegate to be ran when a value is set. This parameter is optional. Default is null. - A delegate to be ran when the value has changed. This parameter is optional. Default is null. - A delegate to be ran when the value will change. This parameter is optional. Default is null. + A delegate to be run when a value is set. This parameter is optional. Default is null. + A delegate to be run when the value has changed. This parameter is optional. Default is null. + A delegate to be run when the value will change. This parameter is optional. Default is null. A delegate used to coerce the range of a value. This parameter is optional. Default is null. A Func used to initialize default value for reference types. Creates a new instance of the BindableProperty class for attached read-only properties. @@ -496,7 +496,7 @@ An expression identifying a static method returning the value of the property using this BindableProperty as backing store. Default value for the BindableProperty. The BindingMode to use on SetBinding() if no BindingMode is given. This parameter is optional. Default is BindingMode.OneWay. - A delegate to be ran when a value is set. This parameter is optional. Default is null. + A delegate to be run when a value is set. This parameter is optional. Default is null. To be added. To be added. A delegate used to coerce the range of a value. This parameter is optional. Default is null. @@ -546,7 +546,7 @@ An expression identifying a static method returning the value of the property using this BindableProperty as backing store. Default value for the BindableProperty. The BindingMode to use on SetBinding() if no BindingMode is given. This parameter is optional. Default is BindingMode.OneWay. - A delegate to be ran when a value is set. This parameter is optional. Default is null. + A delegate to be run when a value is set. This parameter is optional. Default is null. To be added. To be added. A delegate used to coerce the range of a value. This parameter is optional. Default is null. @@ -586,7 +586,7 @@ The type of the declaring object. The default value for the property. The BindingMode to use on SetBinding() if no BindingMode is given. This parameter is optional. Default is BindingMode.OneWay. - A delegate to be ran when a value is set. This parameter is optional. Default is null. + A delegate to be run when a value is set. This parameter is optional. Default is null. To be added. To be added. A delegate used to coerce the range of a value. This parameter is optional. Default is null. @@ -630,7 +630,7 @@ The type of the declaring object. The default value for the property. The BindingMode to use on SetBinding() if no BindingMode is given. This parameter is optional. Default is BindingMode.OneWay. - A delegate to be ran when a value is set. This parameter is optional. Default is null. + A delegate to be run when a value is set. This parameter is optional. Default is null. To be added. To be added. A delegate used to coerce the range of a value. This parameter is optional. Default is null. @@ -678,9 +678,9 @@ An expression identifying the getter for the property using this BindableProperty as backing store. Default value for the BindableProperty. The BindingMode to use on SetBinding() if no BindingMode is given. This parameter is optional. Default is BindingMode.OneWay. - A delegate to be ran when a value is set. This parameter is optional. Default is null. - A delegate to be ran when the value has changed. This parameter is optional. Default is null. - A delegate to be ran when the value will change. This parameter is optional. Default is null. + A delegate to be run when a value is set. This parameter is optional. Default is null. + A delegate to be run when the value has changed. This parameter is optional. Default is null. + A delegate to be run when the value will change. This parameter is optional. Default is null. A delegate used to coerce the range of a value. This parameter is optional. Default is null. Deprecated. Do not use. A newly created BindablePropertyKey. @@ -732,9 +732,9 @@ An expression identifying the getter for the property using this BindableProperty as backing store. Default value for the BindableProperty. The BindingMode to use on SetBinding() if no BindingMode is given. This parameter is optional. Default is BindingMode.OneWay. - A delegate to be ran when a value is set. This parameter is optional. Default is null. - A delegate to be ran when the value has changed. This parameter is optional. Default is null. - A delegate to be ran when the value will change. This parameter is optional. Default is null. + A delegate to be run when a value is set. This parameter is optional. Default is null. + A delegate to be run when the value has changed. This parameter is optional. Default is null. + A delegate to be run when the value will change. This parameter is optional. Default is null. A delegate used to coerce the range of a value. This parameter is optional. Default is null. A Func used to initialize default value for reference types. Deprecated. Do not use. -- cgit v1.2.3