summaryrefslogtreecommitdiff
path: root/docs/Xamarin.Forms.Core/Xamarin.Forms/PoppedToRootEventArgs.xml
blob: c9554a5b43b3eaecc40dd5c0540af873f361f9eb (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
<Type Name="PoppedToRootEventArgs" FullName="Xamarin.Forms.PoppedToRootEventArgs">
  <TypeSignature Language="C#" Value="public class PoppedToRootEventArgs : Xamarin.Forms.NavigationEventArgs" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit PoppedToRootEventArgs extends Xamarin.Forms.NavigationEventArgs" />
  <AssemblyInfo>
    <AssemblyName>Xamarin.Forms.Core</AssemblyName>
    <AssemblyVersion>2.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>Xamarin.Forms.NavigationEventArgs</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>EventArgs for the NavigationPage's PoppedToRoot navigation event.</summary>
    <remarks>
        The <see cref="E:Xamarin.Forms.NavigationPage.PoppedToRoot" /> passes <see cref="T:Xamarin.Forms.NavigationEventArgs" /> as the
        event argument. This class can be cast to <see cref="T:Xamarin.Forms.PoppedToRootEventArgs" /> to allow for access to the
        PoppedPages collection that exposes the pages that was popped.
    </remarks>
    <altmember cref="E:Xamarin.Forms.NavigationPage.PoppedToRoot" />
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public PoppedToRootEventArgs (Xamarin.Forms.Page page, System.Collections.Generic.IEnumerable&lt;Xamarin.Forms.Page&gt; poppedPages);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Xamarin.Forms.Page page, class System.Collections.Generic.IEnumerable`1&lt;class Xamarin.Forms.Page&gt; poppedPages) cil managed" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="page" Type="Xamarin.Forms.Page" />
        <Parameter Name="poppedPages" Type="System.Collections.Generic.IEnumerable&lt;Xamarin.Forms.Page&gt;" />
      </Parameters>
      <Docs>
        <param name="page">For internal use by the Xamarin.Forms platform.</param>
        <param name="poppedPages">For internal use by the Xamarin.Forms platform.</param>
        <summary>For internal use by platform renderers.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="PoppedPages">
      <MemberSignature Language="C#" Value="public System.Collections.Generic.IEnumerable&lt;Xamarin.Forms.Page&gt; PoppedPages { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IEnumerable`1&lt;class Xamarin.Forms.Page&gt; PoppedPages" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Collections.Generic.IEnumerable&lt;Xamarin.Forms.Page&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets a collection of pages that was removed from the navigation stack.</summary>
        <value>
        </value>
        <remarks>
          <para>For <see cref="E:Xamarin.Forms.NavigationPage.PoppedToRoot" /> this represents the pages
          that were popped. The order of the pages represents the order of the stack that was popped. The first page in the
          collection is the page that was closest to the root page.
          </para>
        </remarks>
      </Docs>
    </Member>
  </Members>
</Type>