diff options
Diffstat (limited to 'docs/Xamarin.Forms.Core/Xamarin.Forms/Switch.xml')
| -rw-r--r-- | docs/Xamarin.Forms.Core/Xamarin.Forms/Switch.xml | 193 |
1 files changed, 193 insertions, 0 deletions
diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/Switch.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/Switch.xml new file mode 100644 index 00000000..71bd528d --- /dev/null +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/Switch.xml @@ -0,0 +1,193 @@ +<Type Name="Switch" FullName="Xamarin.Forms.Switch"> + <TypeSignature Language="C#" Value="public class Switch : Xamarin.Forms.View" /> + <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit Switch extends Xamarin.Forms.View" /> + <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.View</BaseTypeName> + </Base> + <Interfaces /> + <Attributes> + <Attribute> + <AttributeName>Xamarin.Forms.RenderWith(typeof(Xamarin.Forms.Platform._SwitchRenderer))</AttributeName> + </Attribute> + </Attributes> + <Docs> + <summary>A <see cref="T:Xamarin.Forms.View" /> control that provides a toggled value.</summary> + <remarks> + <para>The following example describes a basic use.</para> + <example> + <code lang="C#"><![CDATA[using System; +using Xamarin.Forms; + +namespace FormsGallery +{ + class SwitchDemoPage : ContentPage + { + Label label; + + public SwitchDemoPage() + { + Label header = new Label + { + Text = "Switch", + FontSize = Device.GetNamedSize (NamedSize.Large, typeof(Label)), + HorizontalOptions = LayoutOptions.Center + }; + + Switch switcher = new Switch + { + HorizontalOptions = LayoutOptions.Center, + VerticalOptions = LayoutOptions.CenterAndExpand + }; + switcher.Toggled += switcher_Toggled; + + label = new Label + { + Text = "Switch is now False", + FontSize = Device.GetNamedSize (NamedSize.Large, typeof(Label)), + HorizontalOptions = LayoutOptions.Center, + VerticalOptions = LayoutOptions.CenterAndExpand + }; + + // 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, + switcher, + label + } + }; + } + + void switcher_Toggled(object sender, ToggledEventArgs e) + { + label.Text = String.Format("Switch is now {0}", e.Value); + } + } +}]]></code> + </example> + <para> + <img href="Switch.TripleScreenShot.png" /> + </para> + <para>XAML for Xamarin.Forms supports the following properties for the <see cref="T:Xamarin.Forms.Switch" /> class:</para> + <list type="table"> + <listheader> + <term>Property</term> + <description>Value</description> + </listheader> + <item> + <term>IsToggled</term> + <description> + <para> + <c>true</c> or <c>false</c>, to indicate whether the switch has been toggled.</para> + </description> + </item> + <item> + <term>Toggled</term> + <description> + <para>The name of an event handler. Note that this tag must appear below <c>IsToggled</c>.</para> + </description> + </item> + </list> + </remarks> + </Docs> + <Members> + <Member MemberName=".ctor"> + <MemberSignature Language="C#" Value="public Switch ();" /> + <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>Creates a new <see cref="T:Xamarin.Forms.Switch" /> element with default values.</summary> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="IsToggled"> + <MemberSignature Language="C#" Value="public bool IsToggled { get; set; }" /> + <MemberSignature Language="ILAsm" Value=".property instance bool IsToggled" /> + <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 a Boolean value that indicates whether this <see cref="T:Xamarin.Forms.Switch" /> element is toggled.</summary> + <value>To be added.</value> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="IsToggledProperty"> + <MemberSignature Language="C#" Value="public static readonly Xamarin.Forms.BindableProperty IsToggledProperty;" /> + <MemberSignature Language="ILAsm" Value=".field public static initonly class Xamarin.Forms.BindableProperty IsToggledProperty" /> + <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>Backing store for the <see cref="P:Xamarin.Forms.Switch.IsToggled" /> property.</summary> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="Toggled"> + <MemberSignature Language="C#" Value="public event EventHandler<Xamarin.Forms.ToggledEventArgs> Toggled;" /> + <MemberSignature Language="ILAsm" Value=".event class System.EventHandler`1<class Xamarin.Forms.ToggledEventArgs> Toggled" /> + <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>Event that is raised when this <see cref="T:Xamarin.Forms.Switch" /> is toggled.</summary> + <remarks>To be added.</remarks> + </Docs> + </Member> + </Members> +</Type> |