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" />
5 <AssemblyName>System.Windows.Forms</AssemblyName>
6 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
7 <AssemblyVersion>2.0.0.0</AssemblyVersion>
10 <BaseTypeName>System.ValueType</BaseTypeName>
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>
20 <attribution license="cc4" from="Microsoft" modified="false" />
21 <para>Implements a Windows message.</para>
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>
29 <ReturnType>System.Windows.Forms.Message</ReturnType>
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" />
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>
43 <attribution license="cc4" from="Microsoft" modified="false" />
44 <para>Creates a new <see cref="T:System.Windows.Forms.Message" />.</para>
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>
51 <attribution license="cc4" from="Microsoft" modified="false" />The window handle that the message is for. </param>
53 <attribution license="cc4" from="Microsoft" modified="false" />The message ID. </param>
55 <attribution license="cc4" from="Microsoft" modified="false" />The message <paramref name="wparam" /> field. </param>
57 <attribution license="cc4" from="Microsoft" modified="false" />The message <paramref name="lparam" /> field. </param>
60 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
61 <AssemblyVersion>2.0.0.0</AssemblyVersion>
64 <Member MemberName="Equals">
65 <MemberSignature Language="C#" Value="public override bool Equals (object o);" />
66 <MemberType>Method</MemberType>
68 <ReturnType>System.Boolean</ReturnType>
71 <Parameter Name="o" Type="System.Object" />
74 <remarks>To be added.</remarks>
76 <attribution license="cc4" from="Microsoft" modified="false" />
77 <para>Determines whether the specified object is equal to the current object.</para>
80 <attribution license="cc4" from="Microsoft" modified="false" />
81 <para>true if the specified object is equal to the current object; otherwise, false.</para>
84 <attribution license="cc4" from="Microsoft" modified="false" />The object to compare with the current object.</param>
87 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
88 <AssemblyVersion>2.0.0.0</AssemblyVersion>
91 <Member MemberName="GetHashCode">
92 <MemberSignature Language="C#" Value="public override int GetHashCode ();" />
93 <MemberType>Method</MemberType>
95 <ReturnType>System.Int32</ReturnType>
99 <summary>To be added.</summary>
100 <returns>To be added.</returns>
101 <remarks>To be added.</remarks>
104 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
105 <AssemblyVersion>2.0.0.0</AssemblyVersion>
108 <Member MemberName="GetLParam">
109 <MemberSignature Language="C#" Value="public object GetLParam (Type cls);" />
110 <MemberType>Method</MemberType>
112 <ReturnType>System.Object</ReturnType>
115 <Parameter Name="cls" Type="System.Type" />
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>
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>
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>
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>
134 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
135 <AssemblyVersion>2.0.0.0</AssemblyVersion>
138 <Member MemberName="HWnd">
139 <MemberSignature Language="C#" Value="public IntPtr HWnd { set; get; }" />
140 <MemberType>Property</MemberType>
142 <ReturnType>System.IntPtr</ReturnType>
145 <value>To be added.</value>
146 <remarks>To be added.</remarks>
148 <attribution license="cc4" from="Microsoft" modified="false" />
149 <para>Gets or sets the window handle of the message.</para>
153 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
154 <AssemblyVersion>2.0.0.0</AssemblyVersion>
157 <Member MemberName="LParam">
158 <MemberSignature Language="C#" Value="public IntPtr LParam { set; get; }" />
159 <MemberType>Property</MemberType>
161 <ReturnType>System.IntPtr</ReturnType>
164 <value>To be added.</value>
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>
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>
175 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
176 <AssemblyVersion>2.0.0.0</AssemblyVersion>
179 <Member MemberName="Msg">
180 <MemberSignature Language="C#" Value="public int Msg { set; get; }" />
181 <MemberType>Property</MemberType>
183 <ReturnType>System.Int32</ReturnType>
186 <value>To be added.</value>
187 <remarks>To be added.</remarks>
189 <attribution license="cc4" from="Microsoft" modified="false" />
190 <para>Gets or sets the ID number for the message.</para>
194 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
195 <AssemblyVersion>2.0.0.0</AssemblyVersion>
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>
202 <AssemblyVersion>2.0.0.0</AssemblyVersion>
205 <ReturnType>System.Boolean</ReturnType>
208 <Parameter Name="a" Type="System.Windows.Forms.Message" />
209 <Parameter Name="b" Type="System.Windows.Forms.Message" />
212 <remarks>To be added.</remarks>
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>
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>
222 <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.Message" /> to compare to <paramref name="b" />.</param>
224 <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.Message" /> to compare to <paramref name="a" />.</param>
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>
231 <AssemblyVersion>2.0.0.0</AssemblyVersion>
234 <ReturnType>System.Boolean</ReturnType>
237 <Parameter Name="a" Type="System.Windows.Forms.Message" />
238 <Parameter Name="b" Type="System.Windows.Forms.Message" />
241 <remarks>To be added.</remarks>
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>
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>
251 <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.Message" /> to compare to <paramref name="b" />.</param>
253 <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.Message" /> to compare to <paramref name="a" />.</param>
256 <Member MemberName="Result">
257 <MemberSignature Language="C#" Value="public IntPtr Result { set; get; }" />
258 <MemberType>Property</MemberType>
260 <ReturnType>System.IntPtr</ReturnType>
263 <value>To be added.</value>
264 <remarks>To be added.</remarks>
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>
271 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
272 <AssemblyVersion>2.0.0.0</AssemblyVersion>
275 <Member MemberName="ToString">
276 <MemberSignature Language="C#" Value="public override string ToString ();" />
277 <MemberType>Method</MemberType>
279 <ReturnType>System.String</ReturnType>
283 <remarks>To be added.</remarks>
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>
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>
294 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
295 <AssemblyVersion>2.0.0.0</AssemblyVersion>
298 <Member MemberName="WParam">
299 <MemberSignature Language="C#" Value="public IntPtr WParam { set; get; }" />
300 <MemberType>Property</MemberType>
302 <ReturnType>System.IntPtr</ReturnType>
305 <value>To be added.</value>
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>
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>
316 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
317 <AssemblyVersion>2.0.0.0</AssemblyVersion>