summaryrefslogtreecommitdiff
path: root/docs/Xamarin.Forms.Core/Xamarin.Forms/ResolutionGroupNameAttribute.xml
diff options
context:
space:
mode:
Diffstat (limited to 'docs/Xamarin.Forms.Core/Xamarin.Forms/ResolutionGroupNameAttribute.xml')
-rw-r--r--docs/Xamarin.Forms.Core/Xamarin.Forms/ResolutionGroupNameAttribute.xml62
1 files changed, 62 insertions, 0 deletions
diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/ResolutionGroupNameAttribute.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/ResolutionGroupNameAttribute.xml
new file mode 100644
index 00000000..ece1f895
--- /dev/null
+++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/ResolutionGroupNameAttribute.xml
@@ -0,0 +1,62 @@
+<Type Name="ResolutionGroupNameAttribute" FullName="Xamarin.Forms.ResolutionGroupNameAttribute">
+ <TypeSignature Language="C#" Value="public class ResolutionGroupNameAttribute : Attribute" />
+ <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ResolutionGroupNameAttribute 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=false, Inherited=false)</AttributeName>
+ </Attribute>
+ </Attributes>
+ <Docs>
+ <summary>Attribute that identifies a group name, typically a company name or reversed company URL, that provides a scope for effect names.</summary>
+ <remarks><para>Developers must supply a name to <see cref="T:Xamarin.Forms.ExportEffectAttribute" /> that is unique over the scope of the <param name="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></remarks>
+ </Docs>
+ <Members>
+ <Member MemberName=".ctor">
+ <MemberSignature Language="C#" Value="public ResolutionGroupNameAttribute (string name);" />
+ <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string name) cil managed" />
+ <MemberType>Constructor</MemberType>
+ <AssemblyInfo>
+ <AssemblyVersion>2.0.0.0</AssemblyVersion>
+ </AssemblyInfo>
+ <Parameters>
+ <Parameter Name="name" Type="System.String" />
+ </Parameters>
+ <Docs>
+ <param name="name">A name, such as a company name or reversed company URL, that helps to uniquely identify effects.</param>
+ <summary>Creates a new resolution group name attribute.</summary>
+ <remarks><para>Developers must supply a name to <see cref="T:Xamarin.Forms.ExportEffectAttribute" /> that is unique over the scope of the <param name="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></remarks>
+ <altmember cref="T:Xamarin.Forms.ExportEffectAttribute" />
+ </Docs>
+ </Member>
+ </Members>
+</Type>