diff options
Diffstat (limited to 'docs/Xamarin.Forms.Core/Xamarin.Forms/Device.xml')
| -rw-r--r-- | docs/Xamarin.Forms.Core/Xamarin.Forms/Device.xml | 289 |
1 files changed, 289 insertions, 0 deletions
diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/Device.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/Device.xml new file mode 100644 index 00000000..d5c3fce4 --- /dev/null +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/Device.xml @@ -0,0 +1,289 @@ +<Type Name="Device" FullName="Xamarin.Forms.Device"> + <TypeSignature Language="C#" Value="public static class Device" /> + <TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit Device 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>A utility class to interact with the current Device/Platform.</summary> + <remarks> + </remarks> + </Docs> + <Members> + <Member MemberName="BeginInvokeOnMainThread"> + <MemberSignature Language="C#" Value="public static void BeginInvokeOnMainThread (Action action);" /> + <MemberSignature Language="ILAsm" Value=".method public static hidebysig void BeginInvokeOnMainThread(class System.Action action) 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="action" Type="System.Action" /> + </Parameters> + <Docs> + <param name="action">The Action to invoke </param> + <summary>Invokes an Action on the device main (UI) thread.</summary> + <remarks> + <para>This example shows how to set the Text of Label on the main thread, e.g. in response to an async event. + </para> + <example> + <code lang="C#"><![CDATA[ +Device.BeginInvokeOnMainThread (() => { + label.Text = "Async operation completed"; +}); + ]]></code> + </example> + </remarks> + </Docs> + </Member> + <Member MemberName="GetNamedSize"> + <MemberSignature Language="C#" Value="public static double GetNamedSize (Xamarin.Forms.NamedSize size, Type targetElementType);" /> + <MemberSignature Language="ILAsm" Value=".method public static hidebysig float64 GetNamedSize(valuetype Xamarin.Forms.NamedSize size, class System.Type targetElementType) cil managed" /> + <MemberType>Method</MemberType> + <AssemblyInfo> + <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.Double</ReturnType> + </ReturnValue> + <Parameters> + <Parameter Name="size" Type="Xamarin.Forms.NamedSize" /> + <Parameter Name="targetElementType" Type="System.Type" /> + </Parameters> + <Docs> + <param name="size">To be added.</param> + <param name="targetElementType">To be added.</param> + <summary>Returns a double that represents the named size for the font that is used on the element on the native platform.</summary> + <returns>To be added.</returns> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="GetNamedSize"> + <MemberSignature Language="C#" Value="public static double GetNamedSize (Xamarin.Forms.NamedSize size, Xamarin.Forms.Element targetElement);" /> + <MemberSignature Language="ILAsm" Value=".method public static hidebysig float64 GetNamedSize(valuetype Xamarin.Forms.NamedSize size, class Xamarin.Forms.Element targetElement) cil managed" /> + <MemberType>Method</MemberType> + <AssemblyInfo> + <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.Double</ReturnType> + </ReturnValue> + <Parameters> + <Parameter Name="size" Type="Xamarin.Forms.NamedSize" /> + <Parameter Name="targetElement" Type="Xamarin.Forms.Element" /> + </Parameters> + <Docs> + <param name="size">To be added.</param> + <param name="targetElement">To be added.</param> + <summary>Returns a double that represents a font size that corresponds to <paramref name="size" /> on <paramref name="targetElement" />.</summary> + <returns>To be added.</returns> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="Idiom"> + <MemberSignature Language="C#" Value="public static Xamarin.Forms.TargetIdiom Idiom { get; }" /> + <MemberSignature Language="ILAsm" Value=".property valuetype Xamarin.Forms.TargetIdiom Idiom" /> + <MemberType>Property</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>Xamarin.Forms.TargetIdiom</ReturnType> + </ReturnValue> + <Docs> + <summary>Gets the kind of device that Xamarin.Forms is currently working on.</summary> + <value>A <see cref="T:Xamarin.Forms.TargetIdiom" /> that represents the device type.</value> + <remarks> + </remarks> + </Docs> + </Member> + <Member MemberName="OnPlatform"> + <MemberSignature Language="C#" Value="public static void OnPlatform (Action iOS = null, Action Android = null, Action WinPhone = null, Action Default = null);" /> + <MemberSignature Language="ILAsm" Value=".method public static hidebysig void OnPlatform(class System.Action iOS, class System.Action Android, class System.Action WinPhone, class System.Action Default) 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="iOS" Type="System.Action" /> + <Parameter Name="Android" Type="System.Action" /> + <Parameter Name="WinPhone" Type="System.Action" /> + <Parameter Name="Default" Type="System.Action" /> + </Parameters> + <Docs> + <param name="iOS">(optional) The Action to execute on iOS.</param> + <param name="Android">(optional) The Action to execute on Android.</param> + <param name="WinPhone">(optional) The Action to execute on WinPhone.</param> + <param name="Default">(optional) The Action to execute if no Action was provided for the current OS.</param> + <summary>Executes different Actions depending on the <see cref="T:Xamarin.QcuikUI.TargetOS" /> that Xamarin.Forms is working on.</summary> + <remarks> + <para>This example shows how to change the font of a Label on a single OS. + </para> + <example> + <code lang="C#"><![CDATA[ +Device.OnPlatform (iOS: () => label.Font = Font.OfSize ("HelveticaNeue-UltraLight", NamedSize.Large)); + ]]></code> + </example> + </remarks> + </Docs> + </Member> + <Member MemberName="OnPlatform<T>"> + <MemberSignature Language="C#" Value="public static T OnPlatform<T> (T iOS, T Android, T WinPhone);" /> + <MemberSignature Language="ILAsm" Value=".method public static hidebysig !!T OnPlatform<T>(!!T iOS, !!T Android, !!T WinPhone) 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>T</ReturnType> + </ReturnValue> + <TypeParameters> + <TypeParameter Name="T" /> + </TypeParameters> + <Parameters> + <Parameter Name="iOS" Type="T" /> + <Parameter Name="Android" Type="T" /> + <Parameter Name="WinPhone" Type="T" /> + </Parameters> + <Docs> + <typeparam name="T">The type of the value to be returned.</typeparam> + <param name="iOS">The value for iOS.</param> + <param name="Android">The value for Android.</param> + <param name="WinPhone">The value for WinPhone.</param> + <summary>Returns different values depending on the <see cref="T:Xamarin.Forms.TargetOS" /> Xamarin.Forms is working on.</summary> + <returns>The value for the current OS.</returns> + <remarks> + <para>This example shows how to use different heights for a Button on different OS. + </para> + <example> + <code lang="C#"><![CDATA[ +button.HeightRequest = Device.OnPlatform (20,30,30); + ]]></code> + </example> + </remarks> + </Docs> + </Member> + <Member MemberName="OpenUri"> + <MemberSignature Language="C#" Value="public static void OpenUri (Uri uri);" /> + <MemberSignature Language="ILAsm" Value=".method public static hidebysig void OpenUri(class System.Uri uri) 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="uri" Type="System.Uri" /> + </Parameters> + <Docs> + <param name="uri">The <see cref="T:ystem.Uri" /> to open.</param> + <summary>Request the device to open the Uri.</summary> + <remarks>This often navigates out of the application.</remarks> + </Docs> + </Member> + <Member MemberName="OS"> + <MemberSignature Language="C#" Value="public static Xamarin.Forms.TargetPlatform OS { get; }" /> + <MemberSignature Language="ILAsm" Value=".property valuetype Xamarin.Forms.TargetPlatform OS" /> + <MemberType>Property</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>Xamarin.Forms.TargetPlatform</ReturnType> + </ReturnValue> + <Docs> + <summary>Gets the <see cref="Xamarin.Forms.TargetPlatform" /> indicating the OS Xamarin.Forms is working on.</summary> + <value>A <see cref="Xamarin.Forms.TargetPlatform" /> that indicates the current OS.</value> + <remarks> + </remarks> + </Docs> + </Member> + <Member MemberName="StartTimer"> + <MemberSignature Language="C#" Value="public static void StartTimer (TimeSpan interval, Func<bool> callback);" /> + <MemberSignature Language="ILAsm" Value=".method public static hidebysig void StartTimer(valuetype System.TimeSpan interval, class System.Func`1<bool> callback) 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="interval" Type="System.TimeSpan" /> + <Parameter Name="callback" Type="System.Func<System.Boolean>" /> + </Parameters> + <Docs> + <param name="interval">The interval between invocations of the callback.</param> + <param name="callback">The action to run when the timer elapses.</param> + <summary>Starts a recurring timer using the device clock capabilities.</summary> + <remarks>While the callback returns <see langword="true" />, the timer will keep recurring.</remarks> + </Docs> + </Member> + </Members> +</Type> |