1 <?xml version="1.0" encoding="utf-8"?>
2 <Type Name="RadioButton" FullName="System.Windows.Forms.RadioButton">
3 <TypeSignature Language="C#" Value="public class RadioButton : System.Windows.Forms.ButtonBase" />
5 <AssemblyName>System.Windows.Forms</AssemblyName>
6 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
7 <AssemblyVersion>2.0.0.0</AssemblyVersion>
10 <BaseTypeName>System.Windows.Forms.ButtonBase</BaseTypeName>
15 <AttributeName>System.ComponentModel.Designer("System.Windows.Forms.Design.RadioButtonDesigner, System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")</AttributeName>
18 <AttributeName>System.ComponentModel.ToolboxItem("System.Windows.Forms.Design.AutoSizeToolboxItem,System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")</AttributeName>
21 <AttributeName>System.ComponentModel.DefaultBindingProperty("Checked")</AttributeName>
24 <AttributeName>System.Runtime.InteropServices.ComVisible(true)</AttributeName>
27 <AttributeName>System.Runtime.InteropServices.ClassInterface(System.Runtime.InteropServices.ClassInterfaceType.AutoDispatch)</AttributeName>
30 <AttributeName>System.ComponentModel.DefaultEvent("CheckedChanged")</AttributeName>
33 <AttributeName>System.ComponentModel.DefaultProperty("Checked")</AttributeName>
38 <attribution license="cc4" from="Microsoft" modified="false" />
39 <para>The <see cref="T:System.Windows.Forms.RadioButton" /> control can display text, an <see cref="T:System.Drawing.Image" />, or both.</para>
40 <para>When the user selects one option button (also known as a radio button) within a group, the others clear automatically. All <see cref="T:System.Windows.Forms.RadioButton" /> controls in a given container, such as a <see cref="T:System.Windows.Forms.Form" />, constitute a group. To create multiple groups on one form, place each group in its own container, such as a <see cref="T:System.Windows.Forms.GroupBox" /> or <see cref="T:System.Windows.Forms.Panel" /> control.</para>
42 <see cref="T:System.Windows.Forms.RadioButton" /> and <see cref="T:System.Windows.Forms.CheckBox" /> controls have a similar function: they offer choices a user can select or clear. The difference is that multiple <see cref="T:System.Windows.Forms.CheckBox" /> controls can be selected at the same time, but option buttons are mutually exclusive.</para>
43 <para>Use the <see cref="P:System.Windows.Forms.RadioButton.Checked" /> property to get or set the state of a <see cref="T:System.Windows.Forms.RadioButton" />. The option button's appearance can be altered to appear as a toggle-style button or as a standard option button by setting the <see cref="P:System.Windows.Forms.RadioButton.Appearance" /> property.</para>
46 <attribution license="cc4" from="Microsoft" modified="false" />
47 <para>Enables the user to select a single option from a group of choices when paired with other <see cref="T:System.Windows.Forms.RadioButton" /> controls.</para>
51 <Member MemberName=".ctor">
52 <MemberSignature Language="C#" Value="public RadioButton ();" />
53 <MemberType>Constructor</MemberType>
57 <attribution license="cc4" from="Microsoft" modified="false" />
58 <para>The default view of the <see cref="T:System.Windows.Forms.RadioButton" /> has its text aligned to the right of the button and the <see cref="P:System.Windows.Forms.RadioButton.AutoCheck" /> property is set to true.</para>
61 <attribution license="cc4" from="Microsoft" modified="false" />
62 <para>Initializes a new instance of the <see cref="T:System.Windows.Forms.RadioButton" /> class.</para>
66 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
67 <AssemblyVersion>2.0.0.0</AssemblyVersion>
70 <Member MemberName="Appearance">
71 <MemberSignature Language="C#" Value="public System.Windows.Forms.Appearance Appearance { set; get; }" />
72 <MemberType>Property</MemberType>
75 <AttributeName>System.ComponentModel.Localizable(true)</AttributeName>
78 <AttributeName>System.ComponentModel.DefaultValue(System.Windows.Forms.Appearance.Normal)</AttributeName>
82 <ReturnType>System.Windows.Forms.Appearance</ReturnType>
85 <value>To be added.</value>
87 <attribution license="cc4" from="Microsoft" modified="false" />
88 <para>If the <see cref="P:System.Windows.Forms.RadioButton.Appearance" /> value is set to <see cref="F:System.Windows.Forms.Appearance.Normal" />, then the <see cref="T:System.Windows.Forms.RadioButton" /> control is drawn with a circular check box. If the value is set to <see cref="F:System.Windows.Forms.Appearance.Button" />, then the <see cref="T:System.Windows.Forms.RadioButton" /> is drawn as a control that can be toggled to an up or down state. Either type can display text, an image, or both.</para>
91 <attribution license="cc4" from="Microsoft" modified="false" />
92 <para>Gets or sets a value determining the appearance of the <see cref="T:System.Windows.Forms.RadioButton" />.</para>
96 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
97 <AssemblyVersion>2.0.0.0</AssemblyVersion>
100 <Member MemberName="AppearanceChanged">
101 <MemberSignature Language="C#" Value="public event EventHandler AppearanceChanged;" />
102 <MemberType>Event</MemberType>
104 <ReturnType>System.EventHandler</ReturnType>
108 <attribution license="cc4" from="Microsoft" modified="false" />
109 <para>For more information about handling events, see <format type="text/html"><a href="01e4f1bc-e55e-413f-98c7-6588493e5f67">Consuming Events</a></format>. </para>
112 <attribution license="cc4" from="Microsoft" modified="false" />
113 <para>Occurs when the <see cref="P:System.Windows.Forms.RadioButton.Appearance" /> property value changes.</para>
117 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
118 <AssemblyVersion>2.0.0.0</AssemblyVersion>
121 <Member MemberName="AutoCheck">
122 <MemberSignature Language="C#" Value="public bool AutoCheck { set; get; }" />
123 <MemberType>Property</MemberType>
126 <AttributeName>System.ComponentModel.DefaultValue(true)</AttributeName>
130 <ReturnType>System.Boolean</ReturnType>
133 <value>To be added.</value>
135 <attribution license="cc4" from="Microsoft" modified="false" />
136 <para>If the <see cref="P:System.Windows.Forms.RadioButton.Checked" /> value is set to false, the <see cref="T:System.Windows.Forms.RadioButton" /> portion of the control must be checked in code in the <see cref="E:System.Windows.Forms.Control.Click" /> event handler. In addition, if the <see cref="T:System.Windows.Forms.RadioButton" /> is part of a <see cref="T:System.Windows.Forms.RadioButton" /> control group, this property ensures that only one of the controls is checked at a given time.</para>
137 <para>If the <see cref="P:System.Windows.Forms.RadioButton.AutoCheck" /> property is set to false, a group of <see cref="T:System.Windows.Forms.RadioButton" /> controls will not act as a mutually exclusive group and the <see cref="P:System.Windows.Forms.RadioButton.Checked" /> property must be updated in code.</para>
140 <attribution license="cc4" from="Microsoft" modified="false" />
141 <para>Gets or sets a value indicating whether the <see cref="P:System.Windows.Forms.RadioButton.Checked" /> value and the appearance of the control automatically change when the control is clicked.</para>
145 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
146 <AssemblyVersion>2.0.0.0</AssemblyVersion>
149 <Member MemberName="CheckAlign">
150 <MemberSignature Language="C#" Value="public System.Drawing.ContentAlignment CheckAlign { set; get; }" />
151 <MemberType>Property</MemberType>
154 <AttributeName>System.ComponentModel.DefaultValue(System.Drawing.ContentAlignment.MiddleLeft)</AttributeName>
157 <AttributeName>System.ComponentModel.Localizable(true)</AttributeName>
161 <ReturnType>System.Drawing.ContentAlignment</ReturnType>
164 <value>To be added.</value>
165 <remarks>To be added.</remarks>
167 <attribution license="cc4" from="Microsoft" modified="false" />
168 <para>Gets or sets the location of the check box portion of the <see cref="T:System.Windows.Forms.RadioButton" />.</para>
172 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
173 <AssemblyVersion>2.0.0.0</AssemblyVersion>
176 <Member MemberName="Checked">
177 <MemberSignature Language="C#" Value="public bool Checked { set; get; }" />
178 <MemberType>Property</MemberType>
181 <AttributeName>System.ComponentModel.Bindable(true, System.ComponentModel.BindingDirection.OneWay)</AttributeName>
184 <AttributeName>System.ComponentModel.SettingsBindable(true)</AttributeName>
187 <AttributeName>System.ComponentModel.DefaultValue(false)</AttributeName>
191 <ReturnType>System.Boolean</ReturnType>
194 <value>To be added.</value>
195 <remarks>To be added.</remarks>
197 <attribution license="cc4" from="Microsoft" modified="false" />
198 <para>Gets or sets a value indicating whether the control is checked.</para>
202 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
203 <AssemblyVersion>2.0.0.0</AssemblyVersion>
206 <Member MemberName="CheckedChanged">
207 <MemberSignature Language="C#" Value="public event EventHandler CheckedChanged;" />
208 <MemberType>Event</MemberType>
210 <ReturnType>System.EventHandler</ReturnType>
214 <attribution license="cc4" from="Microsoft" modified="false" />
215 <para>For more information about handling events, see <format type="text/html"><a href="01e4f1bc-e55e-413f-98c7-6588493e5f67">Consuming Events</a></format>. </para>
218 <attribution license="cc4" from="Microsoft" modified="false" />
219 <para>Occurs when the value of the <see cref="P:System.Windows.Forms.RadioButton.Checked" /> property changes.</para>
223 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
224 <AssemblyVersion>2.0.0.0</AssemblyVersion>
227 <Member MemberName="CreateAccessibilityInstance">
228 <MemberSignature Language="C#" Value="protected override System.Windows.Forms.AccessibleObject CreateAccessibilityInstance ();" />
229 <MemberType>Method</MemberType>
231 <ReturnType>System.Windows.Forms.AccessibleObject</ReturnType>
236 <attribution license="cc4" from="Microsoft" modified="false" />
237 <para>If you do not explicitly call the <see cref="M:System.Windows.Forms.RadioButton.CreateAccessibilityInstance" /> method, it will be called when the <see cref="P:System.Windows.Forms.Control.AccessibilityObject" /> property is referenced.</para>
238 <block subset="none" type="note">
239 <para>To get or set the <see cref="P:System.Windows.Forms.Control.AccessibilityObject" /> property, you must add a reference to the <see cref="N:Accessibility" /> assembly installed with the .NET Framework. </para>
243 <attribution license="cc4" from="Microsoft" modified="false" />
244 <para>Creates a new accessibility object for the <see cref="T:System.Windows.Forms.RadioButton" /> control.</para>
247 <attribution license="cc4" from="Microsoft" modified="false" />
248 <para>A new <see cref="T:System.Windows.Forms.RadioButton.RadioButtonAccessibleObject" /> for the control.</para>
252 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
253 <AssemblyVersion>2.0.0.0</AssemblyVersion>
256 <Member MemberName="CreateParams">
257 <MemberSignature Language="C#" Value="protected override System.Windows.Forms.CreateParams CreateParams { get; }" />
258 <MemberType>Property</MemberType>
260 <ReturnType>System.Windows.Forms.CreateParams</ReturnType>
263 <value>To be added.</value>
264 <remarks>To be added.</remarks>
266 <attribution license="cc4" from="Microsoft" modified="false" />
267 <para>Gets the required creation parameters when the control handle is created.</para>
271 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
272 <AssemblyVersion>2.0.0.0</AssemblyVersion>
275 <Member MemberName="DefaultSize">
276 <MemberSignature Language="C#" Value="protected override System.Drawing.Size DefaultSize { get; }" />
277 <MemberType>Property</MemberType>
279 <ReturnType>System.Drawing.Size</ReturnType>
282 <value>To be added.</value>
283 <remarks>To be added.</remarks>
285 <attribution license="cc4" from="Microsoft" modified="false" />
286 <para>Gets the default size of the control.</para>
290 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
291 <AssemblyVersion>2.0.0.0</AssemblyVersion>
294 <Member MemberName="DoubleClick">
295 <MemberSignature Language="C#" Value="public event EventHandler DoubleClick;" />
296 <MemberType>Event</MemberType>
299 <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)</AttributeName>
302 <AttributeName>System.ComponentModel.Browsable(false)</AttributeName>
306 <ReturnType>System.EventHandler</ReturnType>
310 <attribution license="cc4" from="Microsoft" modified="false" />
311 <para>By default, the <see cref="F:System.Windows.Forms.ControlStyles.StandardClick" /> style bit is set to false for the <see cref="T:System.Windows.Forms.RadioButton" /> control, and the <see cref="E:System.Windows.Forms.RadioButton.DoubleClick" /> event is not raised. </para>
314 <attribution license="cc4" from="Microsoft" modified="false" />
315 <para>Occurs when the user double-clicks the <see cref="T:System.Windows.Forms.RadioButton" /> control.</para>
319 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
320 <AssemblyVersion>2.0.0.0</AssemblyVersion>
323 <Member MemberName="MouseDoubleClick">
324 <MemberSignature Language="C#" Value="public event System.Windows.Forms.MouseEventHandler MouseDoubleClick;" />
325 <MemberType>Event</MemberType>
327 <AssemblyVersion>2.0.0.0</AssemblyVersion>
331 <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)</AttributeName>
334 <AttributeName>System.ComponentModel.Browsable(false)</AttributeName>
338 <ReturnType>System.Windows.Forms.MouseEventHandler</ReturnType>
342 <attribution license="cc4" from="Microsoft" modified="false" />
343 <para>By default, the <see cref="F:System.Windows.Forms.ControlStyles.StandardClick" /> style bit is set to false for the <see cref="T:System.Windows.Forms.RadioButton" /> control, and the <see cref="E:System.Windows.Forms.RadioButton.MouseDoubleClick" /> event is not raised.</para>
346 <attribution license="cc4" from="Microsoft" modified="false" />
347 <para>Occurs when the user double-clicks the <see cref="T:System.Windows.Forms.RadioButton" /> control with the mouse.</para>
351 <Member MemberName="OnCheckedChanged">
352 <MemberSignature Language="C#" Value="protected virtual void OnCheckedChanged (EventArgs e);" />
353 <MemberType>Method</MemberType>
355 <ReturnType>System.Void</ReturnType>
358 <Parameter Name="e" Type="System.EventArgs" />
362 <attribution license="cc4" from="Microsoft" modified="false" />
363 <para>Raising an event invokes the event handler through a delegate. For more information, see <format type="text/html"><a href="f2adaf01-1ed1-42e1-8c31-8d467e7e0ee2">Raising an Event</a></format>.</para>
364 <para>The <see cref="M:System.Windows.Forms.RadioButton.OnCheckedChanged(System.EventArgs)" /> method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.</para>
367 <attribution license="cc4" from="Microsoft" modified="false" />
368 <para>Raises the <see cref="E:System.Windows.Forms.CheckBox.CheckedChanged" /> event.</para>
371 <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.EventArgs" /> that contains the event data. </param>
374 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
375 <AssemblyVersion>2.0.0.0</AssemblyVersion>
378 <Member MemberName="OnClick">
379 <MemberSignature Language="C#" Value="protected override void OnClick (EventArgs e);" />
380 <MemberType>Method</MemberType>
382 <ReturnType>System.Void</ReturnType>
385 <Parameter Name="e" Type="System.EventArgs" />
389 <attribution license="cc4" from="Microsoft" modified="false" />
390 <para>If the <see cref="P:System.Windows.Forms.RadioButton.AutoCheck" /> property is set to true, the <see cref="P:System.Windows.Forms.RadioButton.Checked" /> property is set to true when the <see cref="T:System.Windows.Forms.RadioButton" /> control is clicked.</para>
393 <attribution license="cc4" from="Microsoft" modified="false" />
394 <para>Raises the <see cref="E:System.Windows.Forms.Control.Click" /> event.</para>
397 <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.EventArgs" /> that contains the event data.</param>
400 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
401 <AssemblyVersion>2.0.0.0</AssemblyVersion>
404 <Member MemberName="OnEnter">
405 <MemberSignature Language="C#" Value="protected override void OnEnter (EventArgs e);" />
406 <MemberType>Method</MemberType>
408 <ReturnType>System.Void</ReturnType>
411 <Parameter Name="e" Type="System.EventArgs" />
415 <attribution license="cc4" from="Microsoft" modified="false" />
416 <para>If the user enters the <see cref="T:System.Windows.Forms.RadioButton" /> control by using the arrow keys, the <see cref="T:System.Windows.Forms.RadioButton" /> will raise the <see cref="E:System.Windows.Forms.Control.Click" /> event.</para>
419 <attribution license="cc4" from="Microsoft" modified="false" />
420 <para>Raises the <see cref="E:System.Windows.Forms.Control.Enter" /> event.</para>
423 <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.EventArgs" /> that contains the event data.</param>
426 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
427 <AssemblyVersion>2.0.0.0</AssemblyVersion>
430 <Member MemberName="OnHandleCreated">
431 <MemberSignature Language="C#" Value="protected override void OnHandleCreated (EventArgs e);" />
432 <MemberType>Method</MemberType>
434 <ReturnType>System.Void</ReturnType>
437 <Parameter Name="e" Type="System.EventArgs" />
440 <remarks>To be added.</remarks>
442 <attribution license="cc4" from="Microsoft" modified="false" />
443 <para>Overrides the <see cref="M:System.Windows.Forms.Control.OnHandleCreated(System.EventArgs)" /> method.</para>
446 <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.EventArgs" /> that contains the event data.</param>
449 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
450 <AssemblyVersion>2.0.0.0</AssemblyVersion>
453 <Member MemberName="OnMouseUp">
454 <MemberSignature Language="C#" Value="protected override void OnMouseUp (System.Windows.Forms.MouseEventArgs mevent);" />
455 <MemberType>Method</MemberType>
457 <ReturnType>System.Void</ReturnType>
460 <Parameter Name="mevent" Type="System.Windows.Forms.MouseEventArgs" />
464 <attribution license="cc4" from="Microsoft" modified="false" />
465 <para>Raising an event invokes the event handler through a delegate. For more information, see <format type="text/html"><a href="F2ADAF01-1ED1-42E1-8C31-8D467E7E0EE2">Raising an Event</a></format>.</para>
466 <para>The <see cref="M:System.Windows.Forms.RadioButton.OnMouseUp(System.Windows.Forms.MouseEventArgs)" /> method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.</para>
469 <attribution license="cc4" from="Microsoft" modified="false" />
470 <para>Raises the <see cref="E:System.Windows.Forms.Control.MouseUp" /> event.</para>
472 <param name="mevent">
473 <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.MouseEventArgs" /> that contains the event data. </param>
476 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
477 <AssemblyVersion>2.0.0.0</AssemblyVersion>
480 <Member MemberName="PerformClick">
481 <MemberSignature Language="C#" Value="public void PerformClick ();" />
482 <MemberType>Method</MemberType>
484 <ReturnType>System.Void</ReturnType>
488 <remarks>To be added.</remarks>
490 <attribution license="cc4" from="Microsoft" modified="false" />
491 <para>Generates a <see cref="E:System.Windows.Forms.Control.Click" /> event for the control, simulating a click by a user.</para>
495 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
496 <AssemblyVersion>2.0.0.0</AssemblyVersion>
499 <Member MemberName="ProcessMnemonic">
500 <MemberSignature Language="C#" Value="protected override bool ProcessMnemonic (char charCode);" />
501 <MemberType>Method</MemberType>
503 <ReturnType>System.Boolean</ReturnType>
506 <Parameter Name="charCode" Type="System.Char" />
509 <remarks>To be added.</remarks>
511 <attribution license="cc4" from="Microsoft" modified="false" />
512 <para>Overrides the <see cref="M:System.Windows.Forms.Control.ProcessMnemonic(System.Char)" /> method.</para>
515 <attribution license="cc4" from="Microsoft" modified="false" />
516 <para>true if the character was successfully processed; otherwise, false.</para>
518 <param name="charCode">
519 <attribution license="cc4" from="Microsoft" modified="false" />The character to process.</param>
522 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
523 <AssemblyVersion>2.0.0.0</AssemblyVersion>
526 <Member MemberName="TabStop">
527 <MemberSignature Language="C#" Value="public bool TabStop { set; get; }" />
528 <MemberType>Property</MemberType>
531 <AttributeName>System.ComponentModel.DefaultValue(false)</AttributeName>
535 <ReturnType>System.Boolean</ReturnType>
538 <value>To be added.</value>
539 <remarks>To be added.</remarks>
541 <attribution license="cc4" from="Microsoft" modified="false" />
542 <para>Gets or sets a value indicating whether the user can give the focus to this control using the TAB key.</para>
546 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
547 <AssemblyVersion>2.0.0.0</AssemblyVersion>
550 <Member MemberName="TextAlign">
551 <MemberSignature Language="C#" Value="public override System.Drawing.ContentAlignment TextAlign { set; get; }" />
552 <MemberType>Property</MemberType>
555 <AttributeName>System.ComponentModel.Localizable(true)</AttributeName>
558 <AttributeName>System.ComponentModel.DefaultValue(System.Drawing.ContentAlignment.MiddleLeft)</AttributeName>
562 <ReturnType>System.Drawing.ContentAlignment</ReturnType>
565 <value>To be added.</value>
566 <remarks>To be added.</remarks>
568 <attribution license="cc4" from="Microsoft" modified="false" />
569 <para>Gets or sets the alignment of the text on the <see cref="T:System.Windows.Forms.RadioButton" /> control.</para>
573 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
574 <AssemblyVersion>2.0.0.0</AssemblyVersion>
577 <Member MemberName="ToString">
578 <MemberSignature Language="C#" Value="public override string ToString ();" />
579 <MemberType>Method</MemberType>
581 <ReturnType>System.String</ReturnType>
585 <remarks>To be added.</remarks>
587 <attribution license="cc4" from="Microsoft" modified="false" />
588 <para>Overrides the <see cref="M:System.ComponentModel.Component.ToString" /> method.</para>
591 <attribution license="cc4" from="Microsoft" modified="false" />
592 <para>A string representation of the <see cref="T:System.Windows.Forms.RadioButton" /> that indicates whether it is checked.</para>
596 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
597 <AssemblyVersion>2.0.0.0</AssemblyVersion>