diff options
Diffstat (limited to 'docs/Xamarin.Forms.Core/Xamarin.Forms/SwitchCell.xml')
| -rw-r--r-- | docs/Xamarin.Forms.Core/Xamarin.Forms/SwitchCell.xml | 230 |
1 files changed, 230 insertions, 0 deletions
diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/SwitchCell.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/SwitchCell.xml new file mode 100644 index 00000000..3bcf3764 --- /dev/null +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/SwitchCell.xml @@ -0,0 +1,230 @@ +<Type Name="SwitchCell" FullName="Xamarin.Forms.SwitchCell"> + <TypeSignature Language="C#" Value="public class SwitchCell : Xamarin.Forms.Cell" /> + <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit SwitchCell extends Xamarin.Forms.Cell" /> + <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.Cell</BaseTypeName> + </Base> + <Interfaces /> + <Docs> + <summary>A <see cref="T:Xamarin.Forms.Cell" /> with a label and an on/off switch.</summary> + <remarks> + <para>The following example shows a basic use.</para> + <example> + <code lang="C#"><![CDATA[using System; +using Xamarin.Forms; + +namespace FormsGallery +{ + class SwitchCellDemoPage : ContentPage + { + public SwitchCellDemoPage() + { + Label header = new Label + { + Text = "SwitchCell", + FontSize = Device.GetNamedSize (NamedSize.Large, typeof(Label)), + HorizontalOptions = LayoutOptions.Center + }; + + TableView tableView = new TableView + { + Intent = TableIntent.Form, + Root = new TableRoot + { + new TableSection + { + new SwitchCell + { + Text = "SwitchCell:" + } + } + } + }; + + // Accomodate iPhone status bar. + this.Padding = new Thickness(10, Device.OnPlatform(20, 0, 0), 10, 5); + + // Build the page. + this.Content = new StackLayout + { + Children = + { + header, + tableView + } + }; + } + } +}]]></code> + </example> + <para> + <img href="SwitchCell.TripleScreenShot.png" /> + </para> + <para>XAML for Xamarin.Forms supports the following properties for the <see cref="T:Xamarin.Forms.SwitchCell" /> class:</para> + <list type="table"> + <listheader> + <term>Property</term> + <description>Value</description> + </listheader> + <item> + <term>On</term> + <description> + <para> + <c>true</c> or <c>false</c>, to indicate whether the switch cell is in the "on" position.</para> + </description> + </item> + <item> + <term>OnChanged</term> + <description> + <para>The name of an event handler. Note that this tag must appear below <c>On</c>.</para> + </description> + </item> + <item> + <term>Text</term> + <description> + <para>Text that represents the title of the switch cell.</para> + </description> + </item> + </list> + </remarks> + </Docs> + <Members> + <Member MemberName=".ctor"> + <MemberSignature Language="C#" Value="public SwitchCell ();" /> + <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 SwitchCell class.</summary> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="On"> + <MemberSignature Language="C#" Value="public bool On { get; set; }" /> + <MemberSignature Language="ILAsm" Value=".property instance bool On" /> + <MemberType>Property</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>System.Boolean</ReturnType> + </ReturnValue> + <Docs> + <summary>Gets or sets the state of the switch. This is a bindable property.</summary> + <value>Default is <see langword="false" />.</value> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="OnChanged"> + <MemberSignature Language="C#" Value="public event EventHandler<Xamarin.Forms.ToggledEventArgs> OnChanged;" /> + <MemberSignature Language="ILAsm" Value=".event class System.EventHandler`1<class Xamarin.Forms.ToggledEventArgs> OnChanged" /> + <MemberType>Event</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>System.EventHandler<Xamarin.Forms.ToggledEventArgs></ReturnType> + </ReturnValue> + <Docs> + <summary>Triggered when the switch has changed value.</summary> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="OnProperty"> + <MemberSignature Language="C#" Value="public static readonly Xamarin.Forms.BindableProperty OnProperty;" /> + <MemberSignature Language="ILAsm" Value=".field public static initonly class Xamarin.Forms.BindableProperty OnProperty" /> + <MemberType>Field</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.BindableProperty</ReturnType> + </ReturnValue> + <Docs> + <summary>Identifies the <see cref="P:Xamarin.Forms.SwitchCell.On" /> bindable property.</summary> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="Text"> + <MemberSignature Language="C#" Value="public string Text { get; set; }" /> + <MemberSignature Language="ILAsm" Value=".property instance string Text" /> + <MemberType>Property</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>System.String</ReturnType> + </ReturnValue> + <Docs> + <summary>Gets or sets the text displayed next to the switch. This is a bindable property.</summary> + <value> + </value> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="TextProperty"> + <MemberSignature Language="C#" Value="public static readonly Xamarin.Forms.BindableProperty TextProperty;" /> + <MemberSignature Language="ILAsm" Value=".field public static initonly class Xamarin.Forms.BindableProperty TextProperty" /> + <MemberType>Field</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.BindableProperty</ReturnType> + </ReturnValue> + <Docs> + <summary>Identifies the Text bindable property.</summary> + <remarks>To be added.</remarks> + </Docs> + </Member> + </Members> +</Type> |