mcs/class/Managed.Windows.Forms/Documentation/en/System.Windows.Forms/Message.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <Type Name="Message" FullName="System.Windows.Forms.Message">
   3   <TypeSignature Language="C#" Value="public struct Message" />
   4   <AssemblyInfo>
   5     <AssemblyName>System.Windows.Forms</AssemblyName>
   6     <AssemblyVersion>1.0.5000.0</AssemblyVersion>
   7     <AssemblyVersion>2.0.0.0</AssemblyVersion>
   8   </AssemblyInfo>
   9   <Base>
  10     <BaseTypeName>System.ValueType</BaseTypeName>
  11   </Base>
  12   <Interfaces />
  13   <Docs>
  14     <remarks>
  15       <attribution license="cc4" from="Microsoft" modified="false" />
  16       <para>The <see cref="T:System.Windows.Forms.Message" /> structure wraps messages that Windows sends. You can use this structure to wrap a message and assign it to the window procedure to be dispatched. You can also use this structure to get information about a message the system sends to your application or controls. For more information about Windows messages, see <see cref="http://go.microsoft.com/fwlink/?LinkId=198815">Messages and Message Queues</see>.</para>
  17       <para>You cannot create the <see cref="T:System.Windows.Forms.Message" /> directly. Instead, use the <see cref="M:System.Windows.Forms.Message.Create(System.IntPtr,System.Int32,System.IntPtr,System.IntPtr)" /> method. For the sake of efficiency, the <see cref="T:System.Windows.Forms.Message" /> uses its pool of existing <see cref="T:System.Windows.Forms.Message" />s instead of instantiating a new one, if possible. However, if a <see cref="T:System.Windows.Forms.Message" /> is not available in the pool, a new one is instantiated.</para>
  18     </remarks>
  19     <summary>
  20       <attribution license="cc4" from="Microsoft" modified="false" />
  21       <para>Implements a Windows message.</para>
  22     </summary>
  23   </Docs>
  24   <Members>
  25     <Member MemberName="Create">
  26       <MemberSignature Language="C#" Value="public static System.Windows.Forms.Message Create (IntPtr hWnd, int msg, IntPtr wparam, IntPtr lparam);" />
  27       <MemberType>Method</MemberType>
  28       <ReturnValue>
  29         <ReturnType>System.Windows.Forms.Message</ReturnType>
  30       </ReturnValue>
  31       <Parameters>
  32         <Parameter Name="hWnd" Type="System.IntPtr" />
  33         <Parameter Name="msg" Type="System.Int32" />
  34         <Parameter Name="wparam" Type="System.IntPtr" />
  35         <Parameter Name="lparam" Type="System.IntPtr" />
  36       </Parameters>
  37       <Docs>
  38         <remarks>
  39           <attribution license="cc4" from="Microsoft" modified="false" />
  40           <para>Use the <see cref="M:System.Windows.Forms.Message.Create(System.IntPtr,System.Int32,System.IntPtr,System.IntPtr)" /> method to create a <see cref="T:System.Windows.Forms.Message" /> to wrap a message sent by Windows.</para>
  41         </remarks>
  42         <summary>
  43           <attribution license="cc4" from="Microsoft" modified="false" />
  44           <para>Creates a new <see cref="T:System.Windows.Forms.Message" />.</para>
  45         </summary>
  46         <returns>
  47           <attribution license="cc4" from="Microsoft" modified="false" />
  48           <para>A <see cref="T:System.Windows.Forms.Message" /> that represents the message that was created.</para>
  49         </returns>
  50         <param name="hWnd">
  51           <attribution license="cc4" from="Microsoft" modified="false" />The window handle that the message is for. </param>
  52         <param name="msg">
  53           <attribution license="cc4" from="Microsoft" modified="false" />The message ID. </param>
  54         <param name="wparam">
  55           <attribution license="cc4" from="Microsoft" modified="false" />The message <paramref name="wparam" /> field. </param>
  56         <param name="lparam">
  57           <attribution license="cc4" from="Microsoft" modified="false" />The message <paramref name="lparam" /> field. </param>
  58       </Docs>
  59       <AssemblyInfo>
  60         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  61         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  62       </AssemblyInfo>
  63     </Member>
  64     <Member MemberName="Equals">
  65       <MemberSignature Language="C#" Value="public override bool Equals (object o);" />
  66       <MemberType>Method</MemberType>
  67       <ReturnValue>
  68         <ReturnType>System.Boolean</ReturnType>
  69       </ReturnValue>
  70       <Parameters>
  71         <Parameter Name="o" Type="System.Object" />
  72       </Parameters>
  73       <Docs>
  74         <remarks>To be added.</remarks>
  75         <summary>
  76           <attribution license="cc4" from="Microsoft" modified="false" />
  77           <para>Determines whether the specified object is equal to the current object.</para>
  78         </summary>
  79         <returns>
  80           <attribution license="cc4" from="Microsoft" modified="false" />
  81           <para>true if the specified object is equal to the current object; otherwise, false.</para>
  82         </returns>
  83         <param name="o">
  84           <attribution license="cc4" from="Microsoft" modified="false" />The object to compare with the current object.</param>
  85       </Docs>
  86       <AssemblyInfo>
  87         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  88         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  89       </AssemblyInfo>
  90     </Member>
  91     <Member MemberName="GetHashCode">
  92       <MemberSignature Language="C#" Value="public override int GetHashCode ();" />
  93       <MemberType>Method</MemberType>
  94       <ReturnValue>
  95         <ReturnType>System.Int32</ReturnType>
  96       </ReturnValue>
  97       <Parameters />
  98       <Docs>
  99         <summary>To be added.</summary>
 100         <returns>To be added.</returns>
 101         <remarks>To be added.</remarks>
 102       </Docs>
 103       <AssemblyInfo>
 104         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 105         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 106       </AssemblyInfo>
 107     </Member>
 108     <Member MemberName="GetLParam">
 109       <MemberSignature Language="C#" Value="public object GetLParam (Type cls);" />
 110       <MemberType>Method</MemberType>
 111       <ReturnValue>
 112         <ReturnType>System.Object</ReturnType>
 113       </ReturnValue>
 114       <Parameters>
 115         <Parameter Name="cls" Type="System.Type" />
 116       </Parameters>
 117       <Docs>
 118         <remarks>
 119           <attribution license="cc4" from="Microsoft" modified="false" />
 120           <para>Use the <see cref="M:System.Windows.Forms.Message.GetLParam(System.Type)" /> method to retrieve information from the <see cref="P:System.Windows.Forms.Message.LParam" /> field of a message and convert it to an object. You can use this method to access objects passed in a message.</para>
 121         </remarks>
 122         <summary>
 123           <attribution license="cc4" from="Microsoft" modified="false" />
 124           <para>Gets the <see cref="P:System.Windows.Forms.Message.LParam" /> value and converts the value to an object.</para>
 125         </summary>
 126         <returns>
 127           <attribution license="cc4" from="Microsoft" modified="false" />
 128           <para>An <see cref="T:System.Object" /> that represents an instance of the class specified by the <paramref name="cls" /> parameter, with the data from the <see cref="P:System.Windows.Forms.Message.LParam" /> field of the message.</para>
 129         </returns>
 130         <param name="cls">
 131           <attribution license="cc4" from="Microsoft" modified="false" />The type to use to create an instance. This type must be declared as a structure type. </param>
 132       </Docs>
 133       <AssemblyInfo>
 134         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 135         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 136       </AssemblyInfo>
 137     </Member>
 138     <Member MemberName="HWnd">
 139       <MemberSignature Language="C#" Value="public IntPtr HWnd { set; get; }" />
 140       <MemberType>Property</MemberType>
 141       <ReturnValue>
 142         <ReturnType>System.IntPtr</ReturnType>
 143       </ReturnValue>
 144       <Docs>
 145         <value>To be added.</value>
 146         <remarks>To be added.</remarks>
 147         <summary>
 148           <attribution license="cc4" from="Microsoft" modified="false" />
 149           <para>Gets or sets the window handle of the message.</para>
 150         </summary>
 151       </Docs>
 152       <AssemblyInfo>
 153         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 154         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 155       </AssemblyInfo>
 156     </Member>
 157     <Member MemberName="LParam">
 158       <MemberSignature Language="C#" Value="public IntPtr LParam { set; get; }" />
 159       <MemberType>Property</MemberType>
 160       <ReturnValue>
 161         <ReturnType>System.IntPtr</ReturnType>
 162       </ReturnValue>
 163       <Docs>
 164         <value>To be added.</value>
 165         <remarks>
 166           <attribution license="cc4" from="Microsoft" modified="false" />
 167           <para>The value of this field depends on the message. Use the <see cref="P:System.Windows.Forms.Message.LParam" /> field to get information that is important for handling the message. <see cref="P:System.Windows.Forms.Message.LParam" /> is typically used to store an object if it is needed by the message. Use the <see cref="M:System.Windows.Forms.Message.GetLParam(System.Type)" /> method to retrieve and convert information from the <see cref="P:System.Windows.Forms.Message.LParam" /> field into an object.</para>
 168         </remarks>
 169         <summary>
 170           <attribution license="cc4" from="Microsoft" modified="false" />
 171           <para>Specifies the <see cref="P:System.Windows.Forms.Message.LParam" /> field of the message.</para>
 172         </summary>
 173       </Docs>
 174       <AssemblyInfo>
 175         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 176         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 177       </AssemblyInfo>
 178     </Member>
 179     <Member MemberName="Msg">
 180       <MemberSignature Language="C#" Value="public int Msg { set; get; }" />
 181       <MemberType>Property</MemberType>
 182       <ReturnValue>
 183         <ReturnType>System.Int32</ReturnType>
 184       </ReturnValue>
 185       <Docs>
 186         <value>To be added.</value>
 187         <remarks>To be added.</remarks>
 188         <summary>
 189           <attribution license="cc4" from="Microsoft" modified="false" />
 190           <para>Gets or sets the ID number for the message.</para>
 191         </summary>
 192       </Docs>
 193       <AssemblyInfo>
 194         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 195         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 196       </AssemblyInfo>
 197     </Member>
 198     <Member MemberName="op_Equality">
 199       <MemberSignature Language="C#" Value="public static bool op_Equality (System.Windows.Forms.Message a, System.Windows.Forms.Message b);" />
 200       <MemberType>Method</MemberType>
 201       <AssemblyInfo>
 202         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 203       </AssemblyInfo>
 204       <ReturnValue>
 205         <ReturnType>System.Boolean</ReturnType>
 206       </ReturnValue>
 207       <Parameters>
 208         <Parameter Name="a" Type="System.Windows.Forms.Message" />
 209         <Parameter Name="b" Type="System.Windows.Forms.Message" />
 210       </Parameters>
 211       <Docs>
 212         <remarks>To be added.</remarks>
 213         <summary>
 214           <attribution license="cc4" from="Microsoft" modified="false" />
 215           <para>Determines whether two instances of <see cref="T:System.Windows.Forms.Message" /> are equal. </para>
 216         </summary>
 217         <returns>
 218           <attribution license="cc4" from="Microsoft" modified="false" />
 219           <para>true if <paramref name="a" /> and <paramref name="b" /> represent the same <see cref="T:System.Windows.Forms.Message" />; otherwise, false. </para>
 220         </returns>
 221         <param name="a">
 222           <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.Message" /> to compare to <paramref name="b" />.</param>
 223         <param name="b">
 224           <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.Message" /> to compare to <paramref name="a" />.</param>
 225       </Docs>
 226     </Member>
 227     <Member MemberName="op_Inequality">
 228       <MemberSignature Language="C#" Value="public static bool op_Inequality (System.Windows.Forms.Message a, System.Windows.Forms.Message b);" />
 229       <MemberType>Method</MemberType>
 230       <AssemblyInfo>
 231         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 232       </AssemblyInfo>
 233       <ReturnValue>
 234         <ReturnType>System.Boolean</ReturnType>
 235       </ReturnValue>
 236       <Parameters>
 237         <Parameter Name="a" Type="System.Windows.Forms.Message" />
 238         <Parameter Name="b" Type="System.Windows.Forms.Message" />
 239       </Parameters>
 240       <Docs>
 241         <remarks>To be added.</remarks>
 242         <summary>
 243           <attribution license="cc4" from="Microsoft" modified="false" />
 244           <para>Determines whether two instances of <see cref="T:System.Windows.Forms.Message" /> are not equal. </para>
 245         </summary>
 246         <returns>
 247           <attribution license="cc4" from="Microsoft" modified="false" />
 248           <para>true if <paramref name="a" /> and <paramref name="b" /> do not represent the same <see cref="T:System.Windows.Forms.Message" />; otherwise, false. </para>
 249         </returns>
 250         <param name="a">
 251           <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.Message" /> to compare to <paramref name="b" />.</param>
 252         <param name="b">
 253           <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.Message" /> to compare to <paramref name="a" />.</param>
 254       </Docs>
 255     </Member>
 256     <Member MemberName="Result">
 257       <MemberSignature Language="C#" Value="public IntPtr Result { set; get; }" />
 258       <MemberType>Property</MemberType>
 259       <ReturnValue>
 260         <ReturnType>System.IntPtr</ReturnType>
 261       </ReturnValue>
 262       <Docs>
 263         <value>To be added.</value>
 264         <remarks>To be added.</remarks>
 265         <summary>
 266           <attribution license="cc4" from="Microsoft" modified="false" />
 267           <para>Specifies the value that is returned to Windows in response to handling the message.</para>
 268         </summary>
 269       </Docs>
 270       <AssemblyInfo>
 271         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 272         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 273       </AssemblyInfo>
 274     </Member>
 275     <Member MemberName="ToString">
 276       <MemberSignature Language="C#" Value="public override string ToString ();" />
 277       <MemberType>Method</MemberType>
 278       <ReturnValue>
 279         <ReturnType>System.String</ReturnType>
 280       </ReturnValue>
 281       <Parameters />
 282       <Docs>
 283         <remarks>To be added.</remarks>
 284         <summary>
 285           <attribution license="cc4" from="Microsoft" modified="false" />
 286           <para>Returns a <see cref="T:System.String" /> that represents the current <see cref="T:System.Windows.Forms.Message" />.</para>
 287         </summary>
 288         <returns>
 289           <attribution license="cc4" from="Microsoft" modified="false" />
 290           <para>A <see cref="T:System.String" /> that represents the current <see cref="T:System.Windows.Forms.Message" />.</para>
 291         </returns>
 292       </Docs>
 293       <AssemblyInfo>
 294         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 295         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 296       </AssemblyInfo>
 297     </Member>
 298     <Member MemberName="WParam">
 299       <MemberSignature Language="C#" Value="public IntPtr WParam { set; get; }" />
 300       <MemberType>Property</MemberType>
 301       <ReturnValue>
 302         <ReturnType>System.IntPtr</ReturnType>
 303       </ReturnValue>
 304       <Docs>
 305         <value>To be added.</value>
 306         <remarks>
 307           <attribution license="cc4" from="Microsoft" modified="false" />
 308           <para>The value of this field depends on the message. Use the <see cref="P:System.Windows.Forms.Message.WParam" /> field to get information that is important to handling the message. This field is typically used to store small pieces of information, such as flags.</para>
 309         </remarks>
 310         <summary>
 311           <attribution license="cc4" from="Microsoft" modified="false" />
 312           <para>Gets or sets the <see cref="P:System.Windows.Forms.Message.WParam" /> field of the message.</para>
 313         </summary>
 314       </Docs>
 315       <AssemblyInfo>
 316         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 317         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 318       </AssemblyInfo>
 319     </Member>
 320   </Members>
 321 </Type>