From cbb5b8bc06f960218be89885849d27ea293a26bb Mon Sep 17 00:00:00 2001 From: Mike Norman Date: Mon, 3 Apr 2017 14:31:40 -0500 Subject: Early april doc bugs (#854) * Fixed: https://github.com/xamarin/documentation/issues/2071 Pulled dated and exuberant examples. * Fixed: https://github.com/xamarin/documentation/issues/2002 Also added content for Load method in HtmlWebViewSource.xml * Fixed: https://github.com/xamarin/documentation/issues/1959 * Fixed: https://github.com/xamarin/documentation/issues/1866 --- docs/Xamarin.Forms.Core/Xamarin.Forms/Color.xml | 2 +- .../Xamarin.Forms/HtmlWebViewSource.xml | 6 +- docs/Xamarin.Forms.Core/Xamarin.Forms/Page.xml | 163 +-------------------- .../Xamarin.Forms/VisualElement.xml | 2 +- 4 files changed, 6 insertions(+), 167 deletions(-) (limited to 'docs') diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/Color.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/Color.xml index b09d02d0..c9d86026 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms/Color.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/Color.xml @@ -43,7 +43,7 @@ Application developers can specify colors in XAML either as a hexadecimal number or as a valid color name. When specifying a color with a hexadecimal number, app developers can use 3, 4, or 6 digits. If the developer specifies 3 digits, they are interpreted as RGB doublet data for a fully opaque color. For example, "#123" specifies the color that is represented by "#FF112233". If the developer provides a 4-digit hexadecimal number, then the data are interpreted as above, except that the first digit specifies the alpha channel. For example, "#1234" specifies the color that is represented by "#11223344". Finally, if the developer provides a 6 digit hexadecimal number, the data are interpreted as a fully opaque color with those RGB values. For example, "#112233" specifies the color that is represented by "#FF112233". When specifying a color with a string, app developers can use color name in isolation, or prefix it with "Color.". For example, both Purple and Color.Purple are valid ways to specify the color purple. The following table describes the valid color names that can be used to specify colors in XAML. -ColorShort NameRGB ValueColor.TransparentTransparent255, 255, 255 (With the alpha channel set to 0.)Color.AquaAqua0, 255, 255Color.BlackBlack0, 0, 0Color.BlueBlue0, 0, 255Color.FuchsiaFuchsia255, 0, 255Color.GrayGray128, 128, 128Color.GreenGreen0, 128, 0Color.LimeLime0, 255, 0Color.MaroonMaroon128, 0, 0Color.NavyNavy0, 0, 128Color.OliveOlive128, 128, 0Color.OrangeOrange255, 165, 0Color.PurplePurple128, 0, 128Color.PinkPink255, 102, 255Color.RedRed255, 0, 0Color.SilverSilver192, 192, 192Color.TealTeal0, 128, 128Color.WhiteWhite255, 255, 255Color.YellowYellow255, 255, 0Color.AliceBlueAliceBlue240, 248, 255Color.AntiqueWhiteAntiqueWhite250, 235, 215Color.AquamarineAquamarine127, 255, 212Color.AzureAzure240, 255, 255Color.BeigeBeige245, 245, 220Color.BisqueBisque255, 228, 196Color.BlanchedAlmondBlanchedAlmond255, 235, 205Color.BlueVioletBlueViolet138, 43, 226Color.BrownBrown165, 42, 42Color.BurlyWoodBurlyWood222, 184, 135Color.CadetBlueCadetBlue95, 158, 160Color.ChartreuseChartreuse127, 255, 0Color.ChocolateChocolate210, 105, 30Color.CoralCoral255, 127, 80Color.CornflowerBlueCornflowerBlue100, 149, 237Color.CornsilkCornsilk255, 248, 220Color.CrimsonCrimson220, 20, 60Color.CyanCyan0, 255, 255Color.DarkBlueDarkBlue0, 0, 139Color.DarkCyanDarkCyan0, 139, 139Color.DarkGoldenrodDarkGoldenrod184, 134, 11Color.DarkGrayDarkGray169, 169, 169Color.DarkGreenDarkGreen0, 100, 0Color.DarkKhakiDarkKhaki189, 183, 107Color.DarkMagentaDarkMagenta139, 0, 139Color.DarkOliveGreenDarkOliveGreen85, 107, 47Color.DarkOrangeDarkOrange255, 140, 0Color.DarkOrchidDarkOrchid153, 50, 204Color.DarkRedDarkRed139, 0, 0Color.DarkSalmonDarkSalmon233, 150, 122Color.DarkSeaGreenDarkSeaGreen143, 188, 143Color.DarkSlateBlueDarkSlateBlue72, 61, 139Color.DarkSlateGrayDarkSlateGray47, 79, 79Color.DarkTurquoiseDarkTurquoise0, 206, 209Color.DarkVioletDarkViolet148, 0, 211Color.DeepPinkDeepPink255, 20, 147Color.DeepSkyBlueDeepSkyBlue0, 191, 255Color.DimGrayDimGray105, 105, 105Color.DodgerBlueDodgerBlue30, 144, 255Color.FirebrickFirebrick178, 34, 34Color.FloralWhiteFloralWhite255, 250, 240Color.ForestGreenForestGreen34, 139, 34Color.GainsboroGainsboro220, 220, 220Color.GhostWhiteGhostWhite248, 248, 255Color.GoldGold255, 215, 0Color.GoldenrodGoldenrod218, 165, 32Color.GreenYellowGreenYellow173, 255, 47Color.HoneydewHoneydew240, 255, 240Color.HotPinkHotPink255, 105, 180Color.IndianRedIndianRed205, 92, 92Color.IndigoIndigo75, 0, 130Color.IvoryIvory255, 255, 240Color.KhakiKhaki240, 230, 140Color.LavenderLavender230, 230, 250Color.LavenderBlushLavenderBlush255, 240, 245Color.LawnGreenLawnGreen124, 252, 0Color.LemonChiffonLemonChiffon255, 250, 205Color.LightBlueLightBlue173, 216, 230Color.LightCoralLightCoral240, 128, 128Color.LightCyanLightCyan224, 255, 255Color.LightGoldenrodYellowLightGoldenrodYellow250, 250, 210Color.LightGrayLightGray211, 211, 211Color.LightGreenLightGreen144, 238, 144Color.LightPinkLightPink255, 182, 193Color.LightSalmonLightSalmon255, 160, 122Color.LightSeaGreenLightSeaGreen32, 178, 170Color.LightSkyBlueLightSkyBlue135, 206, 250Color.LightSlateGrayLightSlateGray119, 136, 153Color.LightSteelBlueLightSteelBlue176, 196, 222Color.LightYellowLightYellow255, 255, 224Color.LimeGreenLimeGreen50, 205, 50Color.LinenLinen250, 240, 230Color.MagentaMagenta255, 0, 255Color.MediumAquamarineMediumAquamarine102, 205, 170Color.MediumBlueMediumBlue0, 0, 205Color.MediumOrchidMediumOrchid186, 85, 211Color.MediumPurpleMediumPurple147, 112, 219Color.MediumSeaGreenMediumSeaGreen60, 179, 113Color.MediumSlateBlueMediumSlateBlue123, 104, 238Color.MediumSpringGreenMediumSpringGreen0, 250, 154Color.MediumTurquoiseMediumTurquoise72, 209, 204Color.MediumVioletRedMediumVioletRed199, 21, 133Color.MidnightBlueMidnightBlue25, 25, 112Color.MintCreamMintCream245, 255, 250Color.MistyRoseMistyRose255, 228, 225Color.MoccasinMoccasin255, 228, 181Color.NavajoWhiteNavajoWhite255, 222, 173Color.OldLaceOldLace253, 245, 230Color.OliveDrabOliveDrab107, 142, 35Color.OrangeRedOrangeRed255, 69, 0Color.OrchidOrchid218, 112, 214Color.PaleGoldenrodPaleGoldenrod238, 232, 170Color.PaleGreenPaleGreen152, 251, 152Color.PaleTurquoisePaleTurquoise175, 238, 238Color.PaleVioletRedPaleVioletRed219, 112, 147Color.PapayaWhipPapayaWhip255, 239, 213Color.PeachPuffPeachPuff255, 218, 185Color.PeruPeru205, 133, 63Color.PlumPlum221, 160, 221Color.PowderBluePowderBlue176, 224, 230Color.RosyBrownRosyBrown188, 143, 143Color.RoyalBlueRoyalBlue65, 105, 225Color.SaddleBrownSaddleBrown139, 69, 19Color.SalmonSalmon250, 128, 114Color.SandyBrownSandyBrown244, 164, 96Color.SeaGreenSeaGreen46, 139, 87Color.SeaShellSeaShell255, 245, 238Color.SiennaSienna160, 82, 45Color.SkyBlueSkyBlue135, 206, 235Color.SlateBlueSlateBlue106, 90, 205Color.SlateGraySlateGray112, 128, 144Color.SnowSnow255, 250, 250Color.SpringGreenSpringGreen0, 255, 127Color.SteelBlueSteelBlue70, 130, 180Color.TanTan210, 180, 140Color.ThistleThistle216, 191, 216Color.TomatoTomato255, 99, 71Color.TurquoiseTurquoise64, 224, 208Color.VioletViolet238, 130, 238Color.WheatWheat245, 222, 179Color.WhiteSmokeWhiteSmoke245, 245, 245Color.YellowGreenYellowGreen154, 205, 50 +ColorShort NameRGB ValueColor.TransparentTransparent255, 255, 255 (With the alpha channel set to 0.)Color.AquaAqua0, 255, 255Color.BlackBlack0, 0, 0Color.BlueBlue0, 0, 255Color.FuchsiaFuchsia255, 0, 255Color.GrayGray128, 128, 128Color.GreenGreen0, 128, 0Color.LimeLime0, 255, 0Color.MaroonMaroon128, 0, 0Color.NavyNavy0, 0, 128Color.OliveOlive128, 128, 0Color.OrangeOrange255, 165, 0Color.PurplePurple128, 0, 128Color.PinkPink255, 192, 203Color.RedRed255, 0, 0Color.SilverSilver192, 192, 192Color.TealTeal0, 128, 128Color.WhiteWhite255, 255, 255Color.YellowYellow255, 255, 0Color.AliceBlueAliceBlue240, 248, 255Color.AntiqueWhiteAntiqueWhite250, 235, 215Color.AquamarineAquamarine127, 255, 212Color.AzureAzure240, 255, 255Color.BeigeBeige245, 245, 220Color.BisqueBisque255, 228, 196Color.BlanchedAlmondBlanchedAlmond255, 235, 205Color.BlueVioletBlueViolet138, 43, 226Color.BrownBrown165, 42, 42Color.BurlyWoodBurlyWood222, 184, 135Color.CadetBlueCadetBlue95, 158, 160Color.ChartreuseChartreuse127, 255, 0Color.ChocolateChocolate210, 105, 30Color.CoralCoral255, 127, 80Color.CornflowerBlueCornflowerBlue100, 149, 237Color.CornsilkCornsilk255, 248, 220Color.CrimsonCrimson220, 20, 60Color.CyanCyan0, 255, 255Color.DarkBlueDarkBlue0, 0, 139Color.DarkCyanDarkCyan0, 139, 139Color.DarkGoldenrodDarkGoldenrod184, 134, 11Color.DarkGrayDarkGray169, 169, 169Color.DarkGreenDarkGreen0, 100, 0Color.DarkKhakiDarkKhaki189, 183, 107Color.DarkMagentaDarkMagenta139, 0, 139Color.DarkOliveGreenDarkOliveGreen85, 107, 47Color.DarkOrangeDarkOrange255, 140, 0Color.DarkOrchidDarkOrchid153, 50, 204Color.DarkRedDarkRed139, 0, 0Color.DarkSalmonDarkSalmon233, 150, 122Color.DarkSeaGreenDarkSeaGreen143, 188, 143Color.DarkSlateBlueDarkSlateBlue72, 61, 139Color.DarkSlateGrayDarkSlateGray47, 79, 79Color.DarkTurquoiseDarkTurquoise0, 206, 209Color.DarkVioletDarkViolet148, 0, 211Color.DeepPinkDeepPink255, 20, 147Color.DeepSkyBlueDeepSkyBlue0, 191, 255Color.DimGrayDimGray105, 105, 105Color.DodgerBlueDodgerBlue30, 144, 255Color.FirebrickFirebrick178, 34, 34Color.FloralWhiteFloralWhite255, 250, 240Color.ForestGreenForestGreen34, 139, 34Color.GainsboroGainsboro220, 220, 220Color.GhostWhiteGhostWhite248, 248, 255Color.GoldGold255, 215, 0Color.GoldenrodGoldenrod218, 165, 32Color.GreenYellowGreenYellow173, 255, 47Color.HoneydewHoneydew240, 255, 240Color.HotPinkHotPink255, 105, 180Color.IndianRedIndianRed205, 92, 92Color.IndigoIndigo75, 0, 130Color.IvoryIvory255, 255, 240Color.KhakiKhaki240, 230, 140Color.LavenderLavender230, 230, 250Color.LavenderBlushLavenderBlush255, 240, 245Color.LawnGreenLawnGreen124, 252, 0Color.LemonChiffonLemonChiffon255, 250, 205Color.LightBlueLightBlue173, 216, 230Color.LightCoralLightCoral240, 128, 128Color.LightCyanLightCyan224, 255, 255Color.LightGoldenrodYellowLightGoldenrodYellow250, 250, 210Color.LightGrayLightGray211, 211, 211Color.LightGreenLightGreen144, 238, 144Color.LightPinkLightPink255, 182, 193Color.LightSalmonLightSalmon255, 160, 122Color.LightSeaGreenLightSeaGreen32, 178, 170Color.LightSkyBlueLightSkyBlue135, 206, 250Color.LightSlateGrayLightSlateGray119, 136, 153Color.LightSteelBlueLightSteelBlue176, 196, 222Color.LightYellowLightYellow255, 255, 224Color.LimeGreenLimeGreen50, 205, 50Color.LinenLinen250, 240, 230Color.MagentaMagenta255, 0, 255Color.MediumAquamarineMediumAquamarine102, 205, 170Color.MediumBlueMediumBlue0, 0, 205Color.MediumOrchidMediumOrchid186, 85, 211Color.MediumPurpleMediumPurple147, 112, 219Color.MediumSeaGreenMediumSeaGreen60, 179, 113Color.MediumSlateBlueMediumSlateBlue123, 104, 238Color.MediumSpringGreenMediumSpringGreen0, 250, 154Color.MediumTurquoiseMediumTurquoise72, 209, 204Color.MediumVioletRedMediumVioletRed199, 21, 133Color.MidnightBlueMidnightBlue25, 25, 112Color.MintCreamMintCream245, 255, 250Color.MistyRoseMistyRose255, 228, 225Color.MoccasinMoccasin255, 228, 181Color.NavajoWhiteNavajoWhite255, 222, 173Color.OldLaceOldLace253, 245, 230Color.OliveDrabOliveDrab107, 142, 35Color.OrangeRedOrangeRed255, 69, 0Color.OrchidOrchid218, 112, 214Color.PaleGoldenrodPaleGoldenrod238, 232, 170Color.PaleGreenPaleGreen152, 251, 152Color.PaleTurquoisePaleTurquoise175, 238, 238Color.PaleVioletRedPaleVioletRed219, 112, 147Color.PapayaWhipPapayaWhip255, 239, 213Color.PeachPuffPeachPuff255, 218, 185Color.PeruPeru205, 133, 63Color.PlumPlum221, 160, 221Color.PowderBluePowderBlue176, 224, 230Color.RosyBrownRosyBrown188, 143, 143Color.RoyalBlueRoyalBlue65, 105, 225Color.SaddleBrownSaddleBrown139, 69, 19Color.SalmonSalmon250, 128, 114Color.SandyBrownSandyBrown244, 164, 96Color.SeaGreenSeaGreen46, 139, 87Color.SeaShellSeaShell255, 245, 238Color.SiennaSienna160, 82, 45Color.SkyBlueSkyBlue135, 206, 235Color.SlateBlueSlateBlue106, 90, 205Color.SlateGraySlateGray112, 128, 144Color.SnowSnow255, 250, 250Color.SpringGreenSpringGreen0, 255, 127Color.SteelBlueSteelBlue70, 130, 180Color.TanTan210, 180, 140Color.ThistleThistle216, 191, 216Color.TomatoTomato255, 99, 71Color.TurquoiseTurquoise64, 224, 208Color.VioletViolet238, 130, 238Color.WheatWheat245, 222, 179Color.WhiteSmokeWhiteSmoke245, 245, 245Color.YellowGreenYellowGreen154, 205, 50 diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/HtmlWebViewSource.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/HtmlWebViewSource.xml index f85310d7..f2b7362b 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms/HtmlWebViewSource.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/HtmlWebViewSource.xml @@ -121,7 +121,7 @@ Xamarin.Forms.BindableProperty - Backing store for the property. + Backing store for the property. To be added. @@ -144,8 +144,8 @@ - To be added. - To be added. + The renderer into which to load html content. + Loads the specified with the current base URL and HTML. To be added. diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/Page.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/Page.xml index bb867f0c..70bb7bef 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms/Page.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/Page.xml @@ -34,168 +34,7 @@ A that occupies the entire screen. - is primarily a base class for more useful derived types. Objects that are derived from the see class are most prominently used as the top level UI element in Xamarin.Forms applications. Typically, application developers will provide such an object to the target platforms by returning it from a static method that the developer created in a project that references . The contents of a typical App.cs file that would appear in a project that reference are shown below: - - - - While a object was returned in the example above, note that any class that extends could have been passed, instead. For example, by using conditional compilation or by checking the platform, the developr can pass a to Windows Phone applications, in order to better match the style of the user interface on that platform, while passing objects or other Page types to the other platforms. - The other projects in the solution that target the Windows Phone, iOS, and Android platforms can call the GetMainPage method to obtain the descendant that describes the portable user interface. This object can then be used with platform-specific static methods or extension methods to incorporate it into the native UI for each platform. - In each platform-specific project, Application developers must call the Xamarin.Forms.Forms.Init() method, with platform-specific parameters, before they get or create any elements. - Each targeted platform uses the returned page in a different way. The Xamarin.Forms.Platform.iOS library provides Xamarin.Forms.Page.CreateViewController() extension method, which returns a UIViewController that application developers can assign to the UIWindow.RootViewController property of the top-level UI. This code is typically placed inside the UIApplicationDelegate.FinishedLaunching override for the main application class. A typical example is shown below: - - -using System; -using Xamarin.Forms; - -namespace MyFirstFormsApp.iOS -{ - [Register("AppDelegate")] - public partial class AppDelegate : UIApplicationDelegate - { - UIWindow window; - - public override bool FinishedLaunching(UIApplication app, - NSDictionary options) - { - Forms.Init(); - - window = new UIWindow(UIScreen.MainScreen.Bounds); - - window.RootViewController = App.GetMainPage().CreateViewController(); - window.MakeKeyAndVisible(); - - return true; - } - } -} - - - - The Xamarin.Forms.Platform.Android.AndroidActivity class provides the Xamarin.Forms.Platform.Android.AndroidActivity.SetPage method, which performs the work that is necessary to make its page argument the top-level UI element of the Xamarin.Forms.Platform.Android.AndroidActivity. A typical example is shown below: - - -using System; -using Android.App; -using Android.OS; -using Xamarin.Forms.Platform.Android; - - -namespace MyFirstFormsApp.Android -{ - [Activity(Label = "MyFirstFormsApp", MainLauncher = true)] - public class MainActivity : AndroidActivity - { - protected override void OnCreate(Bundle bundle) - { - base.OnCreate(bundle); - - Xamarin.Forms.Forms.Init(this, bundle); - - SetPage(App.GetMainPage()); - } - } -} - - - For Windows Phone, provides an extension method for that is called . This method returns a System.Windows.UIElement object that has the page that was passed to it as its current page. A typical example is shown below: - - -using System; -using System.Windows; -using System.Windows.Controls; -using System.Windows.Navigation; -using Microsoft.Phone.Controls; -using Microsoft.Phone.Shell; - -using Xamarin.Forms; - - -namespace MyFirstFormsApp.WinPhone -{ - public partial class MainPage : PhoneApplicationPage - { - public MainPage() - { - InitializeComponent(); - - Forms.Init(); - Content = Phoneword.App.GetMainPage().ConvertPageToUIElement(this); - } - } -} - - In addition to their role as the main pages of applications, objects and their descendants can be used with navigation classes, such as or , among others, to provide rich user experiences that conform to the expected behaviors on each platform. - XAML for Xamarin.Forms supports the following properties for the class: - - - Property - Value - - - BackgroundImage - - A local file specification that identifies an image. - - - - Icon - - A local file specification that identifies an image. - - - - Padding - - A comma-separated list of 4 integers that represent a structure. - - - - Title - - Text that represents the title of the page. - - - - ToolbarItems - - A list of ToolBarItem elements. - - - + is primarily a base class for more useful derived types. Objects that are derived from the class are most prominently used as the top level UI element in Xamarin.Forms applications. In addition to their role as the main pages of applications, objects and their descendants can be used with navigation classes, such as or , among others, to provide rich user experiences that conform to the expected behaviors on each platform. diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/VisualElement.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/VisualElement.xml index de79fe26..6202ab2d 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms/VisualElement.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/VisualElement.xml @@ -1384,7 +1384,7 @@ The available width for the element to use. The available height for the element to use. This method is called during the measure pass of a layout cycle to get the desired size of an element. - A which contains the desired size of the element. + A which contains the desired size of the element. The results of this method will be (-1, -1) if the element has not yet been realized with a platform specific backing control. Overriding this method does not require a call to the base class so long as a valid SizeRequest is returned. -- cgit v1.2.3