diff options
Diffstat (limited to 'docs/Xamarin.Forms.Core/Xamarin.Forms/Stepper.xml')
| -rw-r--r-- | docs/Xamarin.Forms.Core/Xamarin.Forms/Stepper.xml | 371 |
1 files changed, 371 insertions, 0 deletions
diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/Stepper.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/Stepper.xml new file mode 100644 index 00000000..2aae02bb --- /dev/null +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/Stepper.xml @@ -0,0 +1,371 @@ +<Type Name="Stepper" FullName="Xamarin.Forms.Stepper"> + <TypeSignature Language="C#" Value="public class Stepper : Xamarin.Forms.View" /> + <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit Stepper 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._StepperRenderer))</AttributeName> + </Attribute> + </Attributes> + <Docs> + <summary>A <see cref="T:Xamarin.Forms.View" /> control that inputs a discrete value, constrained to a range.</summary> + <remarks> + <para>The following example shows a basic use.</para> + <example> + <code lang="C#"><![CDATA[using System; + using System; + using Xamarin.Forms; + + namespace FormsGallery + { + class StepperDemoPage : ContentPage + { + Label label; + + public StepperDemoPage() + { + Label header = new Label + { + Text = "Stepper", + FontSize = Device.GetNamedSize (NamedSize.Large, typeof(Label)), + HorizontalOptions = LayoutOptions.Center + }; + + Stepper stepper = new Stepper + { + Value = 5, + Minimum = 0, + Maximum = 10, + Increment = 0.1, + HorizontalOptions = LayoutOptions.Center, + VerticalOptions = LayoutOptions.CenterAndExpand + }; + stepper.ValueChanged += OnStepperValueChanged; + + label = new Label + { + Text = String.Format("Stepper value is {0:F1}", stepper.Value), + 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, + stepper, + label + } + }; + } + + void OnStepperValueChanged(object sender, ValueChangedEventArgs e) + { + label.Text = String.Format("Stepper value is {0:F1}", e.NewValue); + } + } + }]]></code> + </example> + <para> + <img href="Stepper.TripleScreenShot.png" /> + </para> + <para>XAML for Xamarin.Forms supports the following properties for the <see cref="T:Xamarin.Forms.Stepper" /> class:</para> + <list type="table"> + <listheader> + <term>Property</term> + <description>Value</description> + </listheader> + <item> + <term>Increment</term> + <description> + <para>An integer or decimal literal.</para> + </description> + </item> + <item> + <term>Maximum</term> + <description> + <para>An integer or decimal literal.</para> + </description> + </item> + <item> + <term>Minimum</term> + <description> + <para>An integer or decimal literal. If this value is nonnegative, it must appear lexically below <c>Maximum</c>, so that validation can succeed.</para> + </description> + </item> + <item> + <term>Value</term> + <description> + <para>An integer or decimal literal that represents a number that is in the range [<c>Minimum</c>,<c>Maximum</c>].</para> + </description> + </item> + <item> + <term>ValueChanged</term> + <description>The name of an event handler. Note that this tag must appear below <c>Value</c>.</description> + </item> + </list> + </remarks> + </Docs> + <Members> + <Member MemberName=".ctor"> + <MemberSignature Language="C#" Value="public Stepper ();" /> + <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 Stepper class.</summary> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName=".ctor"> + <MemberSignature Language="C#" Value="public Stepper (double min, double max, double val, double increment);" /> + <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(float64 min, float64 max, float64 val, float64 increment) 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> + <Parameter Name="min" Type="System.Double" /> + <Parameter Name="max" Type="System.Double" /> + <Parameter Name="val" Type="System.Double" /> + <Parameter Name="increment" Type="System.Double" /> + </Parameters> + <Docs> + <param name="min">The minimum selectable value.</param> + <param name="max">The maximum selectable value.</param> + <param name="val">The current selected value.</param> + <param name="increment">The increment by which Value is increased or decreased.</param> + <summary>Initializes a new instance of the Stepper class.</summary> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="Increment"> + <MemberSignature Language="C#" Value="public double Increment { get; set; }" /> + <MemberSignature Language="ILAsm" Value=".property instance float64 Increment" /> + <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.Double</ReturnType> + </ReturnValue> + <Docs> + <summary>Gets or sets the increment by which Value is increased or decreased. This is a bindable property.</summary> + <value>A double.</value> + <remarks> + </remarks> + </Docs> + </Member> + <Member MemberName="IncrementProperty"> + <MemberSignature Language="C#" Value="public static readonly Xamarin.Forms.BindableProperty IncrementProperty;" /> + <MemberSignature Language="ILAsm" Value=".field public static initonly class Xamarin.Forms.BindableProperty IncrementProperty" /> + <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 Increment bindable property.</summary> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="Maximum"> + <MemberSignature Language="C#" Value="public double Maximum { get; set; }" /> + <MemberSignature Language="ILAsm" Value=".property instance float64 Maximum" /> + <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.Double</ReturnType> + </ReturnValue> + <Docs> + <summary>Gets or sets the maximum selectable value. This is a bindable property.</summary> + <value>A double.</value> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="MaximumProperty"> + <MemberSignature Language="C#" Value="public static readonly Xamarin.Forms.BindableProperty MaximumProperty;" /> + <MemberSignature Language="ILAsm" Value=".field public static initonly class Xamarin.Forms.BindableProperty MaximumProperty" /> + <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 Maximum bindable property.</summary> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="Minimum"> + <MemberSignature Language="C#" Value="public double Minimum { get; set; }" /> + <MemberSignature Language="ILAsm" Value=".property instance float64 Minimum" /> + <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.Double</ReturnType> + </ReturnValue> + <Docs> + <summary>Gets or sets the minimum selectabel value. This is a bindable property.</summary> + <value>A double.</value> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="MinimumProperty"> + <MemberSignature Language="C#" Value="public static readonly Xamarin.Forms.BindableProperty MinimumProperty;" /> + <MemberSignature Language="ILAsm" Value=".field public static initonly class Xamarin.Forms.BindableProperty MinimumProperty" /> + <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 Minimum bindable property.</summary> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="Value"> + <MemberSignature Language="C#" Value="public double Value { get; set; }" /> + <MemberSignature Language="ILAsm" Value=".property instance float64 Value" /> + <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.Double</ReturnType> + </ReturnValue> + <Docs> + <summary>Gets or sets the current value. This is a bindable property.</summary> + <value>A double.</value> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="ValueChanged"> + <MemberSignature Language="C#" Value="public event EventHandler<Xamarin.Forms.ValueChangedEventArgs> ValueChanged;" /> + <MemberSignature Language="ILAsm" Value=".event class System.EventHandler`1<class Xamarin.Forms.ValueChangedEventArgs> ValueChanged" /> + <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.ValueChangedEventArgs></ReturnType> + </ReturnValue> + <Docs> + <summary>Raised when the <see cref="P:Xamarin.Forms.Stepper.Value" /> property changes.</summary> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="ValueProperty"> + <MemberSignature Language="C#" Value="public static readonly Xamarin.Forms.BindableProperty ValueProperty;" /> + <MemberSignature Language="ILAsm" Value=".field public static initonly class Xamarin.Forms.BindableProperty ValueProperty" /> + <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 Value bindable property.</summary> + <remarks>To be added.</remarks> + </Docs> + </Member> + </Members> +</Type> |