summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--docs/Xamarin.Forms.Core/Xamarin.Forms/CarouselPage.xml134
1 files changed, 134 insertions, 0 deletions
diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/CarouselPage.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/CarouselPage.xml
new file mode 100644
index 0000000..4b72572
--- /dev/null
+++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/CarouselPage.xml
@@ -0,0 +1,134 @@
+<Type Name="CarouselPage" FullName="Xamarin.Forms.CarouselPage">
+ <TypeSignature Language="C#" Value="public class CarouselPage : Xamarin.Forms.MultiPage&lt;Xamarin.Forms.ContentPage&gt;" />
+ <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit CarouselPage extends Xamarin.Forms.MultiPage`1&lt;class Xamarin.Forms.ContentPage&gt;" />
+ <AssemblyInfo>
+ <AssemblyName>Xamarin.Forms.Core</AssemblyName>
+ <AssemblyVersion>1.0.0.0</AssemblyVersion>
+ <AssemblyVersion>1.1.0.0</AssemblyVersion>
+ <AssemblyVersion>1.2.0.0</AssemblyVersion>
+ <AssemblyVersion>1.3.0.0</AssemblyVersion>
+ <AssemblyVersion>1.4.0.0</AssemblyVersion>
+ <AssemblyVersion>1.5.0.0</AssemblyVersion>
+ <AssemblyVersion>2.0.0.0</AssemblyVersion>
+ </AssemblyInfo>
+ <Base>
+ <BaseTypeName>Xamarin.Forms.MultiPage&lt;Xamarin.Forms.ContentPage&gt;</BaseTypeName>
+ <BaseTypeArguments>
+ <BaseTypeArgument TypeParamName="T">Xamarin.Forms.ContentPage</BaseTypeArgument>
+ </BaseTypeArguments>
+ </Base>
+ <Interfaces />
+ <Attributes>
+ <Attribute>
+ <AttributeName>Xamarin.Forms.RenderWith(typeof(Xamarin.Forms.Platform._CarouselPageRenderer))</AttributeName>
+ </Attribute>
+ </Attributes>
+ <Docs>
+ <summary>A Page that users can swipe from side to side to display pages of content, like a gallery.</summary>
+ <remarks>
+ <para>The <see cref="T:Xamarin.Forms.CarouselPage" /> provides a navigation experience that will feel natural and familiar to Windows Phone users. By using <see cref="M:Xamarin.Forms.Device.OnPlatform" />, application developers can provide customized navigation on a per-platform basis. For example, an application developer could use a <see cref="T:Xamarin.Forms.NavigationPage" /> for Android and iOS, and use a <see cref="T:Xamarin.Forms.CarouselPage" /> on Windows Phone.</para>
+ <example>
+ <para>The following XAML example, when properly included and referenced in a Xamarin.Forms project, creates a <see cref="T:Xamarin.Forms.CarouselPage" /> that displays three simple <see cref="T:Xamarin.Forms.ContentPage" /> elements:
+ </para>
+ <code lang="XAML"><![CDATA[<?xml version="1.0" encoding="UTF-8"?>
+<CarouselPage xmlns="http://xamarin.com/schemas/2014/forms" xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml" x:Class="XamlExample1.MyPage">
+ <ContentPage>
+ <StackLayout>
+ <Label Text="Red" />
+ <BoxView Color="Red" VerticalOptions="FillAndExpand" />
+ </StackLayout>
+ </ContentPage>
+ <ContentPage>
+ <StackLayout>
+ <Label Text="Green" />
+ <BoxView Color="Green" VerticalOptions="FillAndExpand" />
+ </StackLayout>
+ </ContentPage>
+ <ContentPage>
+ <StackLayout>
+ <Label Text="Blue" />
+ <BoxView Color="Blue" VerticalOptions="FillAndExpand" />
+ </StackLayout>
+ </ContentPage>
+</CarouselPage>]]></code>
+ </example>
+ <example>
+ <para>The following C# example creates a <see cref="T:Xamarin.Forms.CarouselPage" /> that displays three simple <see cref="T:Xamarin.Forms.ContentPage" /> elements:</para>
+ <code lang="C#"><![CDATA[
+List<ContentPage> pages = new List<ContentPage> (0);
+Color[] colors = { Color.Red, Color.Green, Color.Blue };
+foreach (Color c in colors) {
+ pages.Add (new ContentPage { Content = new StackLayout {
+ Children = {
+ new Label { Text = c.ToString () },
+ new BoxView {
+ Color = c,
+ VerticalOptions = LayoutOptions.FillAndExpand
+ }
+ }
+ }
+ });
+}
+
+MainPage = new CarouselPage {
+ Children = { pages [0],
+ pages [1],
+ pages [2] }
+};
+]]></code>
+ </example>
+ <block subset="none" type="note">When embedding a CarouselPage into a <see cref="P:Xamarin.Forms.MasterDetailPage.Detail" />, application developers should set <see cref="P:Xamarin.Forms.MasterDetailPage.IsGestureEnabled" /> to <see langword="false" /> to prevent gesture conflicts between the CarouselPage and MasterDetailPage.</block>
+ <para>
+ <img href="CarouselPage.TripleScreenShot.png" />
+ </para>
+ </remarks>
+ </Docs>
+ <Members>
+ <Member MemberName=".ctor">
+ <MemberSignature Language="C#" Value="public CarouselPage ();" />
+ <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
+ <MemberType>Constructor</MemberType>
+ <AssemblyInfo>
+ <AssemblyVersion>1.0.0.0</AssemblyVersion>
+ <AssemblyVersion>1.1.0.0</AssemblyVersion>
+ <AssemblyVersion>1.2.0.0</AssemblyVersion>
+ <AssemblyVersion>1.3.0.0</AssemblyVersion>
+ <AssemblyVersion>1.4.0.0</AssemblyVersion>
+ <AssemblyVersion>1.5.0.0</AssemblyVersion>
+ <AssemblyVersion>2.0.0.0</AssemblyVersion>
+ </AssemblyInfo>
+ <Parameters />
+ <Docs>
+ <summary>Initializes a new instance of the CarouselPage class.</summary>
+ <remarks>
+ </remarks>
+ </Docs>
+ </Member>
+ <Member MemberName="CreateDefault">
+ <MemberSignature Language="C#" Value="protected override Xamarin.Forms.ContentPage CreateDefault (object item);" />
+ <MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance class Xamarin.Forms.ContentPage CreateDefault(object item) cil managed" />
+ <MemberType>Method</MemberType>
+ <AssemblyInfo>
+ <AssemblyVersion>1.0.0.0</AssemblyVersion>
+ <AssemblyVersion>1.1.0.0</AssemblyVersion>
+ <AssemblyVersion>1.2.0.0</AssemblyVersion>
+ <AssemblyVersion>1.3.0.0</AssemblyVersion>
+ <AssemblyVersion>1.4.0.0</AssemblyVersion>
+ <AssemblyVersion>1.5.0.0</AssemblyVersion>
+ <AssemblyVersion>2.0.0.0</AssemblyVersion>
+ </AssemblyInfo>
+ <ReturnValue>
+ <ReturnType>Xamarin.Forms.ContentPage</ReturnType>
+ </ReturnValue>
+ <Parameters>
+ <Parameter Name="item" Type="System.Object" />
+ </Parameters>
+ <Docs>
+ <param name="item">The object representing the model ofr the page.</param>
+ <summary>Creates a default page, suitable for display in <c>this</c><see cref="T:Xamarin.Forms.CarouselPage" />, for an object.</summary>
+ <returns>A page that is titled with the string value of <paramref name="item" />.</returns>
+ <remarks>This returns a new <see cref="T:Xamarin.Forms.Page" /> object that has its <see cref="P:Xamarin.Forms.Page.Title" /> property set to the value of <see cref="M:Object.ToString" /> when called on <paramref name="item" />.</remarks>
+ </Docs>
+ </Member>
+ </Members>
+</Type>