diff options
| author | Marko B. Ludolph <MarkoBL@users.noreply.github.com> | 2017-10-03 15:46:41 +0200 |
|---|---|---|
| committer | Kangho Hur <kangho.hur@samsung.com> | 2017-10-23 13:33:58 +0900 |
| commit | 250d04e0bf50705b7fadfd1ff4a703b5607d22b8 (patch) | |
| tree | 4212d8a715fe2b350539070f77c3e047e748d49f /docs | |
| parent | 7accccfc353bda9088d4e9f1be780cc6624d5eca (diff) | |
| download | xamarin-forms-250d04e0bf50705b7fadfd1ff4a703b5607d22b8.tar.gz xamarin-forms-250d04e0bf50705b7fadfd1ff4a703b5607d22b8.tar.bz2 xamarin-forms-250d04e0bf50705b7fadfd1ff4a703b5607d22b8.zip | |
[MacOS] Navigation Transition Style (#1168)
Diffstat (limited to 'docs')
4 files changed, 435 insertions, 20 deletions
diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.macOSSpecific/NavigationPage.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.macOSSpecific/NavigationPage.xml new file mode 100644 index 00000000..00ab1eb0 --- /dev/null +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.macOSSpecific/NavigationPage.xml @@ -0,0 +1,217 @@ +<Type Name="NavigationPage" FullName="Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationPage"> + <TypeSignature Language="C#" Value="public static class NavigationPage" /> + <TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit NavigationPage extends System.Object" /> + <AssemblyInfo> + <AssemblyName>Xamarin.Forms.Core</AssemblyName> + <AssemblyVersion>2.0.0.0</AssemblyVersion> + </AssemblyInfo> + <Base> + <BaseTypeName>System.Object</BaseTypeName> + </Base> + <Interfaces /> + <Docs> + <summary>The navigation page instance that Xamarin.Forms created on the macOS platform.</summary> + <remarks>To be added.</remarks> + </Docs> + <Members> + <Member MemberName="GetNavigationTransitionPopStyle"> + <MemberSignature Language="C#" Value="public static Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationTransitionStyle GetNavigationTransitionPopStyle (Xamarin.Forms.BindableObject element);" /> + <MemberSignature Language="ILAsm" Value=".method public static hidebysig valuetype Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationTransitionStyle GetNavigationTransitionPopStyle(class Xamarin.Forms.BindableObject element) cil managed" /> + <MemberType>Method</MemberType> + <AssemblyInfo> + <AssemblyVersion>2.0.0.0</AssemblyVersion> + </AssemblyInfo> + <ReturnValue> + <ReturnType>Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationTransitionStyle</ReturnType> + </ReturnValue> + <Parameters> + <Parameter Name="element" Type="Xamarin.Forms.BindableObject" /> + </Parameters> + <Docs> + <param name="element">The platform specific element on which to perform the operation.</param> + <summary>Returns the NavigationTransitionStyle value that tells what transition is used when a page is popped from the navigation stack.</summary> + <returns>The NavigationTransitionStyle value that tells the current transition when a page is popped from the navigation stack.</returns> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="GetNavigationTransitionPopStyle"> + <MemberSignature Language="C#" Value="public static Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationTransitionStyle GetNavigationTransitionPopStyle (this Xamarin.Forms.IPlatformElementConfiguration<Xamarin.Forms.PlatformConfiguration.macOS,Xamarin.Forms.NavigationPage> config);" /> + <MemberSignature Language="ILAsm" Value=".method public static hidebysig valuetype Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationTransitionStyle GetNavigationTransitionPopStyle(class Xamarin.Forms.IPlatformElementConfiguration`2<class Xamarin.Forms.PlatformConfiguration.macOS, class Xamarin.Forms.NavigationPage> config) cil managed" /> + <MemberType>Method</MemberType> + <AssemblyInfo> + <AssemblyVersion>2.0.0.0</AssemblyVersion> + </AssemblyInfo> + <ReturnValue> + <ReturnType>Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationTransitionStyle</ReturnType> + </ReturnValue> + <Parameters> + <Parameter Name="config" Type="Xamarin.Forms.IPlatformElementConfiguration<Xamarin.Forms.PlatformConfiguration.macOS,Xamarin.Forms.NavigationPage>" RefType="this" /> + </Parameters> + <Docs> + <param name="config">The platform specific configuration that contains the element on which to perform the operation.</param> + <summary>Returns the NavigationTransitionStyle value that tells what transition is used when a page is popped from the navigation stack.</summary> + <returns>The NavigationTransitionStyle value that tells the current transition when a page is popped from the navigation stack.</returns> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="GetNavigationTransitionPushStyle"> + <MemberSignature Language="C#" Value="public static Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationTransitionStyle GetNavigationTransitionPushStyle (Xamarin.Forms.BindableObject element);" /> + <MemberSignature Language="ILAsm" Value=".method public static hidebysig valuetype Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationTransitionStyle GetNavigationTransitionPushStyle(class Xamarin.Forms.BindableObject element) cil managed" /> + <MemberType>Method</MemberType> + <AssemblyInfo> + <AssemblyVersion>2.0.0.0</AssemblyVersion> + </AssemblyInfo> + <ReturnValue> + <ReturnType>Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationTransitionStyle</ReturnType> + </ReturnValue> + <Parameters> + <Parameter Name="element" Type="Xamarin.Forms.BindableObject" /> + </Parameters> + <Docs> + <param name="element">The platform specific element on which to perform the operation.</param> + <summary>Returns the NavigationTransitionStyle value that tells what transition is used when a page is push on the navigation stack.</summary> + <returns>The NavigationTransitionStyle value that tells the current transition when a page is pushed on the navigation stack.</returns> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="GetNavigationTransitionPushStyle"> + <MemberSignature Language="C#" Value="public static Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationTransitionStyle GetNavigationTransitionPushStyle (this Xamarin.Forms.IPlatformElementConfiguration<Xamarin.Forms.PlatformConfiguration.macOS,Xamarin.Forms.NavigationPage> config);" /> + <MemberSignature Language="ILAsm" Value=".method public static hidebysig valuetype Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationTransitionStyle GetNavigationTransitionPushStyle(class Xamarin.Forms.IPlatformElementConfiguration`2<class Xamarin.Forms.PlatformConfiguration.macOS, class Xamarin.Forms.NavigationPage> config) cil managed" /> + <MemberType>Method</MemberType> + <AssemblyInfo> + <AssemblyVersion>2.0.0.0</AssemblyVersion> + </AssemblyInfo> + <ReturnValue> + <ReturnType>Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationTransitionStyle</ReturnType> + </ReturnValue> + <Parameters> + <Parameter Name="config" Type="Xamarin.Forms.IPlatformElementConfiguration<Xamarin.Forms.PlatformConfiguration.macOS,Xamarin.Forms.NavigationPage>" RefType="this" /> + </Parameters> + <Docs> + <param name="config">The platform specific configuration that contains the element on which to perform the operation.</param> + <summary>Returns the NavigationTransitionStyle value that tells what transition is used when a page is pushed on the navigation stack.</summary> + <returns>The NavigationTransitionStyle value that tells the current transition when a page is pushed on the navigation stack.</returns> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="NavigationTransitionPopStyleProperty"> + <MemberSignature Language="C#" Value="public static readonly Xamarin.Forms.BindableProperty NavigationTransitionPopStyleProperty;" /> + <MemberSignature Language="ILAsm" Value=".field public static initonly class Xamarin.Forms.BindableProperty NavigationTransitionPopStyleProperty" /> + <MemberType>Field</MemberType> + <AssemblyInfo> + <AssemblyVersion>2.0.0.0</AssemblyVersion> + </AssemblyInfo> + <ReturnValue> + <ReturnType>Xamarin.Forms.BindableProperty</ReturnType> + </ReturnValue> + <Docs> + <summary>Backing store for the attached property that controls the transition style of the platform-specific navigation page when a page is popped from the navigation stack.</summary> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="NavigationTransitionPushStyleProperty"> + <MemberSignature Language="C#" Value="public static readonly Xamarin.Forms.BindableProperty NavigationTransitionPushStyleProperty;" /> + <MemberSignature Language="ILAsm" Value=".field public static initonly class Xamarin.Forms.BindableProperty NavigationTransitionPushStyleProperty" /> + <MemberType>Field</MemberType> + <AssemblyInfo> + <AssemblyVersion>2.0.0.0</AssemblyVersion> + </AssemblyInfo> + <ReturnValue> + <ReturnType>Xamarin.Forms.BindableProperty</ReturnType> + </ReturnValue> + <Docs> + <summary>Backing store for the attached property that controls the transition style of the platform-specific navigation page when a page is pushed on the navigation stack.</summary> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="SetNavigationTransitionPopStyle"> + <MemberSignature Language="C#" Value="public static void SetNavigationTransitionPopStyle (Xamarin.Forms.BindableObject element, Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationTransitionStyle value);" /> + <MemberSignature Language="ILAsm" Value=".method public static hidebysig void SetNavigationTransitionPopStyle(class Xamarin.Forms.BindableObject element, valuetype Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationTransitionStyle value) cil managed" /> + <MemberType>Method</MemberType> + <AssemblyInfo> + <AssemblyVersion>2.0.0.0</AssemblyVersion> + </AssemblyInfo> + <ReturnValue> + <ReturnType>System.Void</ReturnType> + </ReturnValue> + <Parameters> + <Parameter Name="element" Type="Xamarin.Forms.BindableObject" /> + <Parameter Name="value" Type="Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationTransitionStyle" /> + </Parameters> + <Docs> + <param name="element">The platform specific element on which to perform the operation.</param> + <param name="value">The new transition style.</param> + <summary>Sets the transition style which is used, when popping from the navigation stack.</summary> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="SetNavigationTransitionPushStyle"> + <MemberSignature Language="C#" Value="public static void SetNavigationTransitionPushStyle (Xamarin.Forms.BindableObject element, Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationTransitionStyle value);" /> + <MemberSignature Language="ILAsm" Value=".method public static hidebysig void SetNavigationTransitionPushStyle(class Xamarin.Forms.BindableObject element, valuetype Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationTransitionStyle value) cil managed" /> + <MemberType>Method</MemberType> + <AssemblyInfo> + <AssemblyVersion>2.0.0.0</AssemblyVersion> + </AssemblyInfo> + <ReturnValue> + <ReturnType>System.Void</ReturnType> + </ReturnValue> + <Parameters> + <Parameter Name="element" Type="Xamarin.Forms.BindableObject" /> + <Parameter Name="value" Type="Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationTransitionStyle" /> + </Parameters> + <Docs> + <param name="element">The platform specific element on which to perform the operation.</param> + <param name="value">The new transition style.</param> + <summary>Sets the transition style which is used, when pushing pages on the navigation stack.</summary> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="SetNavigationTransitionStyle"> + <MemberSignature Language="C#" Value="public static void SetNavigationTransitionStyle (Xamarin.Forms.BindableObject element, Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationTransitionStyle pushStyle, Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationTransitionStyle popStyle);" /> + <MemberSignature Language="ILAsm" Value=".method public static hidebysig void SetNavigationTransitionStyle(class Xamarin.Forms.BindableObject element, valuetype Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationTransitionStyle pushStyle, valuetype Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationTransitionStyle popStyle) cil managed" /> + <MemberType>Method</MemberType> + <AssemblyInfo> + <AssemblyVersion>2.0.0.0</AssemblyVersion> + </AssemblyInfo> + <ReturnValue> + <ReturnType>System.Void</ReturnType> + </ReturnValue> + <Parameters> + <Parameter Name="element" Type="Xamarin.Forms.BindableObject" /> + <Parameter Name="pushStyle" Type="Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationTransitionStyle" /> + <Parameter Name="popStyle" Type="Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationTransitionStyle" /> + </Parameters> + <Docs> + <param name="element">The platform specific element on which to perform the operation.</param> + <param name="pushStyle">The new transition style when a page is pushed on the navigation stack.</param> + <param name="popStyle">The new transition style when a page is popped from the navigation stack.</param> + <summary>Sets the transition style which is used, when popping and pushing pages on the navigation stack.</summary> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="SetNavigationTransitionStyle"> + <MemberSignature Language="C#" Value="public static Xamarin.Forms.IPlatformElementConfiguration<Xamarin.Forms.PlatformConfiguration.macOS,Xamarin.Forms.NavigationPage> SetNavigationTransitionStyle (this Xamarin.Forms.IPlatformElementConfiguration<Xamarin.Forms.PlatformConfiguration.macOS,Xamarin.Forms.NavigationPage> config, Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationTransitionStyle pushStyle, Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationTransitionStyle popStyle);" /> + <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Xamarin.Forms.IPlatformElementConfiguration`2<class Xamarin.Forms.PlatformConfiguration.macOS, class Xamarin.Forms.NavigationPage> SetNavigationTransitionStyle(class Xamarin.Forms.IPlatformElementConfiguration`2<class Xamarin.Forms.PlatformConfiguration.macOS, class Xamarin.Forms.NavigationPage> config, valuetype Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationTransitionStyle pushStyle, valuetype Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationTransitionStyle popStyle) cil managed" /> + <MemberType>Method</MemberType> + <AssemblyInfo> + <AssemblyVersion>2.0.0.0</AssemblyVersion> + </AssemblyInfo> + <ReturnValue> + <ReturnType>Xamarin.Forms.IPlatformElementConfiguration<Xamarin.Forms.PlatformConfiguration.macOS,Xamarin.Forms.NavigationPage></ReturnType> + </ReturnValue> + <Parameters> + <Parameter Name="config" Type="Xamarin.Forms.IPlatformElementConfiguration<Xamarin.Forms.PlatformConfiguration.macOS,Xamarin.Forms.NavigationPage>" RefType="this" /> + <Parameter Name="pushStyle" Type="Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationTransitionStyle" /> + <Parameter Name="popStyle" Type="Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationTransitionStyle" /> + </Parameters> + <Docs> + <param name="config">The platform specific configuration that contains the element on which to perform the operation.</param> + <param name="pushStyle">The new transition style when a page is pushed on the navigation stack.</param> + <param name="popStyle">The new transition style when a page is popped from the navigation stack.</param> + <summary>Sets the transition style which is used, when popping and pushing pages on the navigation stack.</summary> + <returns>The updated configuration object on which developers can make successive method calls.</returns> + <remarks>To be added.</remarks> + </Docs> + </Member> + </Members> +</Type> diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.macOSSpecific/NavigationTransitionStyle.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.macOSSpecific/NavigationTransitionStyle.xml new file mode 100644 index 00000000..ffea8491 --- /dev/null +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.macOSSpecific/NavigationTransitionStyle.xml @@ -0,0 +1,129 @@ +<Type Name="NavigationTransitionStyle" FullName="Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationTransitionStyle"> + <TypeSignature Language="C#" Value="public enum NavigationTransitionStyle" /> + <TypeSignature Language="ILAsm" Value=".class public auto ansi sealed NavigationTransitionStyle extends System.Enum" /> + <AssemblyInfo> + <AssemblyName>Xamarin.Forms.Core</AssemblyName> + <AssemblyVersion>2.0.0.0</AssemblyVersion> + </AssemblyInfo> + <Base> + <BaseTypeName>System.Enum</BaseTypeName> + </Base> + <Docs> + <summary>Enumerates navigation transition styles.</summary> + <remarks>To be added.</remarks> + </Docs> + <Members> + <Member MemberName="Crossfade"> + <MemberSignature Language="C#" Value="Crossfade" /> + <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationTransitionStyle Crossfade = int32(1)" /> + <MemberType>Field</MemberType> + <AssemblyInfo> + <AssemblyVersion>2.0.0.0</AssemblyVersion> + </AssemblyInfo> + <ReturnValue> + <ReturnType>Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationTransitionStyle</ReturnType> + </ReturnValue> + <Docs> + <summary>Indicates a crossfade transition.</summary> + </Docs> + </Member> + <Member MemberName="None"> + <MemberSignature Language="C#" Value="None" /> + <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationTransitionStyle None = int32(0)" /> + <MemberType>Field</MemberType> + <AssemblyInfo> + <AssemblyVersion>2.0.0.0</AssemblyVersion> + </AssemblyInfo> + <ReturnValue> + <ReturnType>Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationTransitionStyle</ReturnType> + </ReturnValue> + <Docs> + <summary>Indicates no transition.</summary> + </Docs> + </Member> + <Member MemberName="SlideBackward"> + <MemberSignature Language="C#" Value="SlideBackward" /> + <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationTransitionStyle SlideBackward = int32(7)" /> + <MemberType>Field</MemberType> + <AssemblyInfo> + <AssemblyVersion>2.0.0.0</AssemblyVersion> + </AssemblyInfo> + <ReturnValue> + <ReturnType>Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationTransitionStyle</ReturnType> + </ReturnValue> + <Docs> + <summary>Indicates a slide backward transition.</summary> + </Docs> + </Member> + <Member MemberName="SlideDown"> + <MemberSignature Language="C#" Value="SlideDown" /> + <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationTransitionStyle SlideDown = int32(3)" /> + <MemberType>Field</MemberType> + <AssemblyInfo> + <AssemblyVersion>2.0.0.0</AssemblyVersion> + </AssemblyInfo> + <ReturnValue> + <ReturnType>Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationTransitionStyle</ReturnType> + </ReturnValue> + <Docs> + <summary>Indicates a slide down transition.</summary> + </Docs> + </Member> + <Member MemberName="SlideForward"> + <MemberSignature Language="C#" Value="SlideForward" /> + <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationTransitionStyle SlideForward = int32(6)" /> + <MemberType>Field</MemberType> + <AssemblyInfo> + <AssemblyVersion>2.0.0.0</AssemblyVersion> + </AssemblyInfo> + <ReturnValue> + <ReturnType>Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationTransitionStyle</ReturnType> + </ReturnValue> + <Docs> + <summary>Indicates a slide forward transition.</summary> + </Docs> + </Member> + <Member MemberName="SlideLeft"> + <MemberSignature Language="C#" Value="SlideLeft" /> + <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationTransitionStyle SlideLeft = int32(4)" /> + <MemberType>Field</MemberType> + <AssemblyInfo> + <AssemblyVersion>2.0.0.0</AssemblyVersion> + </AssemblyInfo> + <ReturnValue> + <ReturnType>Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationTransitionStyle</ReturnType> + </ReturnValue> + <Docs> + <summary>Indicates a slide left transition.</summary> + </Docs> + </Member> + <Member MemberName="SlideRight"> + <MemberSignature Language="C#" Value="SlideRight" /> + <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationTransitionStyle SlideRight = int32(5)" /> + <MemberType>Field</MemberType> + <AssemblyInfo> + <AssemblyVersion>2.0.0.0</AssemblyVersion> + </AssemblyInfo> + <ReturnValue> + <ReturnType>Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationTransitionStyle</ReturnType> + </ReturnValue> + <Docs> + <summary>Indicates a slide right transition.</summary> + </Docs> + </Member> + <Member MemberName="SlideUp"> + <MemberSignature Language="C#" Value="SlideUp" /> + <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationTransitionStyle SlideUp = int32(2)" /> + <MemberType>Field</MemberType> + <AssemblyInfo> + <AssemblyVersion>2.0.0.0</AssemblyVersion> + </AssemblyInfo> + <ReturnValue> + <ReturnType>Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationTransitionStyle</ReturnType> + </ReturnValue> + <Docs> + <summary>Indicates a slide up transition.</summary> + </Docs> + </Member> + </Members> +</Type> diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.macOSSpecific/Page.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.macOSSpecific/Page.xml index 49fdcd10..103e157b 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.macOSSpecific/Page.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms.PlatformConfiguration.macOSSpecific/Page.xml @@ -10,7 +10,7 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> + <summary>The page instance that Xamarin.Forms created on the macOS platform..</summary> <remarks>To be added.</remarks> </Docs> <Members> @@ -28,9 +28,9 @@ <Parameter Name="element" Type="Xamarin.Forms.BindableObject" /> </Parameters> <Docs> - <param name="element">To be added.</param> - <summary>To be added.</summary> - <returns>To be added.</returns> + <param name="element">The platform specific element on which to perform the operation.</param> + <summary>Returns the tab order of the visual elements on a page as array.</summary> + <returns>An array of VisualElement.</returns> <remarks>To be added.</remarks> </Docs> </Member> @@ -48,9 +48,9 @@ <Parameter Name="config" Type="Xamarin.Forms.IPlatformElementConfiguration<Xamarin.Forms.PlatformConfiguration.macOS,Xamarin.Forms.Page>" RefType="this" /> </Parameters> <Docs> - <param name="config">To be added.</param> - <summary>To be added.</summary> - <returns>To be added.</returns> + <param name="config">The platform specific configuration that contains the element on which to perform the operation.</param> + <summary>Returns the tab order of the visual elements on a page as array.</summary> + <returns>An array of VisualElement.</returns> <remarks>To be added.</remarks> </Docs> </Member> @@ -75,9 +75,9 @@ </Parameter> </Parameters> <Docs> - <param name="element">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> + <param name="element">The platform specific element on which to perform the operation.</param> + <param name="value">An array of VisualElement.</param> + <summary>Sets the tab order of visual elements on a page. Users can cycle through these elements with the tab key.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -102,10 +102,10 @@ </Parameter> </Parameters> <Docs> - <param name="config">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> - <returns>To be added.</returns> + <param name="config">The platform specific configuration that contains the element on which to perform the operation.</param> + <param name="value">An array of VisualElement.</param> + <summary>Sets the tab order of visual elements on a page. Users can cycle through these elements with the tab key.</summary> + <returns>The platform specific configuration that contains the element on which to perform the operation.</returns> <remarks>To be added.</remarks> </Docs> </Member> @@ -120,7 +120,7 @@ <ReturnType>Xamarin.Forms.BindableProperty</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Backing store for the attached property that holds the tab order of the visual elements.</summary> <remarks>To be added.</remarks> </Docs> </Member> diff --git a/docs/Xamarin.Forms.Core/index.xml b/docs/Xamarin.Forms.Core/index.xml index 78ae452a..b6a87904 100644 --- a/docs/Xamarin.Forms.Core/index.xml +++ b/docs/Xamarin.Forms.Core/index.xml @@ -522,6 +522,8 @@ <Type Name="VisualElement" Kind="Class" /> </Namespace> <Namespace Name="Xamarin.Forms.PlatformConfiguration.macOSSpecific"> + <Type Name="NavigationPage" Kind="Class" /> + <Type Name="NavigationTransitionStyle" Kind="Enumeration" /> <Type Name="Page" Kind="Class" /> <Type Name="TabbedPage" Kind="Class" /> </Namespace> @@ -2380,6 +2382,73 @@ <Targets> <Target Type="T:Xamarin.Forms.IPlatformElementConfiguration`2" /> </Targets> + <Member MemberName="GetNavigationTransitionPopStyle"> + <MemberSignature Language="C#" Value="public static Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationTransitionStyle GetNavigationTransitionPopStyle (this Xamarin.Forms.IPlatformElementConfiguration<Xamarin.Forms.PlatformConfiguration.macOS,Xamarin.Forms.NavigationPage> config);" /> + <MemberSignature Language="ILAsm" Value=".method public static hidebysig valuetype Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationTransitionStyle GetNavigationTransitionPopStyle(class Xamarin.Forms.IPlatformElementConfiguration`2<class Xamarin.Forms.PlatformConfiguration.macOS, class Xamarin.Forms.NavigationPage> config) cil managed" /> + <MemberType>ExtensionMethod</MemberType> + <ReturnValue> + <ReturnType>Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationTransitionStyle</ReturnType> + </ReturnValue> + <Parameters> + <Parameter Name="config" Type="Xamarin.Forms.IPlatformElementConfiguration<Xamarin.Forms.PlatformConfiguration.macOS,Xamarin.Forms.NavigationPage>" RefType="this" /> + </Parameters> + <Docs> + <param name="config">The platform specific configuration that contains the element on which to perform the operation.</param> + <summary>Returns the NavigationTransitionStyle value that tells what transition is used when a page is popped from the navigation stack.</summary> + </Docs> + <Link Type="Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationPage" Member="M:Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationPage.GetNavigationTransitionPopStyle(Xamarin.Forms.IPlatformElementConfiguration{Xamarin.Forms.PlatformConfiguration.macOS,Xamarin.Forms.NavigationPage})" /> + </Member> + </ExtensionMethod> + <ExtensionMethod> + <Targets> + <Target Type="T:Xamarin.Forms.IPlatformElementConfiguration`2" /> + </Targets> + <Member MemberName="GetNavigationTransitionPushStyle"> + <MemberSignature Language="C#" Value="public static Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationTransitionStyle GetNavigationTransitionPushStyle (this Xamarin.Forms.IPlatformElementConfiguration<Xamarin.Forms.PlatformConfiguration.macOS,Xamarin.Forms.NavigationPage> config);" /> + <MemberSignature Language="ILAsm" Value=".method public static hidebysig valuetype Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationTransitionStyle GetNavigationTransitionPushStyle(class Xamarin.Forms.IPlatformElementConfiguration`2<class Xamarin.Forms.PlatformConfiguration.macOS, class Xamarin.Forms.NavigationPage> config) cil managed" /> + <MemberType>ExtensionMethod</MemberType> + <ReturnValue> + <ReturnType>Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationTransitionStyle</ReturnType> + </ReturnValue> + <Parameters> + <Parameter Name="config" Type="Xamarin.Forms.IPlatformElementConfiguration<Xamarin.Forms.PlatformConfiguration.macOS,Xamarin.Forms.NavigationPage>" RefType="this" /> + </Parameters> + <Docs> + <param name="config">The platform specific configuration that contains the element on which to perform the operation.</param> + <summary>Returns the NavigationTransitionStyle value that tells what transition is used when a page is pushed on the navigation stack.</summary> + </Docs> + <Link Type="Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationPage" Member="M:Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationPage.GetNavigationTransitionPushStyle(Xamarin.Forms.IPlatformElementConfiguration{Xamarin.Forms.PlatformConfiguration.macOS,Xamarin.Forms.NavigationPage})" /> + </Member> + </ExtensionMethod> + <ExtensionMethod> + <Targets> + <Target Type="T:Xamarin.Forms.IPlatformElementConfiguration`2" /> + </Targets> + <Member MemberName="SetNavigationTransitionStyle"> + <MemberSignature Language="C#" Value="public static Xamarin.Forms.IPlatformElementConfiguration<Xamarin.Forms.PlatformConfiguration.macOS,Xamarin.Forms.NavigationPage> SetNavigationTransitionStyle (this Xamarin.Forms.IPlatformElementConfiguration<Xamarin.Forms.PlatformConfiguration.macOS,Xamarin.Forms.NavigationPage> config, Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationTransitionStyle pushStyle, Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationTransitionStyle popStyle);" /> + <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Xamarin.Forms.IPlatformElementConfiguration`2<class Xamarin.Forms.PlatformConfiguration.macOS, class Xamarin.Forms.NavigationPage> SetNavigationTransitionStyle(class Xamarin.Forms.IPlatformElementConfiguration`2<class Xamarin.Forms.PlatformConfiguration.macOS, class Xamarin.Forms.NavigationPage> config, valuetype Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationTransitionStyle pushStyle, valuetype Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationTransitionStyle popStyle) cil managed" /> + <MemberType>ExtensionMethod</MemberType> + <ReturnValue> + <ReturnType>Xamarin.Forms.IPlatformElementConfiguration<Xamarin.Forms.PlatformConfiguration.macOS,Xamarin.Forms.NavigationPage></ReturnType> + </ReturnValue> + <Parameters> + <Parameter Name="config" Type="Xamarin.Forms.IPlatformElementConfiguration<Xamarin.Forms.PlatformConfiguration.macOS,Xamarin.Forms.NavigationPage>" RefType="this" /> + <Parameter Name="pushStyle" Type="Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationTransitionStyle" /> + <Parameter Name="popStyle" Type="Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationTransitionStyle" /> + </Parameters> + <Docs> + <param name="config">The platform specific configuration that contains the element on which to perform the operation.</param> + <param name="pushStyle">The new transition style when a page is pushed on the navigation stack.</param> + <param name="popStyle">The new transition style when a page is popped from the navigation stack.</param> + <summary>Sets the transition style which is used, when popping and pushing pages on the navigation stack.</summary> + </Docs> + <Link Type="Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationPage" Member="M:Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationPage.SetNavigationTransitionStyle(Xamarin.Forms.IPlatformElementConfiguration{Xamarin.Forms.PlatformConfiguration.macOS,Xamarin.Forms.NavigationPage},Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationTransitionStyle,Xamarin.Forms.PlatformConfiguration.macOSSpecific.NavigationTransitionStyle)" /> + </Member> + </ExtensionMethod> + <ExtensionMethod> + <Targets> + <Target Type="T:Xamarin.Forms.IPlatformElementConfiguration`2" /> + </Targets> <Member MemberName="GetTabOrder"> <MemberSignature Language="C#" Value="public static Xamarin.Forms.VisualElement[] GetTabOrder (this Xamarin.Forms.IPlatformElementConfiguration<Xamarin.Forms.PlatformConfiguration.macOS,Xamarin.Forms.Page> config);" /> <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Xamarin.Forms.VisualElement[] GetTabOrder(class Xamarin.Forms.IPlatformElementConfiguration`2<class Xamarin.Forms.PlatformConfiguration.macOS, class Xamarin.Forms.Page> config) cil managed" /> @@ -2391,8 +2460,8 @@ <Parameter Name="config" Type="Xamarin.Forms.IPlatformElementConfiguration<Xamarin.Forms.PlatformConfiguration.macOS,Xamarin.Forms.Page>" RefType="this" /> </Parameters> <Docs> - <param name="config">To be added.</param> - <summary>To be added.</summary> + <param name="config">The platform specific configuration that contains the element on which to perform the operation.</param> + <summary>Returns the tab order of the visual elements on a page as array.</summary> </Docs> <Link Type="Xamarin.Forms.PlatformConfiguration.macOSSpecific.Page" Member="M:Xamarin.Forms.PlatformConfiguration.macOSSpecific.Page.GetTabOrder(Xamarin.Forms.IPlatformElementConfiguration{Xamarin.Forms.PlatformConfiguration.macOS,Xamarin.Forms.Page})" /> </Member> @@ -2419,9 +2488,9 @@ </Parameter> </Parameters> <Docs> - <param name="config">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> + <param name="config">The platform specific configuration that contains the element on which to perform the operation.</param> + <param name="value">An array of VisualElement.</param> + <summary>Sets the tab order of visual elements on a page. Users can cycle through these elements with the tab key.</summary> </Docs> <Link Type="Xamarin.Forms.PlatformConfiguration.macOSSpecific.Page" Member="M:Xamarin.Forms.PlatformConfiguration.macOSSpecific.Page.SetTabOrder(Xamarin.Forms.IPlatformElementConfiguration{Xamarin.Forms.PlatformConfiguration.macOS,Xamarin.Forms.Page},Xamarin.Forms.VisualElement[])" /> </Member> |