summaryrefslogtreecommitdiff
path: root/docs/Xamarin.Forms.Core/Xamarin.Forms/ExportEffectAttribute.xml
diff options
context:
space:
mode:
authorJason Smith <jason.smith@xamarin.com>2016-03-22 13:02:25 -0700
committerJason Smith <jason.smith@xamarin.com>2016-03-22 16:13:41 -0700
commit17fdde66d94155fc62a034fa6658995bef6fd6e5 (patch)
treeb5e5073a2a7b15cdbe826faa5c763e270a505729 /docs/Xamarin.Forms.Core/Xamarin.Forms/ExportEffectAttribute.xml
downloadxamarin-forms-17fdde66d94155fc62a034fa6658995bef6fd6e5.tar.gz
xamarin-forms-17fdde66d94155fc62a034fa6658995bef6fd6e5.tar.bz2
xamarin-forms-17fdde66d94155fc62a034fa6658995bef6fd6e5.zip
Initial import
Diffstat (limited to 'docs/Xamarin.Forms.Core/Xamarin.Forms/ExportEffectAttribute.xml')
-rw-r--r--docs/Xamarin.Forms.Core/Xamarin.Forms/ExportEffectAttribute.xml65
1 files changed, 65 insertions, 0 deletions
diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/ExportEffectAttribute.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/ExportEffectAttribute.xml
new file mode 100644
index 00000000..ae6c33f3
--- /dev/null
+++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/ExportEffectAttribute.xml
@@ -0,0 +1,65 @@
+<Type Name="ExportEffectAttribute" FullName="Xamarin.Forms.ExportEffectAttribute">
+ <TypeSignature Language="C#" Value="public class ExportEffectAttribute : Attribute" />
+ <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ExportEffectAttribute extends System.Attribute" />
+ <AssemblyInfo>
+ <AssemblyName>Xamarin.Forms.Core</AssemblyName>
+ <AssemblyVersion>2.0.0.0</AssemblyVersion>
+ </AssemblyInfo>
+ <Base>
+ <BaseTypeName>System.Attribute</BaseTypeName>
+ </Base>
+ <Interfaces />
+ <Attributes>
+ <Attribute>
+ <AttributeName>System.AttributeUsage(System.AttributeTargets.Assembly, AllowMultiple=true, Inherited=false)</AttributeName>
+ </Attribute>
+ </Attributes>
+ <Docs>
+ <summary>Attribute that identifies a <see cref="T:Xamarin.Forms.Effect" /> with a unique identifer that can be used with <see cref="MXamarin.Forms.Effect.Resolve" /> to locate an effect.</summary>
+ <remarks><para>Developers must supply a name that is unique over the scope of the value that was supplied to <see cref="T:Xamarin.Forms.ResolutionGroupNameAttribute" />. The <see cref="T:Xamarin.Forms.Effect.Resolve" /> method takes a string that is the concatenation of the the resolution group name that was provided to <see cref="T:Xamarin.Forms.ResolutionGroupNameAttribute" />, '<c>.</c>', and the name that was supplied to <see cref="T:Xamarin.Forms.ExportEffectAttribute" />, and returns an effect that will have the type <paramref name="effectType" />.</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></remarks>
+ <altmember cref="T:Xamarin.Forms.ResolutionGroupNameAttribute" />
+ </Docs>
+ <Members>
+ <Member MemberName=".ctor">
+ <MemberSignature Language="C#" Value="public ExportEffectAttribute (Type effectType, string uniqueName);" />
+ <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Type effectType, string uniqueName) cil managed" />
+ <MemberType>Constructor</MemberType>
+ <AssemblyInfo>
+ <AssemblyVersion>2.0.0.0</AssemblyVersion>
+ </AssemblyInfo>
+ <Parameters>
+ <Parameter Name="effectType" Type="System.Type" />
+ <Parameter Name="uniqueName" Type="System.String" />
+ </Parameters>
+ <Docs>
+ <param name="effectType">The type of the marked <see cref="T:Xamarin.Forms.Effect" />.</param>
+ <param name="uniqueName">A unique name for the <see cref="T:Xamarin.Forms.Effect" />.</param>
+ <summary>Creates a new <see cref="T:Xamarin.Forms.ExportEffectAttribute" />.</summary>
+ <remarks><para>Developers must supply a <paramref name="uniqueName" /> that is unique over the scope of the value that was supplied to <see cref="T:Xamarin.Forms.ResolutionGroupNameAttribute" />. The <see cref="T:Xamarin.Forms.Effect.Resolve" /> method takes a string that is the concatenation of the the resolution group name that was provided to <see cref="T:Xamarin.Forms.ResolutionGroupNameAttribute" />, '<c>.</c>', and the name that was supplied to <see cref="T:Xamarin.Forms.ExportEffectAttribute" />, and returns an effect that will have the type <paramref name="effectType" />.</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></remarks>
+ <altmember cref="T:Xamarin.Forms.ResolutionGroupNameAttribute" />
+ </Docs>
+ </Member>
+ </Members>
+</Type>