-
Notifications
You must be signed in to change notification settings - Fork 3
/
Effect.xml
174 lines (174 loc) · 10.5 KB
/
Effect.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
<Type Name="Effect" FullName="Microsoft.Maui.Controls.Effect">
<TypeSignature Language="C#" Value="public abstract class Effect" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit Effect extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Maui.Controls.Effect" />
<TypeSignature Language="VB.NET" Value="Public MustInherit Class Effect" />
<TypeSignature Language="C++ CLI" Value="public ref class Effect abstract" />
<TypeSignature Language="F#" Value="type Effect = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Maui.Controls</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>9.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>
<para>Effects are suitable when the developer needs to use platform-specific features to achieve the desired effect. Developers should consider using <see cref="T:Microsoft.Maui.Controls.Behavior" /> if they do not need platform-specific implentations to achieve their desired result.</para>
</remarks>
</Docs>
<Members>
<Member MemberName="Element">
<MemberSignature Language="C#" Value="public Microsoft.Maui.Controls.Element Element { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Maui.Controls.Element Element" />
<MemberSignature Language="DocId" Value="P:Microsoft.Maui.Controls.Effect.Element" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Element As Element" />
<MemberSignature Language="C++ CLI" Value="public:
 property Microsoft::Maui::Controls::Element ^ Element { Microsoft::Maui::Controls::Element ^ get(); };" />
<MemberSignature Language="F#" Value="member this.Element : Microsoft.Maui.Controls.Element" Usage="Microsoft.Maui.Controls.Effect.Element" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Maui.Controls</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Maui.Controls.Element</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the element to which the style is attached.</summary>
<value>The <see cref="T:Microsoft.Maui.Controls.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" />
<MemberSignature Language="DocId" Value="P:Microsoft.Maui.Controls.Effect.IsAttached" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property IsAttached As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool IsAttached { bool get(); };" />
<MemberSignature Language="F#" Value="member this.IsAttached : bool" Usage="Microsoft.Maui.Controls.Effect.IsAttached" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Maui.Controls</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>9.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" />
<MemberSignature Language="DocId" Value="M:Microsoft.Maui.Controls.Effect.OnAttached" />
<MemberSignature Language="VB.NET" Value="Protected MustOverride Sub OnAttached ()" />
<MemberSignature Language="C++ CLI" Value="protected:
 abstract void OnAttached();" />
<MemberSignature Language="F#" Value="abstract member OnAttached : unit -> unit" Usage="effect.OnAttached " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Maui.Controls</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</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" />
<MemberSignature Language="DocId" Value="M:Microsoft.Maui.Controls.Effect.OnDetached" />
<MemberSignature Language="VB.NET" Value="Protected MustOverride Sub OnDetached ()" />
<MemberSignature Language="C++ CLI" Value="protected:
 abstract void OnDetached();" />
<MemberSignature Language="F#" Value="abstract member OnDetached : unit -> unit" Usage="effect.OnDetached " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Maui.Controls</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Resolve">
<MemberSignature Language="C#" Value="public static Microsoft.Maui.Controls.Effect Resolve (string name);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Maui.Controls.Effect Resolve(string name) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Maui.Controls.Effect.Resolve(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function Resolve (name As String) As Effect" />
<MemberSignature Language="C++ CLI" Value="public:
 static Microsoft::Maui::Controls::Effect ^ Resolve(System::String ^ name);" />
<MemberSignature Language="F#" Value="static member Resolve : string -> Microsoft.Maui.Controls.Effect" Usage="Microsoft.Maui.Controls.Effect.Resolve name" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Maui.Controls</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Maui.Controls.Effect</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="name" Type="System.String" />
</Parameters>
<Docs>
<param name="name">The name of the effect to get.</param>
<summary>Returns an <see cref="T:Microsoft.Maui.Controls.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="M:Microsoft.Maui.Controls.Effect.Resolve(System.String)" /> method takes a string that is the concatenation of a resolution group name (supplied to <see cref="T:Microsoft.Maui.Controls.ResolutionGroupNameAttribute" />), <c>'.'</c>, and the unique name that was supplied to <see cref="T:Microsoft.Maui.Controls.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" />
<MemberSignature Language="DocId" Value="P:Microsoft.Maui.Controls.Effect.ResolveId" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ResolveId As String" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ ResolveId { System::String ^ get(); };" />
<MemberSignature Language="F#" Value="member this.ResolveId : string" Usage="Microsoft.Maui.Controls.Effect.ResolveId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Maui.Controls</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>9.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:Microsoft.Maui.Controls.ExportEffectAttribute" /> that is unique over the scope of the name that they supply to <see cref="T:Microsoft.Maui.Controls.ResolutionGroupNameAttribute" />. The <see cref="M:Microsoft.Maui.Controls.Effect.Resolve(System.String)" /> 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:Microsoft.Maui.Controls.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="M:Microsoft.Maui.Controls.Effect.Resolve(System.String)" /> to get the effect at runtime.</para>
</remarks>
</Docs>
</Member>
</Members>
</Type>