summaryrefslogtreecommitdiff
path: root/docs/Xamarin.Forms.Core/Xamarin.Forms/PlatformEffect`2.xml
blob: 49735e12d3100518f90a099d98abe27c62b8e52a (plain)
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
<Type Name="PlatformEffect&lt;TContainer,TControl&gt;" FullName="Xamarin.Forms.PlatformEffect&lt;TContainer,TControl&gt;">
  <TypeSignature Language="C#" Value="public abstract class PlatformEffect&lt;TContainer,TControl&gt; : Xamarin.Forms.Effect where TContainer : class where TControl : class" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit PlatformEffect`2&lt;class TContainer, class TControl&gt; extends Xamarin.Forms.Effect" />
  <AssemblyInfo>
    <AssemblyName>Xamarin.Forms.Core</AssemblyName>
    <AssemblyVersion>2.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <TypeParameters>
    <TypeParameter Name="TContainer">
      <Constraints>
        <ParameterAttribute>ReferenceTypeConstraint</ParameterAttribute>
      </Constraints>
    </TypeParameter>
    <TypeParameter Name="TControl">
      <Constraints>
        <ParameterAttribute>ReferenceTypeConstraint</ParameterAttribute>
      </Constraints>
    </TypeParameter>
  </TypeParameters>
  <Base>
    <BaseTypeName>Xamarin.Forms.Effect</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <typeparam name="TContainer">To be added.</typeparam>
    <typeparam name="TControl">To be added.</typeparam>
    <summary>Base class for platform-specific effect classes.</summary>
    <remarks>
      <para>App developers derive from the
        <list type="bullet"><item><term><c>Xamarin.Forms.Platform.Android.PlatformEffect</c>,</term></item><item><term><c>Xamarin.Forms.Platform.iOS.PlatformEffect</c>,</term></item><item><term><c>Xamarin.Forms.Platform.UWP.PlatformEffect</c></term></item><item><term><c>Xamarin.Forms.Platform.WinPhone.PlatformEffect</c>, or</term></item><item><term><c>Xamarin.Forms.Platform.WinRT.PlatformEffect,</c></term></item></list>
            classes to implement effects on the respective platforms.</para>
    </remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="protected PlatformEffect ();" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters />
      <Docs>
        <summary>Creates a new platform-specific effect with default values.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Container">
      <MemberSignature Language="C#" Value="public TContainer Container { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance !TContainer Container" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>TContainer</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Returns the container for the platform-specific effect.</summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Control">
      <MemberSignature Language="C#" Value="public TControl Control { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance !TControl Control" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>TControl</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Returns the control for the platform-specific effect.</summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="OnElementPropertyChanged">
      <MemberSignature Language="C#" Value="protected virtual void OnElementPropertyChanged (System.ComponentModel.PropertyChangedEventArgs args);" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void OnElementPropertyChanged(class System.ComponentModel.PropertyChangedEventArgs args) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="args" Type="System.ComponentModel.PropertyChangedEventArgs" />
      </Parameters>
      <Docs>
        <param name="args">The arguments for the property changed event.</param>
        <summary>Method that is called when a element property has changed.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>