summaryrefslogtreecommitdiff
path: root/docs/Xamarin.Forms.Core/Xamarin.Forms/PinchGestureUpdatedEventArgs.xml
blob: 73671ec8fd73628ca882bae7b51f462a9a6f7206 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
<Type Name="PinchGestureUpdatedEventArgs" FullName="Xamarin.Forms.PinchGestureUpdatedEventArgs">
  <TypeSignature Language="C#" Value="public class PinchGestureUpdatedEventArgs : EventArgs" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit PinchGestureUpdatedEventArgs extends System.EventArgs" />
  <AssemblyInfo>
    <AssemblyName>Xamarin.Forms.Core</AssemblyName>
    <AssemblyVersion>1.5.0.0</AssemblyVersion>
    <AssemblyVersion>2.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.EventArgs</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>Event arguments for the <see cref="E:Xamarin.Forms.PinchGestureRecognizer.PinchUpdated" /> event.</summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public PinchGestureUpdatedEventArgs (Xamarin.Forms.GestureStatus status);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype Xamarin.Forms.GestureStatus status) cil managed" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.5.0.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="status" Type="Xamarin.Forms.GestureStatus" />
      </Parameters>
      <Docs>
        <param name="status">To be added.</param>
        <summary>Constructs a new <see cref="T:Xamarin.Forms.PinchGestureUpdatedEventArgs" /> object with default values.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public PinchGestureUpdatedEventArgs (Xamarin.Forms.GestureStatus status, double scale, Xamarin.Forms.Point origin);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype Xamarin.Forms.GestureStatus status, float64 scale, valuetype Xamarin.Forms.Point origin) cil managed" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.5.0.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="status" Type="Xamarin.Forms.GestureStatus" />
        <Parameter Name="scale" Type="System.Double" />
        <Parameter Name="origin" Type="Xamarin.Forms.Point" />
      </Parameters>
      <Docs>
        <param name="status">Whether the gesture is starting, running, or has ended.</param>
        <param name="scale">The current scale of the pinch gesture.</param>
        <param name="origin">The updated origin of the pinch gesture.</param>
        <summary>Constructs a new <see cref="T:Xamarin.Forms.PinchGestureUpdatedEventArgs" /> object with the specified values.</summary>
        <remarks>
          <para>The origin of the pinch is the center of the pinch gesture, and changes if the user translates their pinch while they scale. Application developers may want to store the pinch origin when the gesture begins and use it for all scaling operations for that gesture.</para>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="Scale">
      <MemberSignature Language="C#" Value="public double Scale { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance float64 Scale" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.5.0.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Double</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>The relative size of the user's pinch gesture.</summary>
        <value>The distance between the user's digits, divided by the initial distance between the user's digits in the pinch gesture.</value>
        <remarks>
          <para>The initial value of the <see cref="P:Xamarin.Forms.PinchGestureUpdatedEventArgs.Scale" /> property for each new pinch gesture is <c>1.0</c>.</para>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="ScaleOrigin">
      <MemberSignature Language="C#" Value="public Xamarin.Forms.Point ScaleOrigin { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype Xamarin.Forms.Point ScaleOrigin" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.5.0.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Xamarin.Forms.Point</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>The updated origin of the pinch gesture.</summary>
        <value>The midpoint of the pinch gesture.</value>
        <remarks>
          <para>The origin of the pinch is the center of the pinch gesture, and changes if the user translates their pinch while they scale. Application developers may want to store the pinch origin when the gesture begins and use it for all scaling operations for that gesture.</para>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="Status">
      <MemberSignature Language="C#" Value="public Xamarin.Forms.GestureStatus Status { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype Xamarin.Forms.GestureStatus Status" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.5.0.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Xamarin.Forms.GestureStatus</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Whether the gesture started, is running, or has finished.</summary>
        <value>Whether the gesture started, is running, or has finished.</value>
        <remarks>
          <para>The origin of the pinch, <see cref="P:Xamarin.Forms.PinchGestureUpdatedEventArgs.ScaleOrigin" />, is the center of the pinch gesture, and changes if the user translates their pinch while they scale. Application developers may want to store the pinch origin when the gesture begins and use it for all scaling operations for that gesture.</para>
          <para>The initial value of the <see cref="P:Xamarin.Forms.PinchGestureUpdatedEventArgs.Scale" /> property for each new pinch gesture is <c>1.0</c>.</para>
        </remarks>
      </Docs>
    </Member>
  </Members>
</Type>