Initial import

1 files changed, 130 insertions, 0 deletions

diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/Effect.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/Effect.xml
new file mode 100644
index 00000000..2ccc573f
--- /dev/null
+++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/Effect.xml
@@ -0,0 +1,130 @@
+<Type Name="Effect" FullName="Xamarin.Forms.Effect">
+  <TypeSignature Language="C#" Value="public abstract class Effect" />
+  <TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit Effect 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>A collection of styles and properties that can be added to an element at run time.</summary>
+    <remarks>To be added.</remarks>
+  </Docs>
+  <Members>
+    <Member MemberName="Element">
+      <MemberSignature Language="C#" Value="public Xamarin.Forms.Element Element { get; }" />
+      <MemberSignature Language="ILAsm" Value=".property instance class Xamarin.Forms.Element Element" />
+      <MemberType>Property</MemberType>
+      <AssemblyInfo>
+        <AssemblyVersion>2.0.0.0</AssemblyVersion>
+      </AssemblyInfo>
+      <ReturnValue>
+        <ReturnType>Xamarin.Forms.Element</ReturnType>
+      </ReturnValue>
+      <Docs>
+        <summary>Gets the element to which the style is attached.</summary>
+        <value>The <see cref="T:Xamarin.Forms.Element" /> to which the property is attached, if the property is attached. Otherwise, <see langword="null" />.</value>
+        <remarks>To be added.</remarks>
+      </Docs>
+    </Member>
+    <Member MemberName="IsAttached">
+      <MemberSignature Language="C#" Value="public bool IsAttached { get; }" />
+      <MemberSignature Language="ILAsm" Value=".property instance bool IsAttached" />
+      <MemberType>Property</MemberType>
+      <AssemblyInfo>
+        <AssemblyVersion>2.0.0.0</AssemblyVersion>
+      </AssemblyInfo>
+      <ReturnValue>
+        <ReturnType>System.Boolean</ReturnType>
+      </ReturnValue>
+      <Docs>
+        <summary>Gets a value that tells whether the effect is attached to an element.</summary>
+        <value>To be added.</value>
+        <remarks>To be added.</remarks>
+      </Docs>
+    </Member>
+    <Member MemberName="OnAttached">
+      <MemberSignature Language="C#" Value="protected abstract void OnAttached ();" />
+      <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void OnAttached() cil managed" />
+      <MemberType>Method</MemberType>
+      <AssemblyInfo>
+        <AssemblyVersion>2.0.0.0</AssemblyVersion>
+      </AssemblyInfo>
+      <ReturnValue>
+        <ReturnType>System.Void</ReturnType>
+      </ReturnValue>
+      <Parameters />
+      <Docs>
+        <summary>Method that is called after the effect is attached and made valid.</summary>
+        <remarks>To be added.</remarks>
+      </Docs>
+    </Member>
+    <Member MemberName="OnDetached">
+      <MemberSignature Language="C#" Value="protected abstract void OnDetached ();" />
+      <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void OnDetached() cil managed" />
+      <MemberType>Method</MemberType>
+      <AssemblyInfo>
+        <AssemblyVersion>2.0.0.0</AssemblyVersion>
+      </AssemblyInfo>
+      <ReturnValue>
+        <ReturnType>System.Void</ReturnType>
+      </ReturnValue>
+      <Parameters />
+      <Docs>
+        <summary>Method that is called after the effect is detached and invalidated.</summary>
+        <remarks>To be added.</remarks>
+      </Docs>
+    </Member>
+    <Member MemberName="Resolve">
+      <MemberSignature Language="C#" Value="public static Xamarin.Forms.Effect Resolve (string name);" />
+      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Xamarin.Forms.Effect Resolve(string name) cil managed" />
+      <MemberType>Method</MemberType>
+      <AssemblyInfo>
+        <AssemblyVersion>2.0.0.0</AssemblyVersion>
+      </AssemblyInfo>
+      <ReturnValue>
+        <ReturnType>Xamarin.Forms.Effect</ReturnType>
+      </ReturnValue>
+      <Parameters>
+        <Parameter Name="name" Type="System.String" />
+      </Parameters>
+      <Docs>
+        <param name="name">To be added.</param>
+        <summary>Returns an <see cref="T:Xamarin.Forms.Effect" /> for the specified name, which is of the form <c>ResolutionGroupName.ExportEffect</c>.</summary>
+        <returns>The uniquely identified effect.</returns>
+        <remarks>The <see cref="T:Xamarin.Forms.Effect.Resolve" /> method takes a string that is the concatenation of a resolution group name (supplied to <see cref="T:Xamarin.Forms.ResolutionGroupNameAttribute" />), <c>'.'</c>, and the unique name that was supplied to <see cref="T:Xamarin.Forms.ExportEffectAttribute" />, and returns the specified effect.</remarks>
+      </Docs>
+    </Member>
+    <Member MemberName="ResolveId">
+      <MemberSignature Language="C#" Value="public string ResolveId { get; }" />
+      <MemberSignature Language="ILAsm" Value=".property instance string ResolveId" />
+      <MemberType>Property</MemberType>
+      <AssemblyInfo>
+        <AssemblyVersion>2.0.0.0</AssemblyVersion>
+      </AssemblyInfo>
+      <ReturnValue>
+        <ReturnType>System.String</ReturnType>
+      </ReturnValue>
+      <Docs>
+        <summary>Gets the ID that is used to resolve this effect at runtime.</summary>
+        <value>The ID that is used to resolve this effect at runtime.</value>
+        <remarks><para>Developers must supply a name to <see cref="T:Xamarin.Forms.ExportEffectAttribute" /> that is unique over the scope of the name that they supply to <see cref="T:Xamarin.Forms.ResolutionGroupNameAttribute" />. The <see cref="T:Xamarin.Forms.Effect.Resolve" /> method takes a string that is the concatenation of <paramref name="name" /> (the resolution group name), <c>'.'</c>, and the unique name that was supplied to <see cref="T:Xamarin.Forms.ExportEffectAttribute" />, and returns the specified effect.</para>
+        <example><para>For example, with the declarations:</para>
+        <code lang="c#"><![CDATA[
+            [assembly: ResolutionGroupName ("com.YourCompany")]
+            [assembly: ExportEffect (typeof (ShadowEffect), "ShadowEffect")]]]>
+        </code>
+        <para>Then the code below will add the effect to a button:</para>
+        <code lang="c#"><![CDATA[
+            [var button = new Button { Text = "I have a shadow" };
+    button.Effects.Add (Effect.Resolve ("com.YourCompany.ShadowEffect"));]]>
+        </code>
+    </example>
+<para>This property returns the string that developers pass to <see cref="T:Xamarin.Forms.Effect.Resolve" /> to get the effect at runtime.</para></remarks>
+      </Docs>
+    </Member>
+  </Members>
+</Type>