summaryrefslogtreecommitdiff
path: root/docs/Xamarin.Forms.Core/Xamarin.Forms/ViewExtensions.xml
diff options
context:
space:
mode:
Diffstat (limited to 'docs/Xamarin.Forms.Core/Xamarin.Forms/ViewExtensions.xml')
-rw-r--r--docs/Xamarin.Forms.Core/Xamarin.Forms/ViewExtensions.xml338
1 files changed, 338 insertions, 0 deletions
diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/ViewExtensions.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/ViewExtensions.xml
new file mode 100644
index 00000000..1ea4b51f
--- /dev/null
+++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/ViewExtensions.xml
@@ -0,0 +1,338 @@
+<Type Name="ViewExtensions" FullName="Xamarin.Forms.ViewExtensions">
+ <TypeSignature Language="C#" Value="public static class ViewExtensions" />
+ <TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit ViewExtensions extends System.Object" />
+ <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>System.Object</BaseTypeName>
+ </Base>
+ <Interfaces />
+ <Docs>
+ <summary>Extension methods for <see cref="T:Xamarin.Forms.View" />s, providing animatable scaling, rotation, and layout functions.</summary>
+ <remarks>To be added.</remarks>
+ </Docs>
+ <Members>
+ <Member MemberName="CancelAnimations">
+ <MemberSignature Language="C#" Value="public static void CancelAnimations (Xamarin.Forms.VisualElement view);" />
+ <MemberSignature Language="ILAsm" Value=".method public static hidebysig void CancelAnimations(class Xamarin.Forms.VisualElement view) 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.Void</ReturnType>
+ </ReturnValue>
+ <Parameters>
+ <Parameter Name="view" Type="Xamarin.Forms.VisualElement" />
+ </Parameters>
+ <Docs>
+ <param name="view">To be added.</param>
+ <summary>Aborts the TranslateTo, LayoutTo, RotateTo, ScaleTo, and FadeTo animations on <paramref name="view" /> element.</summary>
+ <remarks>To be added.</remarks>
+ </Docs>
+ </Member>
+ <Member MemberName="FadeTo">
+ <MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task&lt;bool&gt; FadeTo (this Xamarin.Forms.VisualElement view, double opacity, uint length = 250, Xamarin.Forms.Easing easing = null);" />
+ <MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task`1&lt;bool&gt; FadeTo(class Xamarin.Forms.VisualElement view, float64 opacity, 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&lt;System.Boolean&gt;</ReturnType>
+ </ReturnValue>
+ <Parameters>
+ <Parameter Name="view" Type="Xamarin.Forms.VisualElement" RefType="this" />
+ <Parameter Name="opacity" Type="System.Double" />
+ <Parameter Name="length" Type="System.UInt32" />
+ <Parameter Name="easing" Type="Xamarin.Forms.Easing" />
+ </Parameters>
+ <Docs>
+ <param name="view">To be added.</param>
+ <param name="opacity">To be added.</param>
+ <param name="length">To be added.</param>
+ <param name="easing">To be added.</param>
+ <summary>Returns a task that performs the fade that is described by the <paramref name="opacity" />, <paramref name="length" />, and <paramref name="easing" /> parameters.</summary>
+ <returns>To be added.</returns>
+ <remarks>To be added.</remarks>
+ </Docs>
+ </Member>
+ <Member MemberName="LayoutTo">
+ <MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task&lt;bool&gt; LayoutTo (this Xamarin.Forms.VisualElement view, Xamarin.Forms.Rectangle bounds, uint length = 250, Xamarin.Forms.Easing easing = null);" />
+ <MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task`1&lt;bool&gt; LayoutTo(class Xamarin.Forms.VisualElement view, valuetype Xamarin.Forms.Rectangle bounds, 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&lt;System.Boolean&gt;</ReturnType>
+ </ReturnValue>
+ <Parameters>
+ <Parameter Name="view" Type="Xamarin.Forms.VisualElement" RefType="this" />
+ <Parameter Name="bounds" Type="Xamarin.Forms.Rectangle" />
+ <Parameter Name="length" Type="System.UInt32" />
+ <Parameter Name="easing" Type="Xamarin.Forms.Easing" />
+ </Parameters>
+ <Docs>
+ <param name="view">To be added.</param>
+ <param name="bounds">To be added.</param>
+ <param name="length">To be added.</param>
+ <param name="easing">To be added.</param>
+ <summary>Returns a task that eases the bounds of the <see cref="T:Xamarin.Forms.VisualElement" /> that is specified by the <paramref name="view" /> to the rectangle that is specified by the <paramref name="bounds" /> parameter.</summary>
+ <returns>To be added.</returns>
+ <remarks>To be added.</remarks>
+ </Docs>
+ </Member>
+ <Member MemberName="RelRotateTo">
+ <MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task&lt;bool&gt; RelRotateTo (this Xamarin.Forms.VisualElement view, double drotation, uint length = 250, Xamarin.Forms.Easing easing = null);" />
+ <MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task`1&lt;bool&gt; RelRotateTo(class Xamarin.Forms.VisualElement view, float64 drotation, 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&lt;System.Boolean&gt;</ReturnType>
+ </ReturnValue>
+ <Parameters>
+ <Parameter Name="view" Type="Xamarin.Forms.VisualElement" RefType="this" />
+ <Parameter Name="drotation" Type="System.Double" />
+ <Parameter Name="length" Type="System.UInt32" />
+ <Parameter Name="easing" Type="Xamarin.Forms.Easing" />
+ </Parameters>
+ <Docs>
+ <param name="view">To be added.</param>
+ <param name="drotation">To be added.</param>
+ <param name="length">To be added.</param>
+ <param name="easing">To be added.</param>
+ <summary>Rotates the <see cref="T:Xamarin.Forms.VisualElement" /> that is specified by <paramref name="view" /> from its current rotation by <paramref name="drotation" />.</summary>
+ <returns>To be added.</returns>
+ <remarks>To be added.</remarks>
+ </Docs>
+ </Member>
+ <Member MemberName="RelScaleTo">
+ <MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task&lt;bool&gt; RelScaleTo (this Xamarin.Forms.VisualElement view, double dscale, uint length = 250, Xamarin.Forms.Easing easing = null);" />
+ <MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task`1&lt;bool&gt; RelScaleTo(class Xamarin.Forms.VisualElement view, float64 dscale, 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&lt;System.Boolean&gt;</ReturnType>
+ </ReturnValue>
+ <Parameters>
+ <Parameter Name="view" Type="Xamarin.Forms.VisualElement" RefType="this" />
+ <Parameter Name="dscale" Type="System.Double" />
+ <Parameter Name="length" Type="System.UInt32" />
+ <Parameter Name="easing" Type="Xamarin.Forms.Easing" />
+ </Parameters>
+ <Docs>
+ <param name="view">To be added.</param>
+ <param name="dscale">To be added.</param>
+ <param name="length">To be added.</param>
+ <param name="easing">To be added.</param>
+ <summary>Returns a task that scales the <see cref="T:Xamarin.Forms.VisualElement" /> that is specified by <paramref name="view" /> from its current scale to <paramref name="dscale" />.</summary>
+ <returns>To be added.</returns>
+ <remarks>To be added.</remarks>
+ </Docs>
+ </Member>
+ <Member MemberName="RotateTo">
+ <MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task&lt;bool&gt; RotateTo (this Xamarin.Forms.VisualElement view, double rotation, uint length = 250, Xamarin.Forms.Easing easing = null);" />
+ <MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task`1&lt;bool&gt; RotateTo(class Xamarin.Forms.VisualElement view, float64 rotation, 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&lt;System.Boolean&gt;</ReturnType>
+ </ReturnValue>
+ <Parameters>
+ <Parameter Name="view" Type="Xamarin.Forms.VisualElement" RefType="this" />
+ <Parameter Name="rotation" Type="System.Double" />
+ <Parameter Name="length" Type="System.UInt32" />
+ <Parameter Name="easing" Type="Xamarin.Forms.Easing" />
+ </Parameters>
+ <Docs>
+ <param name="view">To be added.</param>
+ <param name="rotation">To be added.</param>
+ <param name="length">To be added.</param>
+ <param name="easing">To be added.</param>
+ <summary>Returns a task that performs the rotation that is described by the <paramref name="rotation" />, <paramref name="length" />, and <paramref name="easing" /> parameters..</summary>
+ <returns>To be added.</returns>
+ <remarks>To be added.</remarks>
+ </Docs>
+ </Member>
+ <Member MemberName="RotateXTo">
+ <MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task&lt;bool&gt; RotateXTo (this Xamarin.Forms.VisualElement view, double rotation, uint length = 250, Xamarin.Forms.Easing easing = null);" />
+ <MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task`1&lt;bool&gt; RotateXTo(class Xamarin.Forms.VisualElement view, float64 rotation, 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&lt;System.Boolean&gt;</ReturnType>
+ </ReturnValue>
+ <Parameters>
+ <Parameter Name="view" Type="Xamarin.Forms.VisualElement" RefType="this" />
+ <Parameter Name="rotation" Type="System.Double" />
+ <Parameter Name="length" Type="System.UInt32" />
+ <Parameter Name="easing" Type="Xamarin.Forms.Easing" />
+ </Parameters>
+ <Docs>
+ <param name="view">To be added.</param>
+ <param name="rotation">To be added.</param>
+ <param name="length">To be added.</param>
+ <param name="easing">To be added.</param>
+ <summary>Returns a task that skews the Y axis by <paramref name="opacity" />, taking time <paramref name="length" /> and using <paramref name="easing" />.</summary>
+ <returns>To be added.</returns>
+ <remarks>To be added.</remarks>
+ </Docs>
+ </Member>
+ <Member MemberName="RotateYTo">
+ <MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task&lt;bool&gt; RotateYTo (this Xamarin.Forms.VisualElement view, double rotation, uint length = 250, Xamarin.Forms.Easing easing = null);" />
+ <MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task`1&lt;bool&gt; RotateYTo(class Xamarin.Forms.VisualElement view, float64 rotation, 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&lt;System.Boolean&gt;</ReturnType>
+ </ReturnValue>
+ <Parameters>
+ <Parameter Name="view" Type="Xamarin.Forms.VisualElement" RefType="this" />
+ <Parameter Name="rotation" Type="System.Double" />
+ <Parameter Name="length" Type="System.UInt32" />
+ <Parameter Name="easing" Type="Xamarin.Forms.Easing" />
+ </Parameters>
+ <Docs>
+ <param name="view">To be added.</param>
+ <param name="rotation">To be added.</param>
+ <param name="length">To be added.</param>
+ <param name="easing">To be added.</param>
+ <summary>Returns a task that skews the X axis by <paramref name="opacity" />, taking time <paramref name="length" /> and using <paramref name="easing" />.</summary>
+ <returns>To be added.</returns>
+ <remarks>To be added.</remarks>
+ </Docs>
+ </Member>
+ <Member MemberName="ScaleTo">
+ <MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task&lt;bool&gt; ScaleTo (this Xamarin.Forms.VisualElement view, double scale, uint length = 250, Xamarin.Forms.Easing easing = null);" />
+ <MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task`1&lt;bool&gt; ScaleTo(class Xamarin.Forms.VisualElement view, float64 scale, 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&lt;System.Boolean&gt;</ReturnType>
+ </ReturnValue>
+ <Parameters>
+ <Parameter Name="view" Type="Xamarin.Forms.VisualElement" RefType="this" />
+ <Parameter Name="scale" Type="System.Double" />
+ <Parameter Name="length" Type="System.UInt32" />
+ <Parameter Name="easing" Type="Xamarin.Forms.Easing" />
+ </Parameters>
+ <Docs>
+ <param name="view">To be added.</param>
+ <param name="scale">To be added.</param>
+ <param name="length">To be added.</param>
+ <param name="easing">To be added.</param>
+ <summary>Returns a task that scales the <see cref="T:Xamarin.Forms.VisualElement" /> that is specified by <paramref name="view" /> to the absolute scale factor <paramref name="scale" />.</summary>
+ <returns>To be added.</returns>
+ <remarks>To be added.</remarks>
+ </Docs>
+ </Member>
+ <Member MemberName="TranslateTo">
+ <MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task&lt;bool&gt; TranslateTo (this Xamarin.Forms.VisualElement view, double x, double y, uint length = 250, Xamarin.Forms.Easing easing = null);" />
+ <MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task`1&lt;bool&gt; TranslateTo(class Xamarin.Forms.VisualElement view, float64 x, float64 y, unsigned int32 length, class Xamarin.Forms.Easing easing) cil managed" />
+ <MemberType>Method</MemberType>
+ <AssemblyInfo>
+ <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&lt;System.Boolean&gt;</ReturnType>
+ </ReturnValue>
+ <Parameters>
+ <Parameter Name="view" Type="Xamarin.Forms.VisualElement" RefType="this" />
+ <Parameter Name="x" Type="System.Double" />
+ <Parameter Name="y" Type="System.Double" />
+ <Parameter Name="length" Type="System.UInt32" />
+ <Parameter Name="easing" Type="Xamarin.Forms.Easing" />
+ </Parameters>
+ <Docs>
+ <param name="view">The view to tanslate.</param>
+ <param name="x">The x component of the final translation vector.</param>
+ <param name="y">The y component of the final translation vector.</param>
+ <param name="length">The duration of the animation in milliseconds.</param>
+ <param name="easing">The easing of the animation.</param>
+ <summary>Animates an elements TranslationX and TranslationY properties from their current values to the new values.</summary>
+ <returns>To be added.</returns>
+ <remarks>Translate to is particular useful for animations because it is applied post-layout. Translation animations will not conflict with managed layouts and thus are ideal for doing slide in/out style animations.</remarks>
+ </Docs>
+ </Member>
+ </Members>
+</Type>