mcs/class/corlib/Documentation/en/System.Runtime.InteropServices.WindowsRuntime/EventRegistrationTokenTable`1.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <Type Name="EventRegistrationTokenTable&lt;T&gt;" FullName="System.Runtime.InteropServices.WindowsRuntime.EventRegistrationTokenTable&lt;T&gt;">
   3   <TypeSignature Language="C#" Value="public sealed class EventRegistrationTokenTable&lt;T&gt; where T : class" />
   4   <TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit EventRegistrationTokenTable`1&lt;class T&gt; extends System.Object" />
   5   <AssemblyInfo>
   6     <AssemblyName>mscorlib</AssemblyName>
   7     <AssemblyVersion>4.0.0.0</AssemblyVersion>
   8   </AssemblyInfo>
   9   <TypeParameters>
  10     <TypeParameter Name="T">
  11       <Constraints>
  12         <ParameterAttribute>ReferenceTypeConstraint</ParameterAttribute>
  13       </Constraints>
  14     </TypeParameter>
  15   </TypeParameters>
  16   <Base>
  17     <BaseTypeName>System.Object</BaseTypeName>
  18   </Base>
  19   <Interfaces />
  20   <Docs>
  21     <typeparam name="T">To be added.</typeparam>
  22     <remarks>
  23       <attribution license="cc4" from="Microsoft" modified="false" />
  24       <para>Use this type when you need to manage the addition and removal of events manually. </para>
  25       <para>An instance of this table stores the delegates that represent the event handlers that have been added to an event. To raise the event, invoke the delegate that is returned by the <see cref="P:System.Runtime.InteropServices.WindowsRuntime.EventRegistrationTokenTable`1.InvocationList" /> property, if it is not null. An instance of this table is required for each event.</para>
  26     </remarks>
  27     <summary>
  28       <attribution license="cc4" from="Microsoft" modified="false" />
  29       <para>Stores mappings between delegates and event tokens, to support the implementation of a wrt event in managed code.</para>
  30     </summary>
  31   </Docs>
  32   <Members>
  33     <Member MemberName=".ctor">
  34       <MemberSignature Language="C#" Value="public EventRegistrationTokenTable ();" />
  35       <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
  36       <MemberType>Constructor</MemberType>
  37       <AssemblyInfo>
  38         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  39       </AssemblyInfo>
  40       <Parameters />
  41       <Docs>
  42         <remarks>To be added.</remarks>
  43         <summary>
  44           <attribution license="cc4" from="Microsoft" modified="false" />
  45           <para>Initializes a new instance of the <see cref="T:System.Runtime.InteropServices.WindowsRuntime.EventRegistrationTokenTable`1" /> class. </para>
  46         </summary>
  47       </Docs>
  48     </Member>
  49     <Member MemberName="AddEventHandler">
  50       <MemberSignature Language="C#" Value="public System.Runtime.InteropServices.WindowsRuntime.EventRegistrationToken AddEventHandler (T handler);" />
  51       <MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype System.Runtime.InteropServices.WindowsRuntime.EventRegistrationToken AddEventHandler(!T handler) cil managed" />
  52       <MemberType>Method</MemberType>
  53       <AssemblyInfo>
  54         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  55       </AssemblyInfo>
  56       <ReturnValue>
  57         <ReturnType>System.Runtime.InteropServices.WindowsRuntime.EventRegistrationToken</ReturnType>
  58       </ReturnValue>
  59       <Parameters>
  60         <Parameter Name="handler" Type="T" />
  61       </Parameters>
  62       <Docs>
  63         <param name="handler">To be added.</param>
  64         <summary>To be added.</summary>
  65         <returns>To be added.</returns>
  66         <remarks>To be added.</remarks>
  67       </Docs>
  68     </Member>
  69     <Member MemberName="GetOrCreateEventRegistrationTokenTable">
  70       <MemberSignature Language="C#" Value="public static System.Runtime.InteropServices.WindowsRuntime.EventRegistrationTokenTable&lt;T&gt; GetOrCreateEventRegistrationTokenTable (ref System.Runtime.InteropServices.WindowsRuntime.EventRegistrationTokenTable&lt;T&gt; refEventTable);" />
  71       <MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Runtime.InteropServices.WindowsRuntime.EventRegistrationTokenTable`1&lt;!T&gt; GetOrCreateEventRegistrationTokenTable(class System.Runtime.InteropServices.WindowsRuntime.EventRegistrationTokenTable`1&lt;!T&gt; refEventTable) cil managed" />
  72       <MemberType>Method</MemberType>
  73       <AssemblyInfo>
  74         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  75       </AssemblyInfo>
  76       <ReturnValue>
  77         <ReturnType>System.Runtime.InteropServices.WindowsRuntime.EventRegistrationTokenTable&lt;T&gt;</ReturnType>
  78       </ReturnValue>
  79       <Parameters>
  80         <Parameter Name="refEventTable" Type="System.Runtime.InteropServices.WindowsRuntime.EventRegistrationTokenTable&lt;T&gt;&amp;" RefType="ref" />
  81       </Parameters>
  82       <Docs>
  83         <param name="refEventTable">To be added.</param>
  84         <summary>To be added.</summary>
  85         <returns>To be added.</returns>
  86         <remarks>To be added.</remarks>
  87       </Docs>
  88     </Member>
  89     <Member MemberName="InvocationList">
  90       <MemberSignature Language="C#" Value="public T InvocationList { get; set; }" />
  91       <MemberSignature Language="ILAsm" Value=".property instance !T InvocationList" />
  92       <MemberType>Property</MemberType>
  93       <AssemblyInfo>
  94         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  95       </AssemblyInfo>
  96       <ReturnValue>
  97         <ReturnType>T</ReturnType>
  98       </ReturnValue>
  99       <Docs>
 100         <value>To be added.</value>
 101         <remarks>To be added.</remarks>
 102         <summary>
 103           <attribution license="cc4" from="Microsoft" modified="false" />
 104           <para>Gets or sets a delegate of type <paramref name="T" /> whose invocation list includes all the event handler delegates that have been added, and that have not yet been removed. Invoking this delegate invokes all the event handlers. </para>
 105         </summary>
 106       </Docs>
 107     </Member>
 108     <Member MemberName="RemoveEventHandler">
 109       <MemberSignature Language="C#" Value="public void RemoveEventHandler (System.Runtime.InteropServices.WindowsRuntime.EventRegistrationToken token);" />
 110       <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void RemoveEventHandler(valuetype System.Runtime.InteropServices.WindowsRuntime.EventRegistrationToken token) cil managed" />
 111       <MemberType>Method</MemberType>
 112       <AssemblyInfo>
 113         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 114       </AssemblyInfo>
 115       <ReturnValue>
 116         <ReturnType>System.Void</ReturnType>
 117       </ReturnValue>
 118       <Parameters>
 119         <Parameter Name="token" Type="System.Runtime.InteropServices.WindowsRuntime.EventRegistrationToken" />
 120       </Parameters>
 121       <Docs>
 122         <remarks>
 123           <attribution license="cc4" from="Microsoft" modified="false" />
 124           <para>If the token is not registered, the table and the invocation list are not modified. </para>
 125         </remarks>
 126         <summary>
 127           <attribution license="cc4" from="Microsoft" modified="false" />
 128           <para>Removes the event handler that is associated with the specified token from the table and the invocation list. </para>
 129         </summary>
 130         <param name="token">
 131           <attribution license="cc4" from="Microsoft" modified="false" />The token that was returned when the event handler was added. </param>
 132       </Docs>
 133     </Member>
 134     <Member MemberName="RemoveEventHandler">
 135       <MemberSignature Language="C#" Value="public void RemoveEventHandler (T handler);" />
 136       <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void RemoveEventHandler(!T handler) cil managed" />
 137       <MemberType>Method</MemberType>
 138       <AssemblyInfo>
 139         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 140       </AssemblyInfo>
 141       <ReturnValue>
 142         <ReturnType>System.Void</ReturnType>
 143       </ReturnValue>
 144       <Parameters>
 145         <Parameter Name="handler" Type="T" />
 146       </Parameters>
 147       <Docs>
 148         <param name="handler">To be added.</param>
 149         <summary>To be added.</summary>
 150         <remarks>To be added.</remarks>
 151       </Docs>
 152     </Member>
 153   </Members>
 154 </Type>