a575963da9
Former-commit-id: da6be194a6b1221998fc28233f2503bd61dd9d14
748 lines
39 KiB
XML
748 lines
39 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<Type Name="CheckBox" FullName="System.Windows.Forms.CheckBox">
|
|
<TypeSignature Language="C#" Value="public class CheckBox : System.Windows.Forms.ButtonBase" />
|
|
<AssemblyInfo>
|
|
<AssemblyName>System.Windows.Forms</AssemblyName>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Base>
|
|
<BaseTypeName>System.Windows.Forms.ButtonBase</BaseTypeName>
|
|
</Base>
|
|
<Interfaces />
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.ToolboxItem("System.Windows.Forms.Design.AutoSizeToolboxItem,System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")</AttributeName>
|
|
</Attribute>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.DefaultBindingProperty("CheckState")</AttributeName>
|
|
</Attribute>
|
|
<Attribute>
|
|
<AttributeName>System.Runtime.InteropServices.ClassInterface(System.Runtime.InteropServices.ClassInterfaceType.AutoDispatch)</AttributeName>
|
|
</Attribute>
|
|
<Attribute>
|
|
<AttributeName>System.Runtime.InteropServices.ComVisible(true)</AttributeName>
|
|
</Attribute>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.DefaultEvent("CheckedChanged")</AttributeName>
|
|
</Attribute>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.DefaultProperty("Checked")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Use a <see cref="T:System.Windows.Forms.CheckBox" /> to give the user an option, such as true/false or yes/no. The <see cref="T:System.Windows.Forms.CheckBox" /> control can display an image or text or both.</para>
|
|
<para>
|
|
<see cref="T:System.Windows.Forms.CheckBox" /> and <see cref="T:System.Windows.Forms.RadioButton" /> controls have a similar function: they allow the user to choose from a list of options. <see cref="T:System.Windows.Forms.CheckBox" /> controls let the user pick a combination of options. In contrast, <see cref="T:System.Windows.Forms.RadioButton" /> controls allow a user to choose from mutually exclusive options.</para>
|
|
<para>The <see cref="P:System.Windows.Forms.CheckBox.Appearance" /> property determines whether the <see cref="T:System.Windows.Forms.CheckBox" /> appears as a typical <see cref="T:System.Windows.Forms.CheckBox" /> or as a button.</para>
|
|
<para>The <see cref="P:System.Windows.Forms.CheckBox.ThreeState" /> property determines whether the control supports two or three states. Use the <see cref="P:System.Windows.Forms.CheckBox.Checked" /> property to get or set the value of a two-state <see cref="T:System.Windows.Forms.CheckBox" /> control and use the <see cref="P:System.Windows.Forms.CheckBox.CheckState" /> property to get or set the value of a three-state <see cref="T:System.Windows.Forms.CheckBox" /> control.</para>
|
|
<block subset="none" type="note">
|
|
<para>If the <see cref="P:System.Windows.Forms.CheckBox.ThreeState" /> property is set to true, the <see cref="P:System.Windows.Forms.CheckBox.Checked" /> property will return true for either a checked or indeterminate state.</para>
|
|
</block>
|
|
<para>The <see cref="P:System.Windows.Forms.ButtonBase.FlatStyle" /> property determines the style and appearance of the control. If the <see cref="P:System.Windows.Forms.ButtonBase.FlatStyle" /> property is set to <see cref="F:System.Windows.Forms.FlatStyle.System" />, the user's operating system determines the appearance of the control.</para>
|
|
<block subset="none" type="note">
|
|
<para>When the <see cref="P:System.Windows.Forms.ButtonBase.FlatStyle" /> property is set to <see cref="F:System.Windows.Forms.FlatStyle.System" />, the <see cref="P:System.Windows.Forms.CheckBox.CheckAlign" /> property is ignored and the control is displayed using the <see cref="F:System.Drawing.ContentAlignment.MiddleLeft" /> or <see cref="F:System.Drawing.ContentAlignment.MiddleRight" /> alignment. If the <see cref="P:System.Windows.Forms.CheckBox.CheckAlign" /> property is set to one of the right alignments, the control is displayed using the <see cref="F:System.Drawing.ContentAlignment.MiddleRight" /> alignment; otherwise, it is displayed using the <see cref="F:System.Drawing.ContentAlignment.MiddleLeft" /> alignment.</para>
|
|
</block>
|
|
<para>The following describes an indeterminate state: You have a <see cref="T:System.Windows.Forms.CheckBox" /> that determines if the selected text in a <see cref="T:System.Windows.Forms.RichTextBox" /> is bold. When you select text you can click the <see cref="T:System.Windows.Forms.CheckBox" /> to bold the selection. Likewise, when you select some text, the <see cref="T:System.Windows.Forms.CheckBox" /> displays whether the selected text is bold. If your selected text contains text that is bold and normal, the <see cref="T:System.Windows.Forms.CheckBox" /> will have an indeterminate state.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Represents a Windows <see cref="T:System.Windows.Forms.CheckBox" />.</para>
|
|
</summary>
|
|
</Docs>
|
|
<Members>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public CheckBox ();" />
|
|
<MemberType>Constructor</MemberType>
|
|
<Parameters />
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>By default, when a new <see cref="T:System.Windows.Forms.CheckBox" /> is instantiated, <see cref="P:System.Windows.Forms.CheckBox.AutoCheck" /> is set to true, <see cref="P:System.Windows.Forms.CheckBox.Checked" /> is set to false, and <see cref="P:System.Windows.Forms.CheckBox.Appearance" /> is set to <see cref="F:System.Windows.Forms.Appearance.Normal" />.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Initializes a new instance of the <see cref="T:System.Windows.Forms.CheckBox" /> class.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="Appearance">
|
|
<MemberSignature Language="C#" Value="public System.Windows.Forms.Appearance Appearance { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.Localizable(true)</AttributeName>
|
|
</Attribute>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.DefaultValue(System.Windows.Forms.Appearance.Normal)</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
<ReturnValue>
|
|
<ReturnType>System.Windows.Forms.Appearance</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>If <see cref="P:System.Windows.Forms.CheckBox.Appearance" /> value is set to <see cref="F:System.Windows.Forms.Appearance.Normal" />, the <see cref="T:System.Windows.Forms.CheckBox" /> has a typical appearance. If the value is set to Button, the <see cref="T:System.Windows.Forms.CheckBox" /> appears like a toggle button, which can be toggled to an up or down state.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the value that determines the appearance of a <see cref="T:System.Windows.Forms.CheckBox" /> control.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="AppearanceChanged">
|
|
<MemberSignature Language="C#" Value="public event EventHandler AppearanceChanged;" />
|
|
<MemberType>Event</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.EventHandler</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>For more information about handling events, see <format type="text/html"><a href="01E4F1BC-E55E-413F-98C7-6588493E5F67">Consuming Events</a></format>.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Occurs when the value of the <see cref="P:System.Windows.Forms.CheckBox.Appearance" /> property changes.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="AutoCheck">
|
|
<MemberSignature Language="C#" Value="public bool AutoCheck { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.DefaultValue(true)</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>If <see cref="P:System.Windows.Forms.CheckBox.AutoCheck" /> is set to false, you will need to add code to update the <see cref="P:System.Windows.Forms.CheckBox.Checked" /> or <see cref="P:System.Windows.Forms.CheckBox.CheckState" /> values in the <see cref="E:System.Windows.Forms.Control.Click" /> event handler.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or set a value indicating whether the <see cref="P:System.Windows.Forms.CheckBox.Checked" /> or <see cref="P:System.Windows.Forms.CheckBox.CheckState" /> values and the <see cref="T:System.Windows.Forms.CheckBox" />'s appearance are automatically changed when the <see cref="T:System.Windows.Forms.CheckBox" /> is clicked.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="CheckAlign">
|
|
<MemberSignature Language="C#" Value="public System.Drawing.ContentAlignment CheckAlign { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.DefaultValue(System.Drawing.ContentAlignment.MiddleLeft)</AttributeName>
|
|
</Attribute>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.Localizable(true)</AttributeName>
|
|
</Attribute>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.Bindable(true)</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
<ReturnValue>
|
|
<ReturnType>System.Drawing.ContentAlignment</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the horizontal and vertical alignment of the check mark on a <see cref="T:System.Windows.Forms.CheckBox" /> control.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="Checked">
|
|
<MemberSignature Language="C#" Value="public bool Checked { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.SettingsBindable(true)</AttributeName>
|
|
</Attribute>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.DefaultValue(false)</AttributeName>
|
|
</Attribute>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.RefreshProperties(System.ComponentModel.RefreshProperties.All)</AttributeName>
|
|
</Attribute>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.Bindable(true)</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>When the value is true, the <see cref="T:System.Windows.Forms.CheckBox" /> portion of the control displays a check mark. If the <see cref="P:System.Windows.Forms.CheckBox.Appearance" /> property is set to Button, the control will appear sunken when <see cref="P:System.Windows.Forms.CheckBox.Checked" /> is true and raised like a standard button when false.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or set a value indicating whether the <see cref="T:System.Windows.Forms.CheckBox" /> is in the checked state.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="CheckedChanged">
|
|
<MemberSignature Language="C#" Value="public event EventHandler CheckedChanged;" />
|
|
<MemberType>Event</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.EventHandler</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>For more information about handling events, see <format type="text/html"><a href="01E4F1BC-E55E-413F-98C7-6588493E5F67">Consuming Events</a></format>.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Occurs when the value of the <see cref="P:System.Windows.Forms.CheckBox.Checked" /> property changes.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="CheckState">
|
|
<MemberSignature Language="C#" Value="public System.Windows.Forms.CheckState CheckState { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.Bindable(true)</AttributeName>
|
|
</Attribute>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.RefreshProperties(System.ComponentModel.RefreshProperties.All)</AttributeName>
|
|
</Attribute>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.DefaultValue(System.Windows.Forms.CheckState.Unchecked)</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
<ReturnValue>
|
|
<ReturnType>System.Windows.Forms.CheckState</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>If the <see cref="P:System.Windows.Forms.CheckBox.ThreeState" /> property is set to false, the <see cref="P:System.Windows.Forms.CheckBox.CheckState" /> property value can only be set to CheckState.Indeterminate in code and not by user interaction.</para>
|
|
<para>The following table describes the <see cref="T:System.Windows.Forms.Appearance" /> of the <see cref="T:System.Windows.Forms.CheckBox" /> control in its different states for the Normal and Button style control <see cref="P:System.Windows.Forms.CheckBox.Appearance" />.</para>
|
|
<list type="table">
|
|
<listheader>
|
|
<item>
|
|
<term>
|
|
<para>CheckState </para>
|
|
</term>
|
|
<description>
|
|
<para>Appearance.Normal </para>
|
|
</description>
|
|
<description>
|
|
<para>Appearance.Button </para>
|
|
</description>
|
|
</item>
|
|
</listheader>
|
|
<item>
|
|
<term>
|
|
<para>Checked </para>
|
|
</term>
|
|
<description>
|
|
<para>The <see cref="T:System.Windows.Forms.CheckBox" /> displays a check mark. </para>
|
|
</description>
|
|
<description>
|
|
<para>The control appears sunken. </para>
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<term>
|
|
<para>Unchecked </para>
|
|
</term>
|
|
<description>
|
|
<para>The <see cref="T:System.Windows.Forms.CheckBox" /> is empty. </para>
|
|
</description>
|
|
<description>
|
|
<para>The control appears raised. </para>
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<term>
|
|
<para>Indeterminate </para>
|
|
</term>
|
|
<description>
|
|
<para>The <see cref="T:System.Windows.Forms.CheckBox" /> displays a check mark and is shaded. </para>
|
|
</description>
|
|
<description>
|
|
<para>The control appears flat. </para>
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the state of the <see cref="T:System.Windows.Forms.CheckBox" />.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="CheckStateChanged">
|
|
<MemberSignature Language="C#" Value="public event EventHandler CheckStateChanged;" />
|
|
<MemberType>Event</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.EventHandler</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>For more information about handling events, see <format type="text/html"><a href="01E4F1BC-E55E-413F-98C7-6588493E5F67">Consuming Events</a></format>.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Occurs when the value of the <see cref="P:System.Windows.Forms.CheckBox.CheckState" /> property changes.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="CreateAccessibilityInstance">
|
|
<MemberSignature Language="C#" Value="protected override System.Windows.Forms.AccessibleObject CreateAccessibilityInstance ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Windows.Forms.AccessibleObject</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>If you do not explicitly call the <see cref="M:System.Windows.Forms.CheckBox.CreateAccessibilityInstance" /> method, it will be called when the <see cref="P:System.Windows.Forms.Control.AccessibilityObject" /> property is referenced.</para>
|
|
<block subset="none" type="note">
|
|
<para>To get or set the <see cref="P:System.Windows.Forms.Control.AccessibilityObject" /> property, you must add a reference to the Accessibility assembly installed with the .NET Framework.</para>
|
|
</block>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Creates a new accessibility object for the <see cref="T:System.Windows.Forms.CheckBox" /> control.</para>
|
|
</summary>
|
|
<returns>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>A new <see cref="T:System.Windows.Forms.CheckBox.CheckBoxAccessibleObject" /> for the control.</para>
|
|
</returns>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="CreateParams">
|
|
<MemberSignature Language="C#" Value="protected override System.Windows.Forms.CreateParams CreateParams { get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Windows.Forms.CreateParams</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets the required creation parameters when the control handle is created.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="DefaultSize">
|
|
<MemberSignature Language="C#" Value="protected override System.Drawing.Size DefaultSize { get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Drawing.Size</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets the default size of the control.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="DoubleClick">
|
|
<MemberSignature Language="C#" Value="public event EventHandler DoubleClick;" />
|
|
<MemberType>Event</MemberType>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)</AttributeName>
|
|
</Attribute>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.Browsable(false)</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
<ReturnValue>
|
|
<ReturnType>System.EventHandler</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>By default, the <see cref="F:System.Windows.Forms.ControlStyles.StandardClick" /> and <see cref="F:System.Windows.Forms.ControlStyles.StandardDoubleClick" /> enumerations are set to false for the <see cref="T:System.Windows.Forms.CheckBox" /> control, and the <see cref="E:System.Windows.Forms.CheckBox.DoubleClick" /> event is not raised.</para>
|
|
<para>This event is not relevant to this class.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Occurs when the user double-clicks the <see cref="T:System.Windows.Forms.CheckBox" /> control.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="MouseDoubleClick">
|
|
<MemberSignature Language="C#" Value="public event System.Windows.Forms.MouseEventHandler MouseDoubleClick;" />
|
|
<MemberType>Event</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)</AttributeName>
|
|
</Attribute>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.Browsable(false)</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
<ReturnValue>
|
|
<ReturnType>System.Windows.Forms.MouseEventHandler</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>By default, the <see cref="F:System.Windows.Forms.ControlStyles.StandardClick" /> and <see cref="F:System.Windows.Forms.ControlStyles.StandardDoubleClick" /> style bits are set to false for the <see cref="T:System.Windows.Forms.CheckBox" /> control, and the <see cref="E:System.Windows.Forms.CheckBox.MouseDoubleClick" /> event is not raised.</para>
|
|
<para>This event is not relevant to this class.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Occurs when the user double-clicks the <see cref="T:System.Windows.Forms.CheckBox" /> control.</para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="OnAppearanceChanged">
|
|
<MemberSignature Language="C#" Value="protected virtual void OnAppearanceChanged (EventArgs e);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="e" Type="System.EventArgs" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<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>
|
|
<para>The <see cref="M:System.Windows.Forms.CheckBox.OnAppearanceChanged(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>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Raises the <see cref="E:System.Windows.Forms.CheckBox.AppearanceChanged" /> event.</para>
|
|
</summary>
|
|
<param name="e">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.EventArgs" /> that contains the event data. </param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="OnCheckedChanged">
|
|
<MemberSignature Language="C#" Value="protected virtual void OnCheckedChanged (EventArgs e);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="e" Type="System.EventArgs" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<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>
|
|
<para>The <see cref="M:System.Windows.Forms.CheckBox.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>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Raises the <see cref="E:System.Windows.Forms.CheckBox.CheckedChanged" /> event.</para>
|
|
</summary>
|
|
<param name="e">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.EventArgs" /> that contains the event data. </param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="OnCheckStateChanged">
|
|
<MemberSignature Language="C#" Value="protected virtual void OnCheckStateChanged (EventArgs e);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="e" Type="System.EventArgs" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<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>
|
|
<para>The <see cref="M:System.Windows.Forms.CheckBox.OnCheckStateChanged(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>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Raises the <see cref="E:System.Windows.Forms.CheckBox.CheckStateChanged" /> event.</para>
|
|
</summary>
|
|
<param name="e">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.EventArgs" /> that contains the event data. </param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="OnClick">
|
|
<MemberSignature Language="C#" Value="protected override void OnClick (EventArgs e);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="e" Type="System.EventArgs" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="M:System.Windows.Forms.CheckBox.OnClick(System.EventArgs)" /> method changes the <see cref="P:System.Windows.Forms.CheckBox.CheckState" /> property. If the <see cref="P:System.Windows.Forms.CheckBox.ThreeState" /> property is set to true, subsequent clicks of the <see cref="T:System.Windows.Forms.CheckBox" /> will result in <see cref="M:System.Windows.Forms.CheckBox.OnClick(System.EventArgs)" /> cycling through all the values of the <see cref="P:System.Windows.Forms.CheckBox.CheckState" /> enumeration. Otherwise, <see cref="M:System.Windows.Forms.CheckBox.OnClick(System.EventArgs)" /> switches between <see cref="F:System.Windows.Forms.CheckState.Checked" /> and <see cref="F:System.Windows.Forms.CheckState.Unchecked" />.</para>
|
|
<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>
|
|
<para>The <see cref="M:System.Windows.Forms.CheckBox.OnClick(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>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Raises the <see cref="E:System.Windows.Forms.Control.Click" /> event.</para>
|
|
</summary>
|
|
<param name="e">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.EventArgs" /> that contains the event data. </param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="OnHandleCreated">
|
|
<MemberSignature Language="C#" Value="protected override void OnHandleCreated (EventArgs e);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="e" Type="System.EventArgs" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="e">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="OnKeyDown">
|
|
<MemberSignature Language="C#" Value="protected override void OnKeyDown (System.Windows.Forms.KeyEventArgs e);" />
|
|
<MemberType>Method</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="e" Type="System.Windows.Forms.KeyEventArgs" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
<param name="e">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />Contains data for the event.</param>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="OnMouseUp">
|
|
<MemberSignature Language="C#" Value="protected override void OnMouseUp (System.Windows.Forms.MouseEventArgs mevent);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="mevent" Type="System.Windows.Forms.MouseEventArgs" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="mevent">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="ProcessMnemonic">
|
|
<MemberSignature Language="C#" Value="protected override bool ProcessMnemonic (char charCode);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="charCode" Type="System.Char" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>This method is called to give a control the opportunity to process a mnemonic character. The method should determine whether the control is in a state to process mnemonics and if whether the given character represents a mnemonic. If so, the method should perform the action associated with the mnemonic and return true. If not, the method should return false. Implementations of this method often use the <see cref="M:System.Windows.Forms.Control.IsMnemonic(System.Char,System.String)" /> method to determine whether the given character matches a mnemonic in the control's text.</para>
|
|
<para>For example: </para>
|
|
<code>if (CanSelect && IsMnemonic(charCode, MyControl.Text) {
|
|
// Perform action associated with mnemonic.
|
|
}</code>
|
|
<para>This default implementation of the <see cref="M:System.Windows.Forms.Control.ProcessMnemonic(System.Char)" /> method simply returns false to indicate that the control has no mnemonic.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Processes a mnemonic character.</para>
|
|
</summary>
|
|
<returns>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>true if the character was processed as a mnemonic by the control; otherwise, false.</para>
|
|
</returns>
|
|
<param name="charCode">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The character to process.</param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="TextAlign">
|
|
<MemberSignature Language="C#" Value="public override System.Drawing.ContentAlignment TextAlign { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.Localizable(true)</AttributeName>
|
|
</Attribute>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.DefaultValue(System.Drawing.ContentAlignment.MiddleLeft)</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
<ReturnValue>
|
|
<ReturnType>System.Drawing.ContentAlignment</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the alignment of the text on the <see cref="T:System.Windows.Forms.CheckBox" /> control.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="ThreeState">
|
|
<MemberSignature Language="C#" Value="public bool ThreeState { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.DefaultValue(false)</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>If the <see cref="P:System.Windows.Forms.CheckBox.ThreeState" /> property is set to false, the <see cref="P:System.Windows.Forms.CheckBox.CheckState" /> property value can only be set to the Indeterminate value of <see cref="T:System.Windows.Forms.CheckState" /> in code and not by user interaction.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets a value indicating whether the <see cref="T:System.Windows.Forms.CheckBox" /> will allow three check states rather than two.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="ToString">
|
|
<MemberSignature Language="C#" Value="public override string ToString ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<remarks>To be added.</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Returns a string that represents the current <see cref="T:System.Windows.Forms.CheckBox" /> control.</para>
|
|
</summary>
|
|
<returns>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>A string that states the control type and the state of the <see cref="P:System.Windows.Forms.CheckBox.CheckState" /> property.</para>
|
|
</returns>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
</Members>
|
|
</Type> |