diff options
Diffstat (limited to 'docs')
4 files changed, 6 insertions, 167 deletions
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 @@ <para>Application developers can specify colors in XAML either as a hexadecimal number or as a valid color name.</para> <para>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".</para> <para>When specifying a color with a string, app developers can use color name in isolation, or prefix it with "Color.". For example, both <c>Purple</c> and <c>Color.Purple</c> 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. -<list type="table"><listheader><term>Color</term><description>Short Name</description><description>RGB Value</description></listheader><item><term>Color.Transparent</term><description>Transparent</description><description>255, 255, 255 (With the alpha channel set to 0.)</description></item><item><term>Color.Aqua</term><description>Aqua</description><description>0, 255, 255</description></item><item><term>Color.Black</term><description>Black</description><description>0, 0, 0</description></item><item><term>Color.Blue</term><description>Blue</description><description>0, 0, 255</description></item><item><term>Color.Fuchsia</term><description>Fuchsia</description><description>255, 0, 255</description></item><item><term>Color.Gray</term><description>Gray</description><description>128, 128, 128</description></item><item><term>Color.Green</term><description>Green</description><description>0, 128, 0</description></item><item><term>Color.Lime</term><description>Lime</description><description>0, 255, 0</description></item><item><term>Color.Maroon</term><description>Maroon</description><description>128, 0, 0</description></item><item><term>Color.Navy</term><description>Navy</description><description>0, 0, 128</description></item><item><term>Color.Olive</term><description>Olive</description><description>128, 128, 0</description></item><item><term>Color.Orange</term><description>Orange</description><description>255, 165, 0</description></item><item><term>Color.Purple</term><description>Purple</description><description>128, 0, 128</description></item><item><term>Color.Pink</term><description>Pink</description><description>255, 102, 255</description></item><item><term>Color.Red</term><description>Red</description><description>255, 0, 0</description></item><item><term>Color.Silver</term><description>Silver</description><description>192, 192, 192</description></item><item><term>Color.Teal</term><description>Teal</description><description>0, 128, 128</description></item><item><term>Color.White</term><description>White</description><description>255, 255, 255</description></item><item><term>Color.Yellow</term><description>Yellow</description><description>255, 255, 0</description></item><item><term>Color.AliceBlue</term><description>AliceBlue</description><description>240, 248, 255</description></item><item><term>Color.AntiqueWhite</term><description>AntiqueWhite</description><description>250, 235, 215</description></item><item><term>Color.Aquamarine</term><description>Aquamarine</description><description>127, 255, 212</description></item><item><term>Color.Azure</term><description>Azure</description><description>240, 255, 255</description></item><item><term>Color.Beige</term><description>Beige</description><description>245, 245, 220</description></item><item><term>Color.Bisque</term><description>Bisque</description><description>255, 228, 196</description></item><item><term>Color.BlanchedAlmond</term><description>BlanchedAlmond</description><description>255, 235, 205</description></item><item><term>Color.BlueViolet</term><description>BlueViolet</description><description>138, 43, 226</description></item><item><term>Color.Brown</term><description>Brown</description><description>165, 42, 42</description></item><item><term>Color.BurlyWood</term><description>BurlyWood</description><description>222, 184, 135</description></item><item><term>Color.CadetBlue</term><description>CadetBlue</description><description>95, 158, 160</description></item><item><term>Color.Chartreuse</term><description>Chartreuse</description><description>127, 255, 0</description></item><item><term>Color.Chocolate</term><description>Chocolate</description><description>210, 105, 30</description></item><item><term>Color.Coral</term><description>Coral</description><description>255, 127, 80</description></item><item><term>Color.CornflowerBlue</term><description>CornflowerBlue</description><description>100, 149, 237</description></item><item><term>Color.Cornsilk</term><description>Cornsilk</description><description>255, 248, 220</description></item><item><term>Color.Crimson</term><description>Crimson</description><description>220, 20, 60</description></item><item><term>Color.Cyan</term><description>Cyan</description><description>0, 255, 255</description></item><item><term>Color.DarkBlue</term><description>DarkBlue</description><description>0, 0, 139</description></item><item><term>Color.DarkCyan</term><description>DarkCyan</description><description>0, 139, 139</description></item><item><term>Color.DarkGoldenrod</term><description>DarkGoldenrod</description><description>184, 134, 11</description></item><item><term>Color.DarkGray</term><description>DarkGray</description><description>169, 169, 169</description></item><item><term>Color.DarkGreen</term><description>DarkGreen</description><description>0, 100, 0</description></item><item><term>Color.DarkKhaki</term><description>DarkKhaki</description><description>189, 183, 107</description></item><item><term>Color.DarkMagenta</term><description>DarkMagenta</description><description>139, 0, 139</description></item><item><term>Color.DarkOliveGreen</term><description>DarkOliveGreen</description><description>85, 107, 47</description></item><item><term>Color.DarkOrange</term><description>DarkOrange</description><description>255, 140, 0</description></item><item><term>Color.DarkOrchid</term><description>DarkOrchid</description><description>153, 50, 204</description></item><item><term>Color.DarkRed</term><description>DarkRed</description><description>139, 0, 0</description></item><item><term>Color.DarkSalmon</term><description>DarkSalmon</description><description>233, 150, 122</description></item><item><term>Color.DarkSeaGreen</term><description>DarkSeaGreen</description><description>143, 188, 143</description></item><item><term>Color.DarkSlateBlue</term><description>DarkSlateBlue</description><description>72, 61, 139</description></item><item><term>Color.DarkSlateGray</term><description>DarkSlateGray</description><description>47, 79, 79</description></item><item><term>Color.DarkTurquoise</term><description>DarkTurquoise</description><description>0, 206, 209</description></item><item><term>Color.DarkViolet</term><description>DarkViolet</description><description>148, 0, 211</description></item><item><term>Color.DeepPink</term><description>DeepPink</description><description>255, 20, 147</description></item><item><term>Color.DeepSkyBlue</term><description>DeepSkyBlue</description><description>0, 191, 255</description></item><item><term>Color.DimGray</term><description>DimGray</description><description>105, 105, 105</description></item><item><term>Color.DodgerBlue</term><description>DodgerBlue</description><description>30, 144, 255</description></item><item><term>Color.Firebrick</term><description>Firebrick</description><description>178, 34, 34</description></item><item><term>Color.FloralWhite</term><description>FloralWhite</description><description>255, 250, 240</description></item><item><term>Color.ForestGreen</term><description>ForestGreen</description><description>34, 139, 34</description></item><item><term>Color.Gainsboro</term><description>Gainsboro</description><description>220, 220, 220</description></item><item><term>Color.GhostWhite</term><description>GhostWhite</description><description>248, 248, 255</description></item><item><term>Color.Gold</term><description>Gold</description><description>255, 215, 0</description></item><item><term>Color.Goldenrod</term><description>Goldenrod</description><description>218, 165, 32</description></item><item><term>Color.GreenYellow</term><description>GreenYellow</description><description>173, 255, 47</description></item><item><term>Color.Honeydew</term><description>Honeydew</description><description>240, 255, 240</description></item><item><term>Color.HotPink</term><description>HotPink</description><description>255, 105, 180</description></item><item><term>Color.IndianRed</term><description>IndianRed</description><description>205, 92, 92</description></item><item><term>Color.Indigo</term><description>Indigo</description><description>75, 0, 130</description></item><item><term>Color.Ivory</term><description>Ivory</description><description>255, 255, 240</description></item><item><term>Color.Khaki</term><description>Khaki</description><description>240, 230, 140</description></item><item><term>Color.Lavender</term><description>Lavender</description><description>230, 230, 250</description></item><item><term>Color.LavenderBlush</term><description>LavenderBlush</description><description>255, 240, 245</description></item><item><term>Color.LawnGreen</term><description>LawnGreen</description><description>124, 252, 0</description></item><item><term>Color.LemonChiffon</term><description>LemonChiffon</description><description>255, 250, 205</description></item><item><term>Color.LightBlue</term><description>LightBlue</description><description>173, 216, 230</description></item><item><term>Color.LightCoral</term><description>LightCoral</description><description>240, 128, 128</description></item><item><term>Color.LightCyan</term><description>LightCyan</description><description>224, 255, 255</description></item><item><term>Color.LightGoldenrodYellow</term><description>LightGoldenrodYellow</description><description>250, 250, 210</description></item><item><term>Color.LightGray</term><description>LightGray</description><description>211, 211, 211</description></item><item><term>Color.LightGreen</term><description>LightGreen</description><description>144, 238, 144</description></item><item><term>Color.LightPink</term><description>LightPink</description><description>255, 182, 193</description></item><item><term>Color.LightSalmon</term><description>LightSalmon</description><description>255, 160, 122</description></item><item><term>Color.LightSeaGreen</term><description>LightSeaGreen</description><description>32, 178, 170</description></item><item><term>Color.LightSkyBlue</term><description>LightSkyBlue</description><description>135, 206, 250</description></item><item><term>Color.LightSlateGray</term><description>LightSlateGray</description><description>119, 136, 153</description></item><item><term>Color.LightSteelBlue</term><description>LightSteelBlue</description><description>176, 196, 222</description></item><item><term>Color.LightYellow</term><description>LightYellow</description><description>255, 255, 224</description></item><item><term>Color.LimeGreen</term><description>LimeGreen</description><description>50, 205, 50</description></item><item><term>Color.Linen</term><description>Linen</description><description>250, 240, 230</description></item><item><term>Color.Magenta</term><description>Magenta</description><description>255, 0, 255</description></item><item><term>Color.MediumAquamarine</term><description>MediumAquamarine</description><description>102, 205, 170</description></item><item><term>Color.MediumBlue</term><description>MediumBlue</description><description>0, 0, 205</description></item><item><term>Color.MediumOrchid</term><description>MediumOrchid</description><description>186, 85, 211</description></item><item><term>Color.MediumPurple</term><description>MediumPurple</description><description>147, 112, 219</description></item><item><term>Color.MediumSeaGreen</term><description>MediumSeaGreen</description><description>60, 179, 113</description></item><item><term>Color.MediumSlateBlue</term><description>MediumSlateBlue</description><description>123, 104, 238</description></item><item><term>Color.MediumSpringGreen</term><description>MediumSpringGreen</description><description>0, 250, 154</description></item><item><term>Color.MediumTurquoise</term><description>MediumTurquoise</description><description>72, 209, 204</description></item><item><term>Color.MediumVioletRed</term><description>MediumVioletRed</description><description>199, 21, 133</description></item><item><term>Color.MidnightBlue</term><description>MidnightBlue</description><description>25, 25, 112</description></item><item><term>Color.MintCream</term><description>MintCream</description><description>245, 255, 250</description></item><item><term>Color.MistyRose</term><description>MistyRose</description><description>255, 228, 225</description></item><item><term>Color.Moccasin</term><description>Moccasin</description><description>255, 228, 181</description></item><item><term>Color.NavajoWhite</term><description>NavajoWhite</description><description>255, 222, 173</description></item><item><term>Color.OldLace</term><description>OldLace</description><description>253, 245, 230</description></item><item><term>Color.OliveDrab</term><description>OliveDrab</description><description>107, 142, 35</description></item><item><term>Color.OrangeRed</term><description>OrangeRed</description><description>255, 69, 0</description></item><item><term>Color.Orchid</term><description>Orchid</description><description>218, 112, 214</description></item><item><term>Color.PaleGoldenrod</term><description>PaleGoldenrod</description><description>238, 232, 170</description></item><item><term>Color.PaleGreen</term><description>PaleGreen</description><description>152, 251, 152</description></item><item><term>Color.PaleTurquoise</term><description>PaleTurquoise</description><description>175, 238, 238</description></item><item><term>Color.PaleVioletRed</term><description>PaleVioletRed</description><description>219, 112, 147</description></item><item><term>Color.PapayaWhip</term><description>PapayaWhip</description><description>255, 239, 213</description></item><item><term>Color.PeachPuff</term><description>PeachPuff</description><description>255, 218, 185</description></item><item><term>Color.Peru</term><description>Peru</description><description>205, 133, 63</description></item><item><term>Color.Plum</term><description>Plum</description><description>221, 160, 221</description></item><item><term>Color.PowderBlue</term><description>PowderBlue</description><description>176, 224, 230</description></item><item><term>Color.RosyBrown</term><description>RosyBrown</description><description>188, 143, 143</description></item><item><term>Color.RoyalBlue</term><description>RoyalBlue</description><description>65, 105, 225</description></item><item><term>Color.SaddleBrown</term><description>SaddleBrown</description><description>139, 69, 19</description></item><item><term>Color.Salmon</term><description>Salmon</description><description>250, 128, 114</description></item><item><term>Color.SandyBrown</term><description>SandyBrown</description><description>244, 164, 96</description></item><item><term>Color.SeaGreen</term><description>SeaGreen</description><description>46, 139, 87</description></item><item><term>Color.SeaShell</term><description>SeaShell</description><description>255, 245, 238</description></item><item><term>Color.Sienna</term><description>Sienna</description><description>160, 82, 45</description></item><item><term>Color.SkyBlue</term><description>SkyBlue</description><description>135, 206, 235</description></item><item><term>Color.SlateBlue</term><description>SlateBlue</description><description>106, 90, 205</description></item><item><term>Color.SlateGray</term><description>SlateGray</description><description>112, 128, 144</description></item><item><term>Color.Snow</term><description>Snow</description><description>255, 250, 250</description></item><item><term>Color.SpringGreen</term><description>SpringGreen</description><description>0, 255, 127</description></item><item><term>Color.SteelBlue</term><description>SteelBlue</description><description>70, 130, 180</description></item><item><term>Color.Tan</term><description>Tan</description><description>210, 180, 140</description></item><item><term>Color.Thistle</term><description>Thistle</description><description>216, 191, 216</description></item><item><term>Color.Tomato</term><description>Tomato</description><description>255, 99, 71</description></item><item><term>Color.Turquoise</term><description>Turquoise</description><description>64, 224, 208</description></item><item><term>Color.Violet</term><description>Violet</description><description>238, 130, 238</description></item><item><term>Color.Wheat</term><description>Wheat</description><description>245, 222, 179</description></item><item><term>Color.WhiteSmoke</term><description>WhiteSmoke</description><description>245, 245, 245</description></item><item><term>Color.YellowGreen</term><description>YellowGreen</description><description>154, 205, 50</description></item></list></para> +<list type="table"><listheader><term>Color</term><description>Short Name</description><description>RGB Value</description></listheader><item><term>Color.Transparent</term><description>Transparent</description><description>255, 255, 255 (With the alpha channel set to 0.)</description></item><item><term>Color.Aqua</term><description>Aqua</description><description>0, 255, 255</description></item><item><term>Color.Black</term><description>Black</description><description>0, 0, 0</description></item><item><term>Color.Blue</term><description>Blue</description><description>0, 0, 255</description></item><item><term>Color.Fuchsia</term><description>Fuchsia</description><description>255, 0, 255</description></item><item><term>Color.Gray</term><description>Gray</description><description>128, 128, 128</description></item><item><term>Color.Green</term><description>Green</description><description>0, 128, 0</description></item><item><term>Color.Lime</term><description>Lime</description><description>0, 255, 0</description></item><item><term>Color.Maroon</term><description>Maroon</description><description>128, 0, 0</description></item><item><term>Color.Navy</term><description>Navy</description><description>0, 0, 128</description></item><item><term>Color.Olive</term><description>Olive</description><description>128, 128, 0</description></item><item><term>Color.Orange</term><description>Orange</description><description>255, 165, 0</description></item><item><term>Color.Purple</term><description>Purple</description><description>128, 0, 128</description></item><item><term>Color.Pink</term><description>Pink</description><description>255, 192, 203</description></item><item><term>Color.Red</term><description>Red</description><description>255, 0, 0</description></item><item><term>Color.Silver</term><description>Silver</description><description>192, 192, 192</description></item><item><term>Color.Teal</term><description>Teal</description><description>0, 128, 128</description></item><item><term>Color.White</term><description>White</description><description>255, 255, 255</description></item><item><term>Color.Yellow</term><description>Yellow</description><description>255, 255, 0</description></item><item><term>Color.AliceBlue</term><description>AliceBlue</description><description>240, 248, 255</description></item><item><term>Color.AntiqueWhite</term><description>AntiqueWhite</description><description>250, 235, 215</description></item><item><term>Color.Aquamarine</term><description>Aquamarine</description><description>127, 255, 212</description></item><item><term>Color.Azure</term><description>Azure</description><description>240, 255, 255</description></item><item><term>Color.Beige</term><description>Beige</description><description>245, 245, 220</description></item><item><term>Color.Bisque</term><description>Bisque</description><description>255, 228, 196</description></item><item><term>Color.BlanchedAlmond</term><description>BlanchedAlmond</description><description>255, 235, 205</description></item><item><term>Color.BlueViolet</term><description>BlueViolet</description><description>138, 43, 226</description></item><item><term>Color.Brown</term><description>Brown</description><description>165, 42, 42</description></item><item><term>Color.BurlyWood</term><description>BurlyWood</description><description>222, 184, 135</description></item><item><term>Color.CadetBlue</term><description>CadetBlue</description><description>95, 158, 160</description></item><item><term>Color.Chartreuse</term><description>Chartreuse</description><description>127, 255, 0</description></item><item><term>Color.Chocolate</term><description>Chocolate</description><description>210, 105, 30</description></item><item><term>Color.Coral</term><description>Coral</description><description>255, 127, 80</description></item><item><term>Color.CornflowerBlue</term><description>CornflowerBlue</description><description>100, 149, 237</description></item><item><term>Color.Cornsilk</term><description>Cornsilk</description><description>255, 248, 220</description></item><item><term>Color.Crimson</term><description>Crimson</description><description>220, 20, 60</description></item><item><term>Color.Cyan</term><description>Cyan</description><description>0, 255, 255</description></item><item><term>Color.DarkBlue</term><description>DarkBlue</description><description>0, 0, 139</description></item><item><term>Color.DarkCyan</term><description>DarkCyan</description><description>0, 139, 139</description></item><item><term>Color.DarkGoldenrod</term><description>DarkGoldenrod</description><description>184, 134, 11</description></item><item><term>Color.DarkGray</term><description>DarkGray</description><description>169, 169, 169</description></item><item><term>Color.DarkGreen</term><description>DarkGreen</description><description>0, 100, 0</description></item><item><term>Color.DarkKhaki</term><description>DarkKhaki</description><description>189, 183, 107</description></item><item><term>Color.DarkMagenta</term><description>DarkMagenta</description><description>139, 0, 139</description></item><item><term>Color.DarkOliveGreen</term><description>DarkOliveGreen</description><description>85, 107, 47</description></item><item><term>Color.DarkOrange</term><description>DarkOrange</description><description>255, 140, 0</description></item><item><term>Color.DarkOrchid</term><description>DarkOrchid</description><description>153, 50, 204</description></item><item><term>Color.DarkRed</term><description>DarkRed</description><description>139, 0, 0</description></item><item><term>Color.DarkSalmon</term><description>DarkSalmon</description><description>233, 150, 122</description></item><item><term>Color.DarkSeaGreen</term><description>DarkSeaGreen</description><description>143, 188, 143</description></item><item><term>Color.DarkSlateBlue</term><description>DarkSlateBlue</description><description>72, 61, 139</description></item><item><term>Color.DarkSlateGray</term><description>DarkSlateGray</description><description>47, 79, 79</description></item><item><term>Color.DarkTurquoise</term><description>DarkTurquoise</description><description>0, 206, 209</description></item><item><term>Color.DarkViolet</term><description>DarkViolet</description><description>148, 0, 211</description></item><item><term>Color.DeepPink</term><description>DeepPink</description><description>255, 20, 147</description></item><item><term>Color.DeepSkyBlue</term><description>DeepSkyBlue</description><description>0, 191, 255</description></item><item><term>Color.DimGray</term><description>DimGray</description><description>105, 105, 105</description></item><item><term>Color.DodgerBlue</term><description>DodgerBlue</description><description>30, 144, 255</description></item><item><term>Color.Firebrick</term><description>Firebrick</description><description>178, 34, 34</description></item><item><term>Color.FloralWhite</term><description>FloralWhite</description><description>255, 250, 240</description></item><item><term>Color.ForestGreen</term><description>ForestGreen</description><description>34, 139, 34</description></item><item><term>Color.Gainsboro</term><description>Gainsboro</description><description>220, 220, 220</description></item><item><term>Color.GhostWhite</term><description>GhostWhite</description><description>248, 248, 255</description></item><item><term>Color.Gold</term><description>Gold</description><description>255, 215, 0</description></item><item><term>Color.Goldenrod</term><description>Goldenrod</description><description>218, 165, 32</description></item><item><term>Color.GreenYellow</term><description>GreenYellow</description><description>173, 255, 47</description></item><item><term>Color.Honeydew</term><description>Honeydew</description><description>240, 255, 240</description></item><item><term>Color.HotPink</term><description>HotPink</description><description>255, 105, 180</description></item><item><term>Color.IndianRed</term><description>IndianRed</description><description>205, 92, 92</description></item><item><term>Color.Indigo</term><description>Indigo</description><description>75, 0, 130</description></item><item><term>Color.Ivory</term><description>Ivory</description><description>255, 255, 240</description></item><item><term>Color.Khaki</term><description>Khaki</description><description>240, 230, 140</description></item><item><term>Color.Lavender</term><description>Lavender</description><description>230, 230, 250</description></item><item><term>Color.LavenderBlush</term><description>LavenderBlush</description><description>255, 240, 245</description></item><item><term>Color.LawnGreen</term><description>LawnGreen</description><description>124, 252, 0</description></item><item><term>Color.LemonChiffon</term><description>LemonChiffon</description><description>255, 250, 205</description></item><item><term>Color.LightBlue</term><description>LightBlue</description><description>173, 216, 230</description></item><item><term>Color.LightCoral</term><description>LightCoral</description><description>240, 128, 128</description></item><item><term>Color.LightCyan</term><description>LightCyan</description><description>224, 255, 255</description></item><item><term>Color.LightGoldenrodYellow</term><description>LightGoldenrodYellow</description><description>250, 250, 210</description></item><item><term>Color.LightGray</term><description>LightGray</description><description>211, 211, 211</description></item><item><term>Color.LightGreen</term><description>LightGreen</description><description>144, 238, 144</description></item><item><term>Color.LightPink</term><description>LightPink</description><description>255, 182, 193</description></item><item><term>Color.LightSalmon</term><description>LightSalmon</description><description>255, 160, 122</description></item><item><term>Color.LightSeaGreen</term><description>LightSeaGreen</description><description>32, 178, 170</description></item><item><term>Color.LightSkyBlue</term><description>LightSkyBlue</description><description>135, 206, 250</description></item><item><term>Color.LightSlateGray</term><description>LightSlateGray</description><description>119, 136, 153</description></item><item><term>Color.LightSteelBlue</term><description>LightSteelBlue</description><description>176, 196, 222</description></item><item><term>Color.LightYellow</term><description>LightYellow</description><description>255, 255, 224</description></item><item><term>Color.LimeGreen</term><description>LimeGreen</description><description>50, 205, 50</description></item><item><term>Color.Linen</term><description>Linen</description><description>250, 240, 230</description></item><item><term>Color.Magenta</term><description>Magenta</description><description>255, 0, 255</description></item><item><term>Color.MediumAquamarine</term><description>MediumAquamarine</description><description>102, 205, 170</description></item><item><term>Color.MediumBlue</term><description>MediumBlue</description><description>0, 0, 205</description></item><item><term>Color.MediumOrchid</term><description>MediumOrchid</description><description>186, 85, 211</description></item><item><term>Color.MediumPurple</term><description>MediumPurple</description><description>147, 112, 219</description></item><item><term>Color.MediumSeaGreen</term><description>MediumSeaGreen</description><description>60, 179, 113</description></item><item><term>Color.MediumSlateBlue</term><description>MediumSlateBlue</description><description>123, 104, 238</description></item><item><term>Color.MediumSpringGreen</term><description>MediumSpringGreen</description><description>0, 250, 154</description></item><item><term>Color.MediumTurquoise</term><description>MediumTurquoise</description><description>72, 209, 204</description></item><item><term>Color.MediumVioletRed</term><description>MediumVioletRed</description><description>199, 21, 133</description></item><item><term>Color.MidnightBlue</term><description>MidnightBlue</description><description>25, 25, 112</description></item><item><term>Color.MintCream</term><description>MintCream</description><description>245, 255, 250</description></item><item><term>Color.MistyRose</term><description>MistyRose</description><description>255, 228, 225</description></item><item><term>Color.Moccasin</term><description>Moccasin</description><description>255, 228, 181</description></item><item><term>Color.NavajoWhite</term><description>NavajoWhite</description><description>255, 222, 173</description></item><item><term>Color.OldLace</term><description>OldLace</description><description>253, 245, 230</description></item><item><term>Color.OliveDrab</term><description>OliveDrab</description><description>107, 142, 35</description></item><item><term>Color.OrangeRed</term><description>OrangeRed</description><description>255, 69, 0</description></item><item><term>Color.Orchid</term><description>Orchid</description><description>218, 112, 214</description></item><item><term>Color.PaleGoldenrod</term><description>PaleGoldenrod</description><description>238, 232, 170</description></item><item><term>Color.PaleGreen</term><description>PaleGreen</description><description>152, 251, 152</description></item><item><term>Color.PaleTurquoise</term><description>PaleTurquoise</description><description>175, 238, 238</description></item><item><term>Color.PaleVioletRed</term><description>PaleVioletRed</description><description>219, 112, 147</description></item><item><term>Color.PapayaWhip</term><description>PapayaWhip</description><description>255, 239, 213</description></item><item><term>Color.PeachPuff</term><description>PeachPuff</description><description>255, 218, 185</description></item><item><term>Color.Peru</term><description>Peru</description><description>205, 133, 63</description></item><item><term>Color.Plum</term><description>Plum</description><description>221, 160, 221</description></item><item><term>Color.PowderBlue</term><description>PowderBlue</description><description>176, 224, 230</description></item><item><term>Color.RosyBrown</term><description>RosyBrown</description><description>188, 143, 143</description></item><item><term>Color.RoyalBlue</term><description>RoyalBlue</description><description>65, 105, 225</description></item><item><term>Color.SaddleBrown</term><description>SaddleBrown</description><description>139, 69, 19</description></item><item><term>Color.Salmon</term><description>Salmon</description><description>250, 128, 114</description></item><item><term>Color.SandyBrown</term><description>SandyBrown</description><description>244, 164, 96</description></item><item><term>Color.SeaGreen</term><description>SeaGreen</description><description>46, 139, 87</description></item><item><term>Color.SeaShell</term><description>SeaShell</description><description>255, 245, 238</description></item><item><term>Color.Sienna</term><description>Sienna</description><description>160, 82, 45</description></item><item><term>Color.SkyBlue</term><description>SkyBlue</description><description>135, 206, 235</description></item><item><term>Color.SlateBlue</term><description>SlateBlue</description><description>106, 90, 205</description></item><item><term>Color.SlateGray</term><description>SlateGray</description><description>112, 128, 144</description></item><item><term>Color.Snow</term><description>Snow</description><description>255, 250, 250</description></item><item><term>Color.SpringGreen</term><description>SpringGreen</description><description>0, 255, 127</description></item><item><term>Color.SteelBlue</term><description>SteelBlue</description><description>70, 130, 180</description></item><item><term>Color.Tan</term><description>Tan</description><description>210, 180, 140</description></item><item><term>Color.Thistle</term><description>Thistle</description><description>216, 191, 216</description></item><item><term>Color.Tomato</term><description>Tomato</description><description>255, 99, 71</description></item><item><term>Color.Turquoise</term><description>Turquoise</description><description>64, 224, 208</description></item><item><term>Color.Violet</term><description>Violet</description><description>238, 130, 238</description></item><item><term>Color.Wheat</term><description>Wheat</description><description>245, 222, 179</description></item><item><term>Color.WhiteSmoke</term><description>WhiteSmoke</description><description>245, 245, 245</description></item><item><term>Color.YellowGreen</term><description>YellowGreen</description><description>154, 205, 50</description></item></list></para> </remarks> </Docs> <Members> 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 @@ <ReturnType>Xamarin.Forms.BindableProperty</ReturnType> </ReturnValue> <Docs> - <summary>Backing store for the <see cref="P:Xamarin.Forms.BaseUrl" /> property.</summary> + <summary>Backing store for the <see cref="P:Xamarin.Forms.Html" /> property.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -144,8 +144,8 @@ <Parameter Name="renderer" Type="Xamarin.Forms.IWebViewDelegate" /> </Parameters> <Docs> - <param name="renderer">To be added.</param> - <summary>To be added.</summary> + <param name="renderer">The renderer into which to load html content.</param> + <summary>Loads the specified <paramref name="renderer" /> with the current base URL and HTML.</summary> <remarks>To be added.</remarks> </Docs> </Member> 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 @@ <summary>A <see cref="T:Xamarin.Forms.VisualElement" /> that occupies the entire screen.</summary> <remarks> <para> - <see cref="T:Xamarin.Forms.Page" /> is primarily a base class for more useful derived types. Objects that are derived from the see <see cref="T:Xamarin.Forms.Page" /> 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 <see cref="N:Xamarin.Forms" />. The contents of a typical App.cs file that would appear in a project that reference <see cref="N:Xamarin.Forms" /> are shown below:</para> - <example> - <code lang="C#"><![CDATA[ -using System; -using Xamarin.Forms; - -namespace MyFirstFormsApp -{ - public class App : Application - { - - public App() - { - MainPage = new ContentPage { - Content = new Label { - Text = "Hello, Forms!", - VerticalOptions = LayoutOptions.CenterAndExpand, - HorizontalOptions = LayoutOptions.CenterAndExpand, - } - }; - } - protected override void OnStart () - { - // Handle when your app starts - } - - protected override void OnSleep () - { - // Handle when your app sleeps - } - - protected override void OnResume () - { - // Handle when your app resumes - } - } -}]]></code> - </example> - <para>While a <see cref="T:Xamarin.Forms.ContentPage" /> object was returned in the example above, note that any class that extends <see cref="T:Xamarin.Forms.Page" /> could have been passed, instead. For example, by using conditional compilation or by checking the platform, the developr can pass a <see cref="T:Xamarin.Forms.CarouselPage" /> to Windows Phone applications, in order to better match the style of the user interface on that platform, while passing <see cref="T:Xamarin.Forms.ContentPage" /> objects or other Page types to the other platforms.</para> - <para>The other projects in the solution that target the Windows Phone, iOS, and Android platforms can call the GetMainPage method to obtain the <see cref="T:Xamarin.Forms.Page" /> 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.</para> - <note>In each platform-specific project, Application developers must call the <c>Xamarin.Forms.Forms.Init()</c> method, with platform-specific parameters, before they get or create any <see cref="N:Xamarin.Forms" /> elements.</note> - <para>Each targeted platform uses the returned page in a different way. The <c>Xamarin.Forms.Platform.iOS</c> library provides <c>Xamarin.Forms.Page.CreateViewController()</c> extension method, which returns a UIViewController that application developers can assign to the <c>UIWindow.RootViewController</c> property of the top-level UI. This code is typically placed inside the <c>UIApplicationDelegate.FinishedLaunching</c> override for the main application class. A typical example is shown below:</para> - <example> - <code lang="C#"> -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; - } - } -} - -</code> - </example> - <para>The Xamarin.Forms.Platform.Android.AndroidActivity class provides the <c>Xamarin.Forms.Platform.Android.AndroidActivity.SetPage</c> method, which performs the work that is necessary to make its page argument the top-level UI element of the <c>Xamarin.Forms.Platform.Android.AndroidActivity</c>. A typical example is shown below:</para> - <example> - <code lang="C#"> -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()); - } - } -} -</code> - </example> - <para>For Windows Phone, <see cref="N:Xamarin.Forms" /> provides an extension method for <see cref="T:Xamarin.Forms.Page" /> that is called <see cref="M:Xamarin.Forms.Page.ConvertPageToUIElement" />. 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:</para> - <example> - <code lang="C#"> -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); - } - } -} </code> - </example> - <para>In addition to their role as the main pages of <see cref="N:Xamarin.Forms" /> applications, <see cref="T:Xamarin.Forms.Page" /> objects and their descendants can be used with navigation classes, such as <see cref="T:Xamarin.Forms.Navigation" /> or <see cref="T:Xamarin.Forms.MasterDetailPage" />, among others, to provide rich user experiences that conform to the expected behaviors on each platform.</para> - <para>XAML for Xamarin.Forms supports the following properties for the <see cref="T:Xamarin.Forms.Page" /> class:</para> - <list type="table"> - <listheader> - <term>Property</term> - <description>Value</description> - </listheader> - <item> - <term>BackgroundImage</term> - <description> - <para>A local file specification that identifies an image.</para> - </description> - </item> - <item> - <term>Icon</term> - <description> - <para>A local file specification that identifies an image.</para> - </description> - </item> - <item> - <term>Padding</term> - <description> - <para>A comma-separated list of 4 integers that represent a <see cref="T:Xamarin.Forms.Thickness" /> structure.</para> - </description> - </item> - <item> - <term>Title</term> - <description> - <para>Text that represents the title of the page.</para> - </description> - </item> - <item> - <term>ToolbarItems</term> - <description> - <para>A list of <c>ToolBarItem</c> elements.</para> - </description> - </item> - </list> + <see cref="T:Xamarin.Forms.Page" /> is primarily a base class for more useful derived types. Objects that are derived from the <see cref="T:Xamarin.Forms.Page" /> 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 <see cref="N:Xamarin.Forms" /> applications, <see cref="T:Xamarin.Forms.Page" /> objects and their descendants can be used with navigation classes, such as <see cref="T:Xamarin.Forms.Navigation" /> or <see cref="T:Xamarin.Forms.MasterDetailPage" />, among others, to provide rich user experiences that conform to the expected behaviors on each platform.</para> </remarks> </Docs> <Members> 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 @@ <param name="widthConstraint">The available width for the element to use.</param> <param name="heightConstraint">The available height for the element to use.</param> <summary>This method is called during the measure pass of a layout cycle to get the desired size of an element.</summary> - <returns>A <see cref="T:Xamarin.Forms.SizeRequest>" /> which contains the desired size of the element.</returns> + <returns>A <see cref="T:Xamarin.Forms.SizeRequest" /> which contains the desired size of the element.</returns> <remarks>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.</remarks> </Docs> </Member> |