summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/Xamarin.Forms.Core/Xamarin.Forms/Device.xml129
-rw-r--r--docs/Xamarin.Forms.Core/Xamarin.Forms/On.xml68
-rw-r--r--docs/Xamarin.Forms.Core/Xamarin.Forms/OnPlatform`1.xml30
-rw-r--r--docs/Xamarin.Forms.Core/Xamarin.Forms/TargetPlatform.xml19
-rw-r--r--docs/Xamarin.Forms.Core/index.xml1
5 files changed, 190 insertions, 57 deletions
diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/Device.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/Device.xml
index 5bec0518..16d13483 100644
--- a/docs/Xamarin.Forms.Core/Xamarin.Forms/Device.xml
+++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/Device.xml
@@ -21,6 +21,21 @@
</remarks>
</Docs>
<Members>
+ <Member MemberName="Android">
+ <MemberSignature Language="C#" Value="public const string Android;" />
+ <MemberSignature Language="ILAsm" Value=".field public static literal string Android" />
+ <MemberType>Field</MemberType>
+ <AssemblyInfo>
+ <AssemblyVersion>2.0.0.0</AssemblyVersion>
+ </AssemblyInfo>
+ <ReturnValue>
+ <ReturnType>System.String</ReturnType>
+ </ReturnValue>
+ <Docs>
+ <summary>To be added.</summary>
+ <remarks>To be added.</remarks>
+ </Docs>
+ </Member>
<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" />
@@ -129,6 +144,21 @@ Device.BeginInvokeOnMainThread (() => {
</remarks>
</Docs>
</Member>
+ <Member MemberName="iOS">
+ <MemberSignature Language="C#" Value="public const string iOS;" />
+ <MemberSignature Language="ILAsm" Value=".field public static literal string iOS" />
+ <MemberType>Field</MemberType>
+ <AssemblyInfo>
+ <AssemblyVersion>2.0.0.0</AssemblyVersion>
+ </AssemblyInfo>
+ <ReturnValue>
+ <ReturnType>System.String</ReturnType>
+ </ReturnValue>
+ <Docs>
+ <summary>To be added.</summary>
+ <remarks>To be added.</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" />
@@ -142,6 +172,11 @@ Device.BeginInvokeOnMainThread (() => {
<AssemblyVersion>1.5.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
+ <Attributes>
+ <Attribute>
+ <AttributeName>System.Obsolete("Use switch(RuntimePlatform) instead.")</AttributeName>
+ </Attribute>
+ </Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
@@ -181,6 +216,11 @@ Device.OnPlatform (iOS: () => label.Font = Font.OfSize ("HelveticaNeue-UltraLigh
<AssemblyVersion>1.5.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
+ <Attributes>
+ <Attribute>
+ <AttributeName>System.Obsolete("Use switch(RuntimePlatform) instead.")</AttributeName>
+ </Attribute>
+ </Attributes>
<ReturnValue>
<ReturnType>T</ReturnType>
</ReturnValue>
@@ -210,44 +250,6 @@ button.HeightRequest = Device.OnPlatform (20,30,30);
</remarks>
</Docs>
</Member>
- <Member MemberName="OnPlatform&lt;T&gt;">
- <MemberSignature Language="C#" Value="public static T OnPlatform&lt;T&gt; (T iOS, T Android, T WinPhone, T Tizen);" />
- <MemberSignature Language="ILAsm" Value=".method public static hidebysig !!T OnPlatform&lt;T&gt;(!!T iOS, !!T Android, !!T WinPhone, !!T Tizen) cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <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" />
- <Parameter Name="Tizen" 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>
- <param name="WinPhone">The value for Tizen.</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" />
@@ -286,6 +288,11 @@ button.HeightRequest = Device.OnPlatform (20,30,30);
<AssemblyVersion>1.5.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
+ <Attributes>
+ <Attribute>
+ <AttributeName>System.Obsolete("Use RuntimePlatform instead.")</AttributeName>
+ </Attribute>
+ </Attributes>
<ReturnValue>
<ReturnType>Xamarin.Forms.TargetPlatform</ReturnType>
</ReturnValue>
@@ -296,6 +303,22 @@ button.HeightRequest = Device.OnPlatform (20,30,30);
</remarks>
</Docs>
</Member>
+ <Member MemberName="RuntimePlatform">
+ <MemberSignature Language="C#" Value="public static string RuntimePlatform { get; }" />
+ <MemberSignature Language="ILAsm" Value=".property string RuntimePlatform" />
+ <MemberType>Property</MemberType>
+ <AssemblyInfo>
+ <AssemblyVersion>2.0.0.0</AssemblyVersion>
+ </AssemblyInfo>
+ <ReturnValue>
+ <ReturnType>System.String</ReturnType>
+ </ReturnValue>
+ <Docs>
+ <summary>To be added.</summary>
+ <value>To be added.</value>
+ <remarks>To be added.</remarks>
+ </Docs>
+ </Member>
<Member MemberName="StartTimer">
<MemberSignature Language="C#" Value="public static void StartTimer (TimeSpan interval, Func&lt;bool&gt; callback);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void StartTimer(valuetype System.TimeSpan interval, class System.Func`1&lt;bool&gt; callback) cil managed" />
@@ -323,5 +346,35 @@ button.HeightRequest = Device.OnPlatform (20,30,30);
<remarks>While the callback returns <see langword="true" />, the timer will keep recurring.</remarks>
</Docs>
</Member>
+ <Member MemberName="Windows">
+ <MemberSignature Language="C#" Value="public const string Windows;" />
+ <MemberSignature Language="ILAsm" Value=".field public static literal string Windows" />
+ <MemberType>Field</MemberType>
+ <AssemblyInfo>
+ <AssemblyVersion>2.0.0.0</AssemblyVersion>
+ </AssemblyInfo>
+ <ReturnValue>
+ <ReturnType>System.String</ReturnType>
+ </ReturnValue>
+ <Docs>
+ <summary>To be added.</summary>
+ <remarks>To be added.</remarks>
+ </Docs>
+ </Member>
+ <Member MemberName="WinPhone">
+ <MemberSignature Language="C#" Value="public const string WinPhone;" />
+ <MemberSignature Language="ILAsm" Value=".field public static literal string WinPhone" />
+ <MemberType>Field</MemberType>
+ <AssemblyInfo>
+ <AssemblyVersion>2.0.0.0</AssemblyVersion>
+ </AssemblyInfo>
+ <ReturnValue>
+ <ReturnType>System.String</ReturnType>
+ </ReturnValue>
+ <Docs>
+ <summary>To be added.</summary>
+ <remarks>To be added.</remarks>
+ </Docs>
+ </Member>
</Members>
</Type>
diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/On.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/On.xml
new file mode 100644
index 00000000..65daa858
--- /dev/null
+++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/On.xml
@@ -0,0 +1,68 @@
+<Type Name="On" FullName="Xamarin.Forms.On">
+ <TypeSignature Language="C#" Value="public class On" />
+ <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit On extends System.Object" />
+ <AssemblyInfo>
+ <AssemblyName>Xamarin.Forms.Core</AssemblyName>
+ <AssemblyVersion>2.0.0.0</AssemblyVersion>
+ </AssemblyInfo>
+ <Base>
+ <BaseTypeName>System.Object</BaseTypeName>
+ </Base>
+ <Interfaces />
+ <Attributes>
+ <Attribute>
+ <AttributeName>Xamarin.Forms.ContentProperty("Value")</AttributeName>
+ </Attribute>
+ </Attributes>
+ <Docs>
+ <summary>To be added.</summary>
+ <remarks>To be added.</remarks>
+ </Docs>
+ <Members>
+ <Member MemberName=".ctor">
+ <MemberSignature Language="C#" Value="public On ();" />
+ <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
+ <MemberType>Constructor</MemberType>
+ <AssemblyInfo>
+ <AssemblyVersion>2.0.0.0</AssemblyVersion>
+ </AssemblyInfo>
+ <Parameters />
+ <Docs>
+ <summary>To be added.</summary>
+ <remarks>To be added.</remarks>
+ </Docs>
+ </Member>
+ <Member MemberName="Platform">
+ <MemberSignature Language="C#" Value="public System.Collections.Generic.IList&lt;string&gt; Platform { get; set; }" />
+ <MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1&lt;string&gt; Platform" />
+ <MemberType>Property</MemberType>
+ <AssemblyInfo>
+ <AssemblyVersion>2.0.0.0</AssemblyVersion>
+ </AssemblyInfo>
+ <ReturnValue>
+ <ReturnType>System.Collections.Generic.IList&lt;System.String&gt;</ReturnType>
+ </ReturnValue>
+ <Docs>
+ <summary>To be added.</summary>
+ <value>To be added.</value>
+ <remarks>To be added.</remarks>
+ </Docs>
+ </Member>
+ <Member MemberName="Value">
+ <MemberSignature Language="C#" Value="public object Value { get; set; }" />
+ <MemberSignature Language="ILAsm" Value=".property instance object Value" />
+ <MemberType>Property</MemberType>
+ <AssemblyInfo>
+ <AssemblyVersion>2.0.0.0</AssemblyVersion>
+ </AssemblyInfo>
+ <ReturnValue>
+ <ReturnType>System.Object</ReturnType>
+ </ReturnValue>
+ <Docs>
+ <summary>To be added.</summary>
+ <value>To be added.</value>
+ <remarks>To be added.</remarks>
+ </Docs>
+ </Member>
+ </Members>
+</Type>
diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/OnPlatform`1.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/OnPlatform`1.xml
index 1204cff8..b7f8f47c 100644
--- a/docs/Xamarin.Forms.Core/Xamarin.Forms/OnPlatform`1.xml
+++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/OnPlatform`1.xml
@@ -18,6 +18,11 @@
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
+ <Attributes>
+ <Attribute>
+ <AttributeName>Xamarin.Forms.ContentProperty("Platforms")</AttributeName>
+ </Attribute>
+ </Attributes>
<Docs>
<typeparam name="T">To be added.</typeparam>
<summary>Provides the platform-specific implementation of T for the current <see cref="P:Xamarin.Forms.Device.OS" />.</summary>
@@ -56,6 +61,11 @@
<AssemblyVersion>1.5.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
+ <Attributes>
+ <Attribute>
+ <AttributeName>System.Obsolete</AttributeName>
+ </Attribute>
+ </Attributes>
<ReturnValue>
<ReturnType>T</ReturnType>
</ReturnValue>
@@ -78,6 +88,11 @@
<AssemblyVersion>1.5.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
+ <Attributes>
+ <Attribute>
+ <AttributeName>System.Obsolete</AttributeName>
+ </Attribute>
+ </Attributes>
<ReturnValue>
<ReturnType>T</ReturnType>
</ReturnValue>
@@ -113,18 +128,18 @@
<remarks>To be added.</remarks>
</Docs>
</Member>
- <Member MemberName="Tizen">
- <MemberSignature Language="C#" Value="public T Tizen { get; set; }" />
- <MemberSignature Language="ILAsm" Value=".property instance !T Tizen" />
+ <Member MemberName="Platforms">
+ <MemberSignature Language="C#" Value="public System.Collections.Generic.IList&lt;Xamarin.Forms.On&gt; Platforms { get; }" />
+ <MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1&lt;class Xamarin.Forms.On&gt; Platforms" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
- <ReturnType>T</ReturnType>
+ <ReturnType>System.Collections.Generic.IList&lt;Xamarin.Forms.On&gt;</ReturnType>
</ReturnValue>
<Docs>
- <summary>The type as it is implemented on the Tizen platform.</summary>
+ <summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
@@ -142,6 +157,11 @@
<AssemblyVersion>1.5.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
+ <Attributes>
+ <Attribute>
+ <AttributeName>System.Obsolete</AttributeName>
+ </Attribute>
+ </Attributes>
<ReturnValue>
<ReturnType>T</ReturnType>
</ReturnValue>
diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/TargetPlatform.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/TargetPlatform.xml
index 9dc44669..9a0266fc 100644
--- a/docs/Xamarin.Forms.Core/Xamarin.Forms/TargetPlatform.xml
+++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/TargetPlatform.xml
@@ -14,6 +14,11 @@
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
+ <Attributes>
+ <Attribute>
+ <AttributeName>System.Obsolete</AttributeName>
+ </Attribute>
+ </Attributes>
<Docs>
<summary>Indicates the kind of OS Forms is currently working on.</summary>
<remarks>
@@ -80,20 +85,6 @@
<summary>(Unused) Indicates that Forms is running on an undefined platform.</summary>
</Docs>
</Member>
- <Member MemberName="Tizen">
- <MemberSignature Language="C#" Value="Tizen" />
- <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Xamarin.Forms.TargetPlatform Tizen = int32(5)" />
- <MemberType>Field</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>2.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>Xamarin.Forms.TargetPlatform</ReturnType>
- </ReturnValue>
- <Docs>
- <summary>Indicates that forms is running on the Tizen platform.</summary>
- </Docs>
- </Member>
<Member MemberName="Windows">
<MemberSignature Language="C#" Value="Windows" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype Xamarin.Forms.TargetPlatform Windows = int32(4)" />
diff --git a/docs/Xamarin.Forms.Core/index.xml b/docs/Xamarin.Forms.Core/index.xml
index 901945fb..1b6cb745 100644
--- a/docs/Xamarin.Forms.Core/index.xml
+++ b/docs/Xamarin.Forms.Core/index.xml
@@ -338,6 +338,7 @@
<Type Name="NavigationEventArgs" Kind="Class" />
<Type Name="NavigationMenu" Kind="Class" />
<Type Name="NavigationPage" Kind="Class" />
+ <Type Name="On" Kind="Class" />
<Type Name="OnIdiom`1" DisplayName="OnIdiom&lt;T&gt;" Kind="Class" />
<Type Name="OnPlatform`1" DisplayName="OnPlatform&lt;T&gt;" Kind="Class" />
<Type Name="OpenGLView" Kind="Class" />
generated by cgit v1.2.3 (git 2.25.1) at 2024-05-13 01:38:28 +0000