diff options
Diffstat (limited to 'docs/Xamarin.Forms.Core/Xamarin.Forms/ProgressBar.xml')
| -rw-r--r-- | docs/Xamarin.Forms.Core/Xamarin.Forms/ProgressBar.xml | 156 |
1 files changed, 156 insertions, 0 deletions
diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/ProgressBar.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/ProgressBar.xml new file mode 100644 index 00000000..ed9cc2b8 --- /dev/null +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/ProgressBar.xml @@ -0,0 +1,156 @@ +<Type Name="ProgressBar" FullName="Xamarin.Forms.ProgressBar"> + <TypeSignature Language="C#" Value="public class ProgressBar : Xamarin.Forms.View" /> + <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ProgressBar 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._ProgressBarRenderer))</AttributeName> + </Attribute> + </Attributes> + <Docs> + <summary>A <see cref="T:Xamarin.Forms.View" /> control that displays progress.</summary> + <remarks> + <para>The following example shows the usage of a ProgressBar.</para> + <example> + <code lang="C#"><![CDATA[ + +//initial progress is 20% +var progressBar = new ProgressBar { + Progress = .2, +}; + +// animate the progression to 80%, in 250ms +await progressBar.ProgressTo (.8, 250, Easing.Linear); + +Debug.WriteLine ("Animation completed"); +]]></code> + </example> + <para> + <img href="ProgressBar.TripleScreenShot.png" /> + </para> + <para>XAML for Xamarin.Forms supports the following property for the <see cref="T:Xamarin.Forms.ProgressBar" /> class:</para> + <list type="table"> + <listheader> + <term>Property</term> + <description>Value</description> + </listheader> + <item> + <term>Progress</term> + <description> + <para>A decimal value between 0 and 1, inclusive, that specifies the fraction of the bar that is colored.</para> + </description> + </item> + </list> + </remarks> + </Docs> + <Members> + <Member MemberName=".ctor"> + <MemberSignature Language="C#" Value="public ProgressBar ();" /> + <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 ProgressBar class</summary> + <remarks> + </remarks> + </Docs> + </Member> + <Member MemberName="Progress"> + <MemberSignature Language="C#" Value="public double Progress { get; set; }" /> + <MemberSignature Language="ILAsm" Value=".property instance float64 Progress" /> + <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 progress value. This is s bindable property.</summary> + <value>Gets or sets a value that specifies the fraction of the bar that is colored.</value> + <remarks>Values less than 0 or larger than 1 will be clamped to the range [0-1].</remarks> + </Docs> + </Member> + <Member MemberName="ProgressProperty"> + <MemberSignature Language="C#" Value="public static readonly Xamarin.Forms.BindableProperty ProgressProperty;" /> + <MemberSignature Language="ILAsm" Value=".field public static initonly class Xamarin.Forms.BindableProperty ProgressProperty" /> + <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 Progress bindable property.</summary> + <remarks> + </remarks> + </Docs> + </Member> + <Member MemberName="ProgressTo"> + <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<bool> ProgressTo (double value, uint length, Xamarin.Forms.Easing easing);" /> + <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task`1<bool> ProgressTo(float64 value, unsigned int32 length, class Xamarin.Forms.Easing easing) 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>System.Threading.Tasks.Task<System.Boolean></ReturnType> + </ReturnValue> + <Parameters> + <Parameter Name="value" Type="System.Double" /> + <Parameter Name="length" Type="System.UInt32" /> + <Parameter Name="easing" Type="Xamarin.Forms.Easing" /> + </Parameters> + <Docs> + <param name="value">To be added.</param> + <param name="length">To be added.</param> + <param name="easing">To be added.</param> + <summary>Animate the Progress property to value.</summary> + <returns>A Task<bool> you can await on.</returns> + <remarks> + </remarks> + </Docs> + </Member> + </Members> +</Type> |