diff options
| author | Johan Karlsson <johan.kson@gmail.com> | 2016-07-11 20:39:11 +0200 |
|---|---|---|
| committer | Jason Smith <jason.smith@xamarin.com> | 2016-07-11 11:39:11 -0700 |
| commit | 09ff9355326065902e610e4058f7e4ee3160cdaa (patch) | |
| tree | 164307323b871bc41a4770517f02d9e4b43f8c76 /docs | |
| parent | f167024ef3a02c199c797b5313342dbe5d9a21de (diff) | |
| download | xamarin-forms-09ff9355326065902e610e4058f7e4ee3160cdaa.tar.gz xamarin-forms-09ff9355326065902e610e4058f7e4ee3160cdaa.tar.bz2 xamarin-forms-09ff9355326065902e610e4058f7e4ee3160cdaa.zip | |
Added PoppedToRootEventArgs to track popped pages when calling PopToRoot (#229)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/Xamarin.Forms.Core/Xamarin.Forms/NavigationPage.xml | 4 | ||||
| -rw-r--r-- | docs/Xamarin.Forms.Core/Xamarin.Forms/PoppedToRootEventArgs.xml | 60 |
2 files changed, 63 insertions, 1 deletions
diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/NavigationPage.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/NavigationPage.xml index f58b6d8f..d31d850e 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms/NavigationPage.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/NavigationPage.xml @@ -477,7 +477,9 @@ </ReturnValue> <Docs> <summary>Event that is raised when the last nonroot element is popped from this <see cref="T:Xamarin.Forms.NavigationPage" /> element.</summary> - <remarks>To be added.</remarks> + <remarks>The <see cref="T:Xamarin.Forms.NavigationEventArgs" /> can be cast to <see cref="T:Xamarin.Forms.PoppedToRootEventArgs" /> for + access to additional properties. For example, the list of popped pages. + </remarks> </Docs> </Member> <Member MemberName="PopToRootAsync"> diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/PoppedToRootEventArgs.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/PoppedToRootEventArgs.xml new file mode 100644 index 00000000..98b78287 --- /dev/null +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/PoppedToRootEventArgs.xml @@ -0,0 +1,60 @@ +<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);" /> + <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Xamarin.Forms.Page page) cil managed" /> + <MemberType>Constructor</MemberType> + <AssemblyInfo> + <AssemblyVersion>2.0.0.0</AssemblyVersion> + </AssemblyInfo> + <Parameters> + <Parameter Name="page" Type="Xamarin.Forms.Page" /> + </Parameters> + <Docs> + <param name="page">The page that is the new root page.</param> + <summary></summary> + <remarks></remarks> + </Docs> + </Member> + <Member MemberName="PoppedPages"> + <MemberSignature Language="C#" Value="public System.Collections.Generic.IEnumerable<Xamarin.Forms.Page> PoppedPages { get; set; }" /> + <MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IEnumerable`1<class Xamarin.Forms.Page> PoppedPages" /> + <MemberType>Property</MemberType> + <AssemblyInfo> + <AssemblyVersion>2.0.0.0</AssemblyVersion> + </AssemblyInfo> + <ReturnValue> + <ReturnType>System.Collections.Generic.IEnumerable<Xamarin.Forms.Page></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> |